public class SomQmgrChannel extends SomQmgrObject implements SomQmgrHandler
errortext, somSession
Constructor and Description |
---|
SomQmgrChannel(SomSession session)
Create a new SOM Qmgr Channel object
|
SomQmgrChannel(SomSession session,
java.lang.String[] pairs)
Create a new SOM Qmgr Channel object, populating it
|
Modifier and Type | Method and Description |
---|---|
java.lang.Integer |
addressesIn()
Get the number of inbound addresses which this channel has deal with
|
java.lang.Integer |
addressesOut()
Get the number of outbound addresses which this channel has processed
|
java.lang.String |
buildInfoString()
Generate an information string for the channel object
|
java.lang.String |
cachedUntil()
Get a UTC Time String giving the time which the channel is delayed until
|
java.lang.String |
channel()
Get the name of the channel.
|
java.lang.String |
channelDescription()
Get the channel's description string
|
java.lang.String |
chantype()
Get channel type as a string
|
int |
chanTypeInt() |
void |
clear(SomCommandListener listener)
Sends a command to clear any delay on the channel.
|
void |
clearMessages(SomCommandListener listener)
Sends a command to clear any delay on the channel's subordinate Messages.
|
void |
clearMTADelay(java.lang.String mtaName,
SomCommandListener listener)
Sends a SOM command to clear a delay associated with a particular MTA.
|
void |
clearMtas(SomCommandListener listener)
Sends a command to clear any delay on the channel's subordinate MTAs.
|
void |
connect(java.lang.String mtaname,
SomCommandListener listener)
Sends a command to connect the channel to the specified MTA
|
java.lang.String |
creationTime()
Get the time at which the channel was created
|
void |
delay(int mins,
SomCommandListener listener)
Sends a command to delay the channel by a specified number of minutes.
|
void |
deleteMessages(SomCommandListener listener)
Delete all the messages on this channel
|
java.lang.String |
direction()
Get channel direction string
|
int |
directionInt() |
void |
disable(SomCommandListener listener)
Sends a command to disable the channel.
|
void |
disableInbound(SomCommandListener listener)
Disable the channel from accepting inbound connection.
|
void |
disconnect(SomCommandListener listener)
Disconnect any peer MTAs which we are currently connected to.
|
void |
disconnect(java.lang.String mtaName,
SomCommandListener listener)
Disconnect this channel from the specified MTA.
|
void |
downwardsforce(SomCommandListener listener)
Performs a "downwards force" on the channel - i.e.
|
void |
enable(SomCommandListener listener)
Sends a command to enable the channel.
|
java.lang.String |
enabled()
Get string saying whether channel is enabled or not
|
boolean |
enabledBool()
Get boolean indicating if channel is enabled
|
java.lang.String |
enabledInbound()
Test whether the channel is enabled for inbound connections.
|
boolean |
enabledInboundBool()
Test whether the channel is enabled for inbound connections.
|
void |
enableInbound(SomCommandListener listener)
Enable the channel to accept inbound connection.
|
java.lang.Integer |
errorCount()
Get a count of the number of error which the channel has encountered
|
java.lang.Integer |
failedConversions()
Get count of failed conversions.
|
java.lang.Integer |
failedOutAssoc()
Get count of failed outbound connections
|
SomQmgrMessage[] |
getMessages()
Return an array containing the Message objects which are subordinate to
this channel.
|
SomQmgrMta |
getMTA(java.lang.String mtaName)
Returns a SomQmgrMta object representing the external MTA this channel is connected to.
|
java.lang.String |
getMTAError(java.lang.String mtaName)
Returns the MTA refusal text for an MTA associated with this channel.
|
SomQmgrMta[] |
getMtas()
Return an array containing the MTA objects which are subordinate to
this channel.
|
void |
getStatus(SomCommandListener listener)
Get the current status of this Channel.
|
void |
getSubordinateMessages(SomCommandListener listener,
java.lang.Integer sizelimit)
Interrogate the channel object for its current set of subordinate Messages
|
void |
getSubordinates(SomCommandListener listener,
java.lang.Integer mtaSizeLimit,
java.lang.Integer messageSizeLimit)
Interrogate the channel object for its current set of subordinate MTAs or Messages
|
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 the channel hierarchy value
|
java.lang.Integer |
inAssoc()
Get number of current inbound associations
|
int |
inAssocConnections(java.lang.String mtaName)
Returns number of in bound Associations to this MTA
|
java.lang.Integer |
index()
Get the channel index number
|
boolean |
isConnected(java.lang.String mtaName)
Checks local cache of channel values to see if there is an outbound Association with
the MTA given in mtaName
|
boolean |
isConnecting(java.lang.String mtaName)
Test whether this channel has a specific subordinate MTA which is currently
connecting to a peer MTA
|
boolean |
isDelayed()
Uses the cachedUntil() to tell if channel is delayed.
|
java.lang.String |
lastAttempt()
Get UTC Time String indicating time of last connection attempt made by channel
|
java.lang.String |
lastInboundTime()
Get the time of the last inbound association
|
java.lang.String |
lastOutboundTime()
Get the time of the last outbound association
|
java.lang.String |
lastSuccess()
Get UTC Time String indicating time of last successful connection attempt made by channel
|
java.lang.Integer |
loopsDetected()
Get a count of the number of loops detected.
|
java.lang.Integer |
maxProcs()
Get maximum processes value for channel
|
java.lang.Integer |
messagesIn()
Get total number of messages that have been transfered in.
|
java.lang.Integer |
messagesOut()
Get total number of messages that have been transfered out.
|
void |
minimise(int priority,
java.util.Date start,
java.util.Date stop,
SomCommandListener listener)
Invoke a MINIMISE operation on this channel
|
java.lang.Integer |
minimisePriority()
Get current MINIMISE priority for channel
|
java.lang.String |
minimiseStart()
Get current MINIMISE start time for channel
|
java.lang.String |
minimiseStop()
Get current MINIMISE stop time for channel
|
void |
nondeliverMessages(java.lang.String reason,
SomCommandListener listener)
Non-deliver all the messages on this channel
|
java.lang.Integer |
numberActiveProcesses()
Get current number of active processes on channel
|
java.lang.Integer |
numberMessages()
Get current number of messages queued on channel
|
java.lang.Integer |
numberMtas()
Get current number of peer MTAs on channel
|
java.lang.Integer |
numberProcesses()
Get the number of channel processes currently running
|
java.lang.Integer |
numberReports()
Get current number of reports queued on channel
|
java.lang.String |
oldestMessage()
Get age of oldest message queued on channel
|
java.lang.String |
oldestMessageId()
Get the queueid of the oldest message on the channel
|
int |
outAssocConnections(java.lang.String mtaName)
Returns number of out bound Associations to this MTA
|
java.lang.Integer |
outboundAssociations()
Get the current number of outbound associations
|
java.lang.String |
protocol()
Get channel protocol identifier (OID string)
|
java.lang.Integer |
receivedVolume()
Get total volume of received messages (bytes)
|
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 |
rejectText()
Get last inbound connection rejection text
|
java.lang.String |
rejectTime()
Get last inbound connection reject time
|
void |
removeFromArray(java.util.ArrayList<SomQmgrChannel> channels)
Remove this channel from the array of channels passed in.
|
void |
reprocess(SomCommandListener listener)
Perform a Reprocess operation on all Peer MTAs under this channel,
or directly on any messages queued
|
void |
setSomVersion(java.lang.Integer v)
Set the SOM version number for the channel - this controls how the FORCE command
is implemented.
|
java.lang.Integer |
storedRecipients()
Get the number of stored recipients
|
java.lang.Integer |
successfulConversions()
Get the number of successful conversions (for a shaper channel)
|
void |
timeoutMessages(SomCommandListener listener)
Time out all the messages on this channel
|
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 on channel
|
addAttribute, addAttribute, addBindListener, clearAttributes, getBooleanAttributeValue, getDoubleAttributeValue, getIntegerAttributeValue, getSession, getStringAttributeValue, notifyBindListeners, notifyListener, notifyListeners, parsePairs, print_str, print, removeBindListener, setSkipNotifications
public SomQmgrChannel(SomSession session)
session
- Session within which to create channel which cannot be nullpublic SomQmgrChannel(SomSession session, java.lang.String[] pairs)
session
- Session within which to create channel which cannot be nullpairs
- type/value pairspublic void setSomVersion(java.lang.Integer v)
v
- Som version numberpublic void removeFromArray(java.util.ArrayList<SomQmgrChannel> channels)
channels
- Array of channels which may not be nullpublic SomQmgrMta[] getMtas()
public SomQmgrMessage[] getMessages()
public 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 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, SomQmgrMessage object)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
command
- the SOM commandstatus
- operation statusobject
- a qmgr message objectpublic 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 obj, int status, SomMessage msg)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
obj
- the SOM commandstatus
- operation statusmsg
- a message objectpublic boolean isConnecting(java.lang.String mtaName) throws SomException
mtaName
- name of MTA to test which may not be nullSomException
- on errorpublic boolean isConnected(java.lang.String mtaName) throws SomException
mtaName
- the String representation of the external MTA.
Must not be null.SomException
- is thrown if there is a problem reading the outboundAssociations value.public int outAssocConnections(java.lang.String mtaName) throws SomException
mtaName
- Name of mta to check.SomException
- on errorpublic int inAssocConnections(java.lang.String mtaName) throws SomException
mtaName
- Name of MTA to checkSomException
- on errorpublic void clearMTADelay(java.lang.String mtaName, SomCommandListener listener) throws SomException
mtaName
- String representation of the external MTA,
this channel is associated with, whose delay needs to be cleared.
Must not be null.listener
- SomCommandListener who will be called to handle the SOM response.
Must not be null.SomException
- is thrown if MTA delay cannot be cleared.public void reprocess(SomCommandListener listener) throws SomException
listener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic java.lang.String getMTAError(java.lang.String mtaName) throws SomException
mtaName
- The string representation of the external MTA.
Must not be null.SomException
- is thrown if the refuse text cannot be returned.
This typically happens when there is no refuse text.public SomQmgrMta getMTA(java.lang.String mtaName) throws SomException
mtaName
- String representation of the external MTA.
Must not be null.SomException
- Thrown if we are not connected to the specified MTA.public void disconnect(java.lang.String mtaName, SomCommandListener listener) throws SomException
mtaName
- The string representation of the MTA we are disconnecting
Must not be null.listener
- The SomCommandListener called when we have a response.
Must not be null.SomException
- Thrown is we can't find an association, or disconnect.public void getStatus(SomCommandListener listener) throws SomException
listener
- Listener object which will be notified when update complete which may be nullSomException
- on errorpublic void getSubordinates(SomCommandListener listener, java.lang.Integer mtaSizeLimit, java.lang.Integer messageSizeLimit) throws SomException
listener
- Listener object which will be notified when update complete which may be nullmtaSizeLimit
- Specifies the maximum number of MTAs to be returned. May not be null.messageSizeLimit
- Specifies the maximum number of Message to be returned. May not be null.SomException
- on errorpublic void getSubordinateMessages(SomCommandListener listener, java.lang.Integer sizelimit) throws SomException
listener
- Listener object which will be notified when update complete which may be nullsizelimit
- Specifies the maximum number of Message to be returned. May not be null.SomException
- on errorpublic java.lang.String buildInfoString()
public void clear(SomCommandListener listener) throws SomException
listener
- Listener object which will be notified when operation completes which may be nullSomException
- on errorpublic void clearMtas(SomCommandListener listener) throws SomException
listener
- Listener object which will be notified when operation completes which may be nullSomException
- on errorpublic void clearMessages(SomCommandListener listener) throws SomException
listener
- Listener object which will be notified when operation completes which may be nullSomException
- on errorpublic void enable(SomCommandListener listener) throws SomException
listener
- Listener object which will be notified when operation completes which may be nullSomException
- on errorpublic void disable(SomCommandListener listener) throws SomException
listener
- Listener object which will be notified when operation completes which may be nullSomException
- on errorpublic void delay(int mins, SomCommandListener listener) throws SomException
mins
- Number of minutes by which to delay channellistener
- Listener object which will be notified when operation completes which may be nullSomException
- on errorpublic void connect(java.lang.String mtaname, SomCommandListener listener) throws SomException
mtaname
- Name of peer MTA to which to connectlistener
- Listener object which will be notified when operation completes which may be nullSomException
- on errorpublic void downwardsforce(SomCommandListener listener) throws SomException
listener
- Listener object which will be notified when operation completes which may be nullSomException
- on errorpublic void disconnect(SomCommandListener listener) throws SomException
listener
- Listener object which will be notified when operation completes which may be nullSomException
- on errorpublic void enableInbound(SomCommandListener listener) throws SomException
listener
- Listener object which will be notified when operation completes which may be nullSomException
- on errorpublic void disableInbound(SomCommandListener listener) throws SomException
listener
- Listener object which will be notified when operation completes which may be nullSomException
- on errorpublic java.lang.String channel() throws SomException
SomException
- on errorpublic java.lang.String channelDescription() throws SomException
SomException
- on errorpublic java.lang.String cachedUntil() throws SomException
SomException
- on errorpublic boolean isDelayed()
public java.lang.String chantype() throws SomException
SomException
- on errorpublic int chanTypeInt() throws SomException
SomException
public java.lang.String direction() throws SomException
SomException
- on errorpublic int directionInt() throws SomException
SomException
public java.lang.String enabled() throws SomException
SomException
- on errorpublic boolean enabledBool() 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.Integer maxProcs() throws SomException
SomException
- on errorpublic java.lang.Integer numberActiveProcesses() throws SomException
SomException
- on errorpublic java.lang.Integer numberMessages() throws SomException
SomException
- on errorpublic java.lang.Integer numberMtas() 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.Integer errorCount() throws SomException
SomException
- on errorpublic boolean enabledInboundBool() throws SomException
SomException
- on errorpublic java.lang.String enabledInbound() 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 messagesIn() throws SomException
SomException
- on errorpublic java.lang.Integer messagesOut() 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.Integer numberProcesses() 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.String rejectText() 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.Integer transmittedVolume() throws SomException
SomException
- on errorpublic java.lang.Integer minimisePriority() throws SomException
SomException
- on errorpublic java.lang.String minimiseStart() throws SomException
SomException
- on errorpublic java.lang.String minimiseStop() throws SomException
SomException
- on errorpublic void minimise(int priority, java.util.Date start, java.util.Date stop, SomCommandListener listener) throws SomException
priority
- MINIMISE prioritystart
- Start time which may be nullstop
- Stop time which may be nulllistener
- Listener object which will be notified when complete which may be nullSomException
- on errorpublic 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
- Reason string for non-delivery 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