|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.extrememessaging.ResponseMaster.MessageFields.SetByOther
public class SetByOther
This is a generic class used for message fields that is set by another field
Constructor Summary | |
---|---|
SetByOther()
|
Method Summary | |
---|---|
java.lang.Object |
GetValue()
Get the value of the field |
void |
Initialize(java.lang.String Parameter)
Initialize using the parameter from the config file. |
void |
PassMessages(CMessage parentMessage,
javax.mail.Message oMsg)
Called once for each message. |
void |
SetValue(java.lang.Object newValue)
Called if the value for this field is set externally. |
void |
Shutdown()
Cleanup any resources you allocated during construction or operation. |
void |
Verify()
This function is called once, just after the first time Initialize is called. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SetByOther()
Method Detail |
---|
public void SetValue(java.lang.Object newValue)
IMessageField
SetValue
in interface IMessageField
public java.lang.Object GetValue()
IMessageField
GetValue
in interface IMessageField
public void PassMessages(CMessage parentMessage, javax.mail.Message oMsg)
IMessageField
PassMessages
in interface IMessageField
parentMessage
- Do NOT use the parentMessage in this call.
You can store a reference to it to use later in GetValue, but do not access the
values of any other fields during this function.oMsg
- The raw Java Mail message that the parentMessage is based upon
You can freely read from this object, but do not modify it. If it throws a
messaging exception that you cannot handle, you should re-throw it to let
ResponseMaster re-cycle the connection to the mail server.public void Initialize(java.lang.String Parameter) throws ResponseMasterException
IConfigurableItem
Initialize
in interface IConfigurableItem
ResponseMasterException
public void Shutdown()
IConfigurableItem
Shutdown
in interface IConfigurableItem
public void Verify() throws InvalidMessageFieldName
IMessageField
Verify
in interface IMessageField
InvalidMessageFieldName
InvalidMessageFieldName
,
IllegalArgumentException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |