|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.commerce.messaging.outboundservice.Messaging
The object that is responsible to creating the messages and sending the messages using CCF transports based on the specified configuration for the message types.
Field Summary | |
static java.lang.String |
COPYRIGHT
|
Constructor Summary | |
Messaging(java.lang.Integer msgty,
java.lang.Integer store)
Messaging constructor. |
|
Messaging(java.lang.Integer msgty,
java.lang.Integer store,
java.lang.Integer priority)
Messaging constructor. |
Method Summary | |
void |
addContentPart(byte[] part)
This method adds a content part to the message content |
void |
addContentPart(byte[] part,
java.lang.String name,
java.lang.String type)
This method adds a content part to the message content |
void |
addMember(java.lang.Long memb)
This method sets the internal member vector with the single parameter. |
int |
addMemberGroup(java.lang.Long mbrgrp)
This method sets the internal member vector with the member group parameter. |
void |
addSecureMember(java.lang.Long memb)
This method sets the internal securemember vector with the single parameter. |
void |
addStore(java.lang.Integer astore_id)
Add a store to send the message on behalf of. |
void |
clearMember()
Removes all members from our internal recipient list. |
void |
compose(java.lang.String view,
CommandContext comContext,
TypedProperty inparms)
This method will interface with the JSP's for each transport and return the message content to the content field. |
java.lang.String |
getConfigData(java.lang.String name)
This method will return the first value found for given key. |
byte[] |
getContent(java.lang.Integer transport,
java.lang.String language)
This method is used by external users to get the content of a message from a particular transport. |
java.util.Vector |
getTransports()
Gets the transports property (java.util.Vector) value. |
java.lang.String |
getUserData(java.lang.Integer transport,
java.lang.String name)
Returns the User Data attribute of the specified transport and attribute name. |
static Messaging |
load(byte[] ser)
This public method can be used by users of the Messaging System to deserialize a serialized Messaging Object |
int |
remTransport(java.lang.Integer transport)
Removes the transport so the message will not be using the |
int |
sendImmediate()
Sends the message immediately. |
byte[] |
sendReceiveImmediate()
Sends the message immediately and waits for a response. |
long |
sendTransacted()
Saves the message to the MSGSTORE table. |
int |
setConfigData(java.lang.String name,
java.lang.String value)
This method will insert a nvp into the configuration data of ALL transports that have the name as a key in their hashtable. |
int |
setContent(java.lang.Integer transport,
java.lang.String language,
byte[] content)
This method will insert the content of a message directly for a particular transport |
void |
setPartialSend(java.lang.Boolean newPartialSend)
Set the partial send flag. |
int |
setUserData(java.lang.Integer transport,
java.lang.String name,
java.lang.String value)
Sets the User Data for the specified transport. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public Messaging(java.lang.Integer msgty, java.lang.Integer store) throws ECSystemException, java.lang.NullPointerException
Integer
- msgty - Message Type, part of the key used to access Admin informationInteger
- store - Store, part of the key used to access Admin informationpublic Messaging(java.lang.Integer msgty, java.lang.Integer store, java.lang.Integer priority) throws ECSystemException, java.lang.NullPointerException
Integer
- msgty - Message Type, part of the key used to access Admin informationInteger
- store - Store, part of the key used to access Admin informationInteger
- priority - Priority, used to filter table accessMethod Detail |
public void addContentPart(byte[] part)
The
- content part to be addedpublic void addContentPart(byte[] part, java.lang.String name, java.lang.String type)
part:
- The content part to be addedname:
- The name of the part to be added (example filename)type:
- The type of the part (for example in javamail the mime type (text/plain)public void addMember(java.lang.Long memb) throws ECSystemException
mbrgrp
- java.lang.Long The member group.public int addMemberGroup(java.lang.Long mbrgrp) throws ECSystemException
mbrgrp
- java.lang.Long The member group.public void addSecureMember(java.lang.Long memb) throws ECSystemException
mbrgrp
- java.lang.Long The member group.
Creation date: (25/09/01 4:35:47 PM)memid
- longECSystemException
- The exception description.public void addStore(java.lang.Integer astore_id) throws ECSystemException
astore_id
- java.lang.LongECSystemException
- The exception description.public void clearMember()
public void compose(java.lang.String view, CommandContext comContext, TypedProperty inparms) throws ECSystemException
view
- java.lang.StringcommandContext
- com.ibm.commerce.command.CommandContextrequestProperties
- com.ibm.commerce.datatype.TypedProperty.public java.lang.String getConfigData(java.lang.String name) throws ECSystemException
name
- java.lang.String The attribute name.public byte[] getContent(java.lang.Integer transport, java.lang.String language) throws ECSystemException
transport
- java.lang.Integer The transport.language
- java.lang.String The language.public java.util.Vector getTransports()
#setTransports
public java.lang.String getUserData(java.lang.Integer transport, java.lang.String name) throws ECSystemException
transport
- java.lang.Integer The transport.name
- java.lang.String The attribute name.public static Messaging load(byte[] ser) throws java.io.IOException, java.lang.ClassNotFoundException
serString
- - a String representingpublic int remTransport(java.lang.Integer transport)
transport
- java.lang.Integer The transport to remove.public int sendImmediate() throws ECSystemException
public byte[] sendReceiveImmediate() throws ECSystemException
public long sendTransacted() throws ECSystemException
public int setConfigData(java.lang.String name, java.lang.String value) throws ECSystemException
name
- java.lang.String The attribute name.value
- java.lang.String The attribute value.public int setContent(java.lang.Integer transport, java.lang.String language, byte[] content)
transport
- java.lang.Integer The Transport.language
- java.lang.String The language.content
- byte[] The content.public void setPartialSend(java.lang.Boolean newPartialSend)
newSendPartial
- booleanpublic int setUserData(java.lang.Integer transport, java.lang.String name, java.lang.String value) throws ECSystemException
transport
- java.lang.Integer The transport.name
- java.lang.String The attribute name.value
- java.lang.String The attribute value.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |