public class SomQmgrMta extends SomQmgrObject implements SomQmgrHandler
errortext, somSession
Constructor and Description |
---|
SomQmgrMta(SomSession session)
Create a new MTA object
|
SomQmgrMta(SomSession session,
java.lang.String[] pairs)
Create a new MTA object, populating it from the attribute pairs
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
active()
Test whether this MTA is active or not
|
boolean |
activeBool()
Test whether MTA active
|
java.lang.Integer |
activeNumber()
Get number of active associations on this MTA
|
void |
addMessage(SomQmgrMessage object)
Add a new message to the object
|
java.lang.Integer |
addressesIn()
Get total number of inbound addresses handled
|
java.lang.Integer |
addressesOut()
Get total number of outbound addresses handled
|
java.lang.String |
buildInfoString()
Generate an information string for this MTA
|
java.lang.String |
cachedUntil()
Get time until which this MTA is cached
|
java.lang.String |
channel()
Get channel name for this MTA
|
void |
clear(SomCommandListener listener)
Clear any delay on this MTA
|
void |
connect(SomCommandListener listener)
Connect to this permanent peer MTA
|
java.lang.String |
creationTime()
Get creation time of this MTA
|
void |
delay(int mins,
SomCommandListener listener)
Delay this MTA
|
void |
delete(SomCommandListener listener)
Delete this permanent peer MTA
|
void |
deleteMessages(SomCommandListener listener)
Delete all the messages on this MTA
|
java.lang.String |
description()
Get MTA description
|
void |
disable(SomCommandListener listener)
Disable this MTA
|
void |
disableInbound(SomCommandListener listener)
Disable inbound connections to this peer MTA
|
void |
disconnect(SomCommandListener listener)
Disconnect from this permanent peer MTA
|
java.lang.Boolean |
diverted()
Whether MTA has the 'divert' flag set or not
|
void |
downwardsforce(SomCommandListener listener)
Clear delays and enable this MTA and subordinate messages
|
void |
enable(SomCommandListener listener)
Enable this MTA, if disabled
|
java.lang.String |
enabled()
Get string indicating whether MTA is enabled
|
boolean |
enabledBool()
Test whether MTA enabled
|
java.lang.String |
enabledInbound()
Check whether this MTA is enabled for inbound connections
|
boolean |
enabledInboundBool()
Check whether this MTA is enabled for inbound connections
|
void |
enableInbound(SomCommandListener listener)
Enable inbound connections to this peer MTA
|
java.lang.Integer |
errorCount()
Get count of errors on this MTA
|
java.lang.Integer |
failedConversions()
Get count of failed conversions on this MTA
|
java.lang.Integer |
failedOutAssoc()
Get count of failed outbound associations on this MTA
|
SomQmgrAssociation[] |
getAssociations()
Get the associations subordinate to this MTA
|
SomQmgrInboundMessage[] |
getInboundMessages()
Get the inbound messages subordinate to this MTA
|
SomQmgrMessage[] |
getMessages()
Get the messages subordinate to this MTA
|
java.lang.String |
getMtaName()
Get the name of this MTA
|
SomQmgrSchedule[] |
getSchedules()
Get the schedules subordinate to this MTA
|
void |
getStatus(SomCommandListener listener)
Update the status of this MTA object by querying the Queue Manager
|
void |
getSubordinateMessages(SomCommandListener listener)
Get the subordinate messages of this MTA
|
void |
getSubordinateMessages(SomCommandListener listener,
java.lang.Integer sizelimit)
Get the subordinate messages of this MTA
|
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.Integer |
hierarchy()
Get this MTA's hierarchy value
|
java.lang.Integer |
inAssoc()
Get current number of inbound associations on this MTA
|
java.lang.Integer |
index()
Get this MTA's index value
|
java.lang.String |
info()
Get information string for Peer MTA
|
java.lang.String |
lastAttempt()
Get time of last attempted connection
|
java.lang.String |
lastInboundTime()
Get time of last inbound association on this MTA
|
java.lang.String |
lastOutboundTime()
Get time of last outbound association on this MTA
|
java.lang.String |
lastSuccess()
Get time of last successful connection
|
java.lang.Integer |
loopsDetected()
Get count of loops detected on this MTA
|
java.lang.Integer |
maxInboundConnections()
Get maximum permitted number of inbound connections
|
java.lang.Integer |
maxOutboundConnections()
Get maximum permitted number of outbound connections
|
java.lang.Integer |
messagesIn()
Get total number of inbound messages received
|
java.lang.Integer |
messagesOut()
Get total number of outbound messages sent
|
java.lang.String |
mta()
Get MTA name
|
java.lang.String |
mtaConnecting()
Test whether MTA is currently connecting
|
boolean |
mtaConnectingBool()
Test whether MTA is currently connecting
|
void |
nondeliverMessages(java.lang.String reason,
SomCommandListener listener)
Nondeliver all the messages on this MTA
|
java.lang.Integer |
numberMessages()
Get number of messages queued
|
java.lang.Integer |
numberReports()
Get number of reports queued
|
java.lang.String |
oldestMessage()
Get age of oldest message
|
java.lang.String |
oldestMessageId()
Get Queue Id of oldest message
|
java.lang.Integer |
outboundAssociations()
Get number of current outbound associations
|
void |
parsePairs(java.lang.String[] pairs)
Parse the Attribute pairs passed in
|
java.lang.String |
protocol()
Get protocol id for MTA
|
java.lang.Integer |
receivedVolume()
Get total volume of received messages
|
void |
refreshSubordinates(SomCommandListener listener)
Refresh the list of subordinate messages of this MTA
|
void |
refreshSubordinates(SomCommandListener listener,
java.lang.Integer sizelimit)
Refresh the list of subordinate messages of this MTA, with size limit
|
java.lang.String |
refuseStatus()
Get last outbound connection refusal status as x.y.z string
|
java.lang.String |
refuseText()
Get last outbound connection refusal reason text
|
java.lang.String |
refuseTime()
Get last outbound connection refusal time
|
java.lang.Integer |
rejectedAssoc()
Get number of rejected inbound connections
|
java.lang.Integer |
rejectedMessage()
Get number of rejected inbound messages
|
java.lang.Integer |
rejectStatus()
Get last inbound connection rejection status as x.y.z string
|
java.lang.String |
rejectTime()
Get last inbound connection reject time
|
void |
removeFromArray(java.util.ArrayList<SomQmgrMta> mtas)
Remove this MTA from the array passed in
|
void |
reprocess(SomCommandListener listener)
Reprocess all messages on this MTA
|
java.lang.String |
rerouted() |
void |
setSomVersion(java.lang.Integer v)
Set the SOM version associated with this MTA
|
java.lang.Integer |
storedRecipients()
Get the number of stored recipients
|
java.lang.Integer |
successfulConversions()
Get the number of successful conversions (for a shaper channel MTA)
|
void |
timeoutMessages(SomCommandListener listener)
Time out all the messages on this MTA
|
java.lang.Integer |
totalInAssoc()
Get total number of inbound associations
|
java.lang.Integer |
totalOutAssoc()
Get total number of outbound associations
|
java.lang.Integer |
transmittedVolume()
Get total volume of transmitted messages
|
java.lang.Integer |
volumeMessages()
Get volume of messages queued
|
addAttribute, addAttribute, addBindListener, clearAttributes, getBooleanAttributeValue, getDoubleAttributeValue, getIntegerAttributeValue, getSession, getStringAttributeValue, notifyBindListeners, notifyListener, notifyListeners, print_str, print, removeBindListener, setSkipNotifications
public SomQmgrMta(SomSession session)
session
- Session which the message is associated with, which cannot be nullpublic SomQmgrMta(SomSession session, java.lang.String[] pairs)
session
- Session which the message is associated with, which cannot be nullpairs
- Attribute pairs to use which cannot be nullpublic void setSomVersion(java.lang.Integer v)
v
- the version of SOM protocol used to access this MTApublic java.lang.String getMtaName()
public void parsePairs(java.lang.String[] pairs)
parsePairs
in class SomQmgrObject
pairs
- Array of attribute type:value strings which may not be nullpublic void addMessage(SomQmgrMessage object)
object
- Message to add which cannot be nullpublic SomQmgrMessage[] getMessages()
public void removeFromArray(java.util.ArrayList<SomQmgrMta> mtas)
mtas
- Array of MTAs from which this one should be remove, which cannot be nullpublic SomQmgrInboundMessage[] getInboundMessages()
public SomQmgrAssociation[] getAssociations()
public SomQmgrSchedule[] getSchedules()
public 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, java.lang.String[] pairs)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
command
- the SOM commandstatus
- operation statuspairs
- data pairspublic 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 command, int status, SomQmgrChannel object)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
command
- the SOM commandstatus
- operation statusobject
- a channel objectpublic void handleResponse(SomCommand obj, int status, SomMessage msg)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
obj
- the SOM commandstatus
- operation statusmsg
- a 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, SomQmgrQueueManager object)
public void handleResponse(SomCommand command, int status, SomQmgrMessage object)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
command
- the SOM commandstatus
- operation statusobject
- a qmgr message objectpublic void getStatus(SomCommandListener listener) throws SomException
listener
- Listener to notify when update complete, which may be nullSomException
- on errorpublic void refreshSubordinates(SomCommandListener listener) throws SomException
listener
- Listener to notify when update complete, which may be nullSomException
- on errorpublic void refreshSubordinates(SomCommandListener listener, java.lang.Integer sizelimit) throws SomException
listener
- Listener to notify when update complete, which may be nullsizelimit
- Limit on number of entries to return, which may not be nullSomException
- on errorpublic java.lang.String buildInfoString()
public void getSubordinateMessages(SomCommandListener listener) throws SomException
listener
- Listener to notify when update complete, which may be nullSomException
- on errorpublic void getSubordinateMessages(SomCommandListener listener, java.lang.Integer sizelimit) throws SomException
listener
- Listener to notify when update complete, which may be nullsizelimit
- Limit on number of messages, which may not be nullSomException
- on errorpublic void clear(SomCommandListener listener) throws SomException
listener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic void enable(SomCommandListener listener) throws SomException
listener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic void disable(SomCommandListener listener) throws SomException
listener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic void delay(int mins, SomCommandListener listener) throws SomException
mins
- Number of minutes to delay bylistener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic void downwardsforce(SomCommandListener listener) throws SomException
listener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic void reprocess(SomCommandListener listener) throws SomException
listener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic void delete(SomCommandListener listener) throws SomException
listener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic void connect(SomCommandListener listener) throws SomException
listener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic void disconnect(SomCommandListener listener) throws SomException
listener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic void enableInbound(SomCommandListener listener) throws SomException
listener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic void disableInbound(SomCommandListener listener) throws SomException
listener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic java.lang.String active() throws SomException
SomException
- on errorpublic java.lang.Integer activeNumber() throws SomException
SomException
- on errorpublic java.lang.String cachedUntil() throws SomException
SomException
- on errorpublic java.lang.String channel() throws SomException
SomException
- on errorpublic java.lang.String enabled() throws SomException
SomException
- on errorpublic boolean activeBool() throws SomException
SomException
- on errorpublic boolean enabledBool() throws SomException
SomException
- on errorpublic java.lang.String info() throws SomException
SomException
- on errorpublic java.lang.String lastAttempt() throws SomException
SomException
- on errorpublic java.lang.String lastSuccess() throws SomException
SomException
- on errorpublic java.lang.String mta() throws SomException
SomException
- on errorpublic java.lang.Integer numberMessages() throws SomException
SomException
- on errorpublic java.lang.Integer numberReports() throws SomException
SomException
- on errorpublic java.lang.String oldestMessage() throws SomException
SomException
- on errorpublic java.lang.Integer volumeMessages() throws SomException
SomException
- on errorpublic java.lang.Integer addressesIn() throws SomException
SomException
- on errorpublic java.lang.Integer addressesOut() throws SomException
SomException
- on errorpublic java.lang.String creationTime() throws SomException
SomException
- on errorpublic java.lang.String description() throws SomException
SomException
- on errorpublic boolean enabledInboundBool() throws SomException
SomException
- on errorpublic java.lang.String enabledInbound() throws SomException
SomException
- on errorpublic java.lang.Integer errorCount() throws SomException
SomException
- on errorpublic java.lang.Integer failedConversions() throws SomException
SomException
- on errorpublic java.lang.Integer failedOutAssoc() throws SomException
SomException
- on errorpublic java.lang.Integer hierarchy() throws SomException
SomException
- on errorpublic java.lang.Integer inAssoc() throws SomException
SomException
- on errorpublic java.lang.Integer index() throws SomException
SomException
- on errorpublic java.lang.String lastInboundTime() throws SomException
SomException
- on errorpublic java.lang.String lastOutboundTime() throws SomException
SomException
- on errorpublic java.lang.Integer loopsDetected() throws SomException
SomException
- on errorpublic java.lang.Integer maxInboundConnections() throws SomException
SomException
- on errorpublic java.lang.Integer maxOutboundConnections() throws SomException
SomException
- on errorpublic java.lang.Integer messagesIn() throws SomException
SomException
- on errorpublic java.lang.Integer messagesOut() throws SomException
SomException
- on errorpublic boolean mtaConnectingBool() throws SomException
SomException
- on errorpublic java.lang.String mtaConnecting() throws SomException
SomException
- on errorpublic java.lang.String oldestMessageId() throws SomException
SomException
- on errorpublic java.lang.Integer outboundAssociations() throws SomException
SomException
- on errorpublic java.lang.String protocol() throws SomException
SomException
- on errorpublic java.lang.Integer receivedVolume() throws SomException
SomException
- on errorpublic java.lang.String refuseStatus() throws SomException
SomException
- on errorpublic java.lang.String refuseText() throws SomException
SomException
- on errorpublic java.lang.String refuseTime() throws SomException
SomException
- on errorpublic java.lang.String rejectTime() throws SomException
SomException
- on errorpublic java.lang.Integer rejectedAssoc() throws SomException
SomException
- on errorpublic java.lang.Integer rejectedMessage() throws SomException
SomException
- on errorpublic java.lang.Integer rejectStatus() throws SomException
SomException
- on errorpublic java.lang.Integer storedRecipients() throws SomException
SomException
- on errorpublic java.lang.Integer successfulConversions() throws SomException
SomException
- on errorpublic java.lang.Integer totalInAssoc() throws SomException
SomException
- on errorpublic java.lang.Integer totalOutAssoc() throws SomException
SomException
- on errorpublic java.lang.Boolean diverted() throws SomException
SomException
- on errorpublic java.lang.Integer transmittedVolume() throws SomException
SomException
- on errorpublic java.lang.String rerouted() throws SomException
SomException
public void deleteMessages(SomCommandListener listener) throws SomException
listener
- Listener object which will be notified when complete which may be nullSomException
- on errorpublic void nondeliverMessages(java.lang.String reason, SomCommandListener listener) throws SomException
reason
- String reason text which may not be nulllistener
- Listener object which will be notified when complete which may be nullSomException
- on errorpublic void timeoutMessages(SomCommandListener listener) throws SomException
listener
- Listener object which will be notified when complete which may be nullSomException
- on errorVersion: 18.0v6-0
Copyright (c) 2017-2020 Isode