public class SomQmgrMessage extends SomQmgrObject implements SomQmgrHandler
errortext, somSession
Constructor and Description |
---|
SomQmgrMessage(SomSession session,
java.lang.String cName,
java.lang.String mName)
Create a new Message object
|
SomQmgrMessage(SomSession session,
java.lang.String c,
java.lang.String m,
java.lang.String[] pairs)
Crate a new Message object and initialize it from the attribute pairs
|
Modifier and Type | Method and Description |
---|---|
void |
abort(SomCommandListener listener)
Cause transfer of the message to be aborted
|
java.lang.String |
age()
Get the age of this message as a UTC Time String
|
java.lang.String |
buildInfoString()
Generate an information string for this message
|
void |
clear(SomCommandListener listener)
Clear delays on this message.
|
java.lang.String |
contenttype()
Get the content type of this message
|
java.lang.String |
contentTypeDescription()
Get content type of this message as more user-friendly form
|
static java.lang.String |
contentTypeDescription(java.lang.String contentType)
Get a content type as a more user-friendly form
|
boolean |
contentTypeMilitary()
Test whether the content-type of this message is "military"
|
static boolean |
contentTypeMilitary(java.lang.String contentType)
Test whether a given content-type value is "military"
|
java.lang.String |
deferredTime()
Get deferred delivery time for this message, if any
|
void |
delay(int mins,
SomCommandListener listener)
Delay this message for some minutes.
|
void |
delete(SomCommandListener listener)
Cause the message to be deleted
|
void |
disable(SomCommandListener listener)
Disable processing of this message.
|
void |
downwardsforce(SomCommandListener listener)
Clear any delay and enable this message
|
java.lang.String |
eits()
Get encoded information types for this message
|
void |
enable(SomCommandListener listener)
Enable processing of this message.
|
java.lang.Integer |
errorCount()
Get count of errors which have occurred for this message
|
java.lang.String |
expiryTime()
Get time at which this message will expire
|
void |
force(SomCommandListener listener,
java.lang.Double forceValue)
Force processing of this message.
|
java.lang.String |
getChannelName()
Get name of channel on which this message is queued
|
SomQmgrRecipient[] |
getRecipients()
Get the recipient objects which are subordinate to this message
|
int |
getRecipientsCount()
Get a count of the recipients of this message
|
void |
handleBindResponse(int status,
java.lang.String detail)
Handle the response to a Bind operation
|
void |
handleResponse(SomCommand obj,
int status,
SomMessage msg)
Handles the response to commands which return a SomMessage object
(i.e.
|
void |
handleResponse(SomCommand command,
int status,
SomQmgrChannel object)
Handles the response to commands which return a list of channel objects
|
void |
handleResponse(SomCommand command,
int status,
SomQmgrMessage object)
Handles the response to commands which return a list of message objects
|
void |
handleResponse(SomCommand command,
int status,
SomQmgrMta object)
Handles the response to commands which return a list of MTA objects
|
void |
handleResponse(SomCommand command,
int status,
SomQmgrQueueManager object) |
void |
handleResponse(SomCommand command,
int status,
java.lang.String detail)
Handles the response to control commands which return an OK/error
response plus an info string
|
void |
handleResponse(SomCommand command,
int status,
java.lang.String[] pairs)
Handles the response to commands which return data about the current object -
i.e.
|
java.lang.String |
inChannel()
Get inbound channel for this message
|
java.lang.String |
inetId()
Get Internet message id
|
java.lang.String |
inMta()
Get inbound MTA name for this message
|
java.lang.String |
latestDelivery()
Get latest delivery time
|
java.lang.String |
messageType()
Get the type of the message object in friendly form
|
java.lang.String |
mlistId()
Return the mlist ID for this message.
|
java.lang.String |
mpduiden()
Get MPDU Identifier for this message
|
java.lang.String |
mta()
Get MTA name for this message object
|
void |
nondeliver(java.lang.String reason,
SomCommandListener listener)
Cause the message to be non delivered
|
java.lang.Integer |
numberWarningsSent()
Get the number of warnings which have been sent about this messahe
|
java.lang.String |
originator()
Get originator address for this message
|
void |
parsePairs(java.lang.String[] pairs) |
void |
pause(SomCommandListener listener)
Cause transfer of the message to be paused
|
java.lang.Integer |
priority()
Get priority of this message
|
java.lang.String |
queueid()
Get Queue Identifier of this message (e.g.
|
java.lang.Double |
queuePriority()
Get queue priority for message
|
void |
redirect(java.lang.String target,
SomCommandListener listener)
Cause the message to be redirected to a different recipient
|
void |
refresh(SomCommandListener listener)
Refresh this Message object by querying the Queue Manager
|
void |
reload(SomCommandListener listener)
Cause the message to be reloaded
|
void |
removeFromArray(java.util.ArrayList<SomQmgrMessage> msgs)
Remove this message from the array passed in
|
void |
reprocess(SomCommandListener listener)
Cause the message to be reprocessed by the Queue Manager
|
void |
resume(SomCommandListener listener)
Cause transfer of the message to be resumed
|
java.lang.Integer |
size()
Get size of message in bytes
|
void |
timeout(SomCommandListener listener)
Time this message out and cause it to be non-delivered
|
java.lang.String |
uaContentId()
Get UA Content Identifier for the message
|
java.lang.String |
uniqueId()
Return the message's unique identifier
|
java.lang.String |
uniqueIdWithRecipNo()
Return a string containing the message's unique identifier and the first recipient number
|
java.lang.Integer |
warnInterval()
Get warning interval for message
|
addAttribute, addAttribute, addBindListener, clearAttributes, getBooleanAttributeValue, getDoubleAttributeValue, getIntegerAttributeValue, getSession, getStringAttributeValue, notifyBindListeners, notifyListener, notifyListeners, print_str, print, removeBindListener, setSkipNotifications
public SomQmgrMessage(SomSession session, java.lang.String cName, java.lang.String mName)
session
- SOM session with which it is associated which must not be nullcName
- channel name which must not be nullmName
- mta name which may be nullpublic SomQmgrMessage(SomSession session, java.lang.String c, java.lang.String m, java.lang.String[] pairs)
session
- SOM session with which it is associated which must not be nullc
- channel name which must not be nullm
- mta name which may be nullpairs
- attribute pairs which may no be nullpublic void parsePairs(java.lang.String[] pairs)
parsePairs
in class SomQmgrObject
public void removeFromArray(java.util.ArrayList<SomQmgrMessage> msgs)
msgs
- Array of messages from which this one should be removed, which must not be nullpublic int getRecipientsCount()
public SomQmgrRecipient[] getRecipients()
public java.lang.String mta() throws SomException
SomException
- on errorpublic java.lang.String getChannelName() throws SomException
SomException
- on errorpublic java.lang.String age() throws SomException
SomException
- on errorpublic java.lang.String contenttype() throws SomException
SomException
- on errorpublic static java.lang.String contentTypeDescription(java.lang.String contentType)
contentType
- content type in standard form which cannot be nullpublic java.lang.String contentTypeDescription() throws SomException
SomException
- on errorpublic static boolean contentTypeMilitary(java.lang.String contentType)
contentType
- content type to test which cannot be nullpublic boolean contentTypeMilitary() throws SomException
SomException
- on errorpublic java.lang.String deferredTime() throws SomException
SomException
- on errorpublic java.lang.String eits() throws SomException
SomException
- on errorpublic java.lang.Integer errorCount() throws SomException
SomException
- on errorpublic java.lang.String expiryTime() throws SomException
SomException
- on errorpublic java.lang.String inChannel() throws SomException
SomException
- on errorpublic java.lang.String inMta() throws SomException
SomException
- on errorpublic java.lang.String mpduiden() throws SomException
SomException
- on errorpublic java.lang.Integer numberWarningsSent() throws SomException
SomException
- on errorpublic java.lang.String originator() throws SomException
SomException
- on errorpublic java.lang.Integer priority() throws SomException
SomException
- on errorpublic java.lang.String queueid() throws SomException
SomException
- on errorpublic java.lang.Integer size() throws SomException
SomException
- on errorpublic java.lang.String uaContentId() throws SomException
SomException
- on errorpublic java.lang.Integer warnInterval() throws SomException
SomException
- on errorpublic java.lang.Double queuePriority() throws SomException
SomException
- on errorpublic java.lang.String inetId() throws SomException
SomException
- on errorpublic java.lang.String latestDelivery() throws SomException
SomException
- on errorpublic java.lang.String messageType() throws SomException
SomException
- on errorpublic java.lang.String uniqueIdWithRecipNo() throws SomException
SomException
- on errorpublic java.lang.String uniqueId() throws SomException
SomException
- on errorpublic java.lang.String mlistId() throws SomException
SomException
- on errorpublic void handleResponse(SomCommand command, int status, java.lang.String detail)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
handleResponse
in interface SomHandler
command
- the SOM commandstatus
- operation statusdetail
- detail on errorpublic void handleResponse(SomCommand command, int status, SomQmgrQueueManager object)
public void handleResponse(SomCommand command, int status, SomQmgrChannel object)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
command
- the SOM commandstatus
- operation statusobject
- a channel objectpublic void handleResponse(SomCommand command, int status, SomQmgrMta object)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
command
- the SOM commandstatus
- operation statusobject
- a SOM Qmgr MTA objectpublic void handleResponse(SomCommand obj, int status, SomMessage msg)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
obj
- the SOM commandstatus
- operation statusmsg
- a message objectpublic void handleResponse(SomCommand command, int status, SomQmgrMessage object)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
command
- the SOM commandstatus
- operation statusobject
- a qmgr message objectpublic void handleBindResponse(int status, java.lang.String detail)
SomHandler
handleBindResponse
in interface SomHandler
status
- operation statusdetail
- error detail on failurepublic void handleResponse(SomCommand command, int status, java.lang.String[] pairs)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
command
- the SOM commandstatus
- operation statuspairs
- data pairspublic void refresh(SomCommandListener listener) throws SomException
listener
- Listener object to be notified when refresh completes, which may be nullSomException
- on errorpublic java.lang.String buildInfoString()
public void clear(SomCommandListener listener) throws SomException
listener
- Listener object to be notified when operation completes, which may be nullSomException
- on errorpublic void enable(SomCommandListener listener) throws SomException
listener
- Listener object to be notified when operation completes, which may be nullSomException
- on errorpublic void disable(SomCommandListener listener) throws SomException
listener
- Listener object to be notified when operation completes, which may be nullSomException
- on errorpublic void delay(int mins, SomCommandListener listener) throws SomException
mins
- number of minutes to delay the message forlistener
- Listener object to be notified when operation completes, which may be nullSomException
- on errorpublic void downwardsforce(SomCommandListener listener) throws SomException
listener
- Listener object to be notified when operation completes, which may be nullSomException
- on errorpublic void force(SomCommandListener listener, java.lang.Double forceValue) throws SomException
listener
- Listener object to be notified when operation completes, which may be nullforceValue
- the priority to force atSomException
- on errorpublic void timeout(SomCommandListener listener) throws SomException
listener
- Listener object to be notified when operation completes, which may be nullSomException
- on errorpublic void reprocess(SomCommandListener listener) throws SomException
listener
- Listener object to be notified when operation completes, which may be nullSomException
- on errorpublic void delete(SomCommandListener listener) throws SomException
listener
- Listener object to be notified when operation complete, which may be nullSomException
- on errorpublic void redirect(java.lang.String target, SomCommandListener listener) throws SomException
target
- Recipient address in string encoding, which may not be nulllistener
- Listener object to be notified when operation complete, which may be nullSomException
- on errorpublic void nondeliver(java.lang.String reason, SomCommandListener listener) throws SomException
reason
- Non-delivery reason which may be nulllistener
- Listener object to be notified when operation complete, which may be nullSomException
- on errorpublic void reload(SomCommandListener listener) throws SomException
listener
- Listener object to be notified when operation complete, which may be nullSomException
- on errorpublic void abort(SomCommandListener listener) throws SomException
listener
- Listener object to be notified when operation complete, which may be nullSomException
- on errorpublic void pause(SomCommandListener listener) throws SomException
listener
- Listener object to be notified when operation complete, which may be nullSomException
- on errorpublic void resume(SomCommandListener listener) throws SomException
listener
- Listener object to be notified when operation complete, which may be nullSomException
- on errorVersion: 18.0v6-0
Copyright (c) 2017-2020 Isode