public class SomQmgrQueueManager extends SomQmgrObject implements SomQmgrHandler
Modifier and Type | Field and Description |
---|---|
static int |
QMGR_STATUS_CONGESTED |
static int |
QMGR_STATUS_DOWN |
static int |
QMGR_STATUS_HALTED |
static int |
QMGR_STATUS_QUIESCING |
static int |
QMGR_STATUS_RESTARTING |
static int |
QMGR_STATUS_UP |
static int |
SOM_QMGR_CONNECTED_ANON |
static int |
SOM_QMGR_CONNECTED_AUTH |
static int |
SOM_QMGR_CONNECTING |
static int |
SOM_QMGR_DISCONNECTED |
java.lang.Integer |
som_version |
errortext, somSession
Constructor and Description |
---|
SomQmgrQueueManager()
Create a new Queue Manager object with default settings
|
Modifier and Type | Method and Description |
---|---|
java.lang.Integer |
addrIn()
Get the number of inbound addresses which have been received
|
java.lang.Integer |
addrOut()
Get the number of outbound addresses processed
|
java.lang.Integer |
archiveFreePercent()
Get percentage free space on archive filesystem
|
void |
auditString(java.lang.String type,
java.lang.String key,
java.lang.String value,
SomCommandListener listener) |
java.lang.String |
boottime()
Get the time at which the Queue Manager was started
|
java.lang.Integer |
chanRate()
Get average number of channels blocked
|
void |
connect()
Connect to the Queue Manager, using the connection information already configured
|
void |
connectACP127CM()
Connect to the ACP127 channel
|
void |
connectACPOTAM()
Connect to the OTAM server
|
java.lang.Integer |
currChans()
Get the current number of running channels
|
void |
decrementMaxChannels(SomCommandListener listener)
Decrement the allowable maximum number of channels (by one)
|
java.lang.String |
dirname()
Get Queue Manager DN (if directory-based configuration is in use)
|
void |
disableAllChannels(SomCommandListener listener)
Disable all the channels of this Queue Manager
|
void |
disableSubmission(SomCommandListener listener)
Disable submission into the Queue Manager
|
void |
disconnect()
Disconnect from this Queue Manager (or ACP127 channel or OTAM server),
assuming that we are already connected
|
void |
enableAllChannels(SomCommandListener listener)
Enable all the channels of this Queue Manager
|
void |
enableSubmission(SomCommandListener listener)
Enable submission into the Queue Manager
|
java.lang.Integer |
failedConvert()
Get number of failed conversion operations
|
java.lang.Integer |
failedInAssoc()
Get number of failed inbound connections
|
java.lang.Integer |
getACP127CMPort()
Get the TCP port on which is used for communication with ACP127 channels
|
java.lang.Integer |
getACP127RepairPort()
Get the ACP127 repair port
|
java.lang.String |
getAcp127TestTapeTemplateDir()
Get the ACP127 Test Tape template directory
|
java.lang.Integer |
getACPOTAMPort()
Get the TCP port on which is used for communication with OTAM servers
|
SomQmgrChannel |
getChannel(com.isode.dsapi.DN channelDN)
Returns a SomQmgrChannel object of a specific channel, based on the channel DN.
|
SomQmgrChannel[] |
getChannels()
Obtain the set of channels on this M-Switch instance
|
com.isode.dsapi.DN |
getConfigDN() |
java.util.Date |
getCurrentTime() |
java.lang.Integer |
getCurrentTimeOffset() |
java.lang.String |
getErrorText()
Get last error text
|
java.lang.String |
getFriendlyName()
Get the configured Friendly Name for this Queue Manager
|
SomQmgrMessage[] |
getHeldMessages()
Get a set of messages which are in the "held" state
|
java.lang.String |
getHoldInfoString()
Get a string containing information about the number of "held" messages
|
java.util.Vector<java.lang.String> |
getHostAliases()
Get the aliases we have registed for this Queue Manager's hostname
|
java.lang.String |
getHostName()
Get the hostname for this Queue Manager
|
java.lang.String |
getInfoString()
Get an information string about the Queue Manager
|
java.lang.Boolean |
getNoServices()
Get indication of whether we want to manage services for this Queue Manager
|
java.lang.String |
getPassword()
Get the password which we will use when connecting to this Queue Manager
|
java.lang.Integer |
getPort()
Get the TCP port on which is used for communication with this Queue Manager
|
java.lang.String |
getSaslMechanism()
Get the name of the SASL mechanism
|
int |
getState()
Get current connection state of Queue Manager
|
void |
getStatus(SomCommandListener listener)
Refresh the status of the Queue Manager object
|
void |
getSubordinateChannels(SomCommandListener listener)
Obtains the subordinate channels of this Queue Manager
|
void |
getSubordinates(SomCommandListener listener)
Obtains the subordinate objects of this Queue Manager
|
boolean |
getUseACP127CMPort()
Find out if this Queue Manager object is using the ACP127 channel port
|
boolean |
getUseACP127OTAMPort()
Find out if this Queue Manager object is using the OTAM port
|
boolean |
getUseACP127RepairPort()
Find out if this Queue Manager object is using the ACP127 repair port
|
java.lang.String |
getUsername()
Get the username which we will use when connecting to this Queue Manager
|
boolean |
getUseTls()
Get the value of the flag which indicates whether TLS should be used
|
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,
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 |
heldMsgs()
Get the current number of messages in the Queue
|
java.lang.String |
hostname()
Get hostname of system on which the Queue Manager is running
|
java.lang.Integer |
inAssoc()
Get number of inbound associations
|
void |
incrementMaxChannels(SomCommandListener listener)
Increment the allowable maximum number of channels (by one)
|
boolean |
isConnectionExpected()
Test whether we are expecting to connect to this Queue Manager
|
boolean |
isRemoteMTA() |
java.lang.String |
lastInboundTime()
Get time of last inbound connection
|
java.lang.String |
lastOperation() |
java.lang.String |
lastOperationTime() |
java.lang.String |
lastOutboundTime()
Get time of last outbound connection
|
java.lang.Integer |
loggingFreePercent()
Get percentage free space on logging filesystem
|
java.lang.Integer |
loopsDetected()
Get number of loops detected
|
java.lang.Integer |
maxChans()
Get maximum number of channels
|
java.lang.Integer |
messagesIn()
Get number of inbound messages which have been processed.
|
java.lang.Integer |
messagesOut()
Get number of outbound messages which have been processed.
|
void |
minimise(int priority,
java.util.Date start,
java.util.Date stop,
SomCommandListener listener)
Start a MINIMISE operation
|
java.lang.Integer |
msgsInPerSec()
Get average number of inbound messages per second
|
java.lang.Integer |
msgsOutPerSec()
Get average number of outbound messages per second
|
java.lang.Integer |
oprateMax()
Get maximum operation rate
|
java.lang.Integer |
oprateReserve()
Get reserve operation rate
|
java.lang.Integer |
opsPerSecond()
Get average number of operations per second
|
java.lang.String |
osType()
Get operating system type string for Queue Manager system
|
java.lang.Integer |
outAssoc()
Get total number of outbound associations which have been made.
|
void |
performCkadr(SomCommandListener listener,
SomQmgrHandler handler,
SomQmgrCKADROptions options)
Asks the Queue Manager to check an address
|
java.lang.Integer |
queueFreePercent()
Get percentage free space on queue filesystem
|
java.lang.Integer |
receivedVolume()
Get total received volume of messages
|
java.lang.Integer |
rejectedAssoc()
Get total number of rejected associations
|
void |
reloadConfiguration(SomCommandListener listener)
Tell the Queue Manager to reload its configuration from the DSA.
|
java.lang.String |
reporttime()
Returns the time (local to the Queue Manager) at which the status check was performed.
|
void |
reprocess(SomCommandListener listener)
Perform a Reprocess operation on all Channels.
|
void |
rereadQueue(SomCommandListener listener)
Tell the Queue Manager to re-read its message queue
|
void |
restart(SomCommandListener listener)
Tell the Queue Manager to restart.
|
java.lang.Integer |
runnableChans()
Get the number of runnable channels on this Queue Manager
|
void |
searchForHeldMessages(SomCommandListener listener)
Asks the Queue Manager to get a list of messages in state "held"
|
void |
setACP127CMPort(java.lang.Integer p)
Set the TCP port on which is used for communication with ACP127 channels
|
void |
setAcp127TestTapeTemplateDir(java.lang.String acp127TestTapeTemplateDir)
Set the ACP127 Test Tape template directory
|
void |
setACPOTAMPort(java.lang.Integer p)
Set the TCP port on which is used for communication with OTAM servers
|
void |
setConfigDN(com.isode.dsapi.DN configDN) |
static void |
setConnectionTimeout(int value)
Set the connection timeout used for all SOM sessions
created via this object
|
void |
setFriendlyName(java.lang.String fname)
Set the Friendly Name for this Queue Manager
|
void |
setHostAliases(java.util.List<java.lang.String> hostAliases)
Set the aliases for this host
|
void |
setHostName(java.lang.String n)
Set the hostname for this Queue Manager
|
void |
setNoServices(java.lang.Boolean val)
Configure this Queue Manager as one for which we will not attempt to manage services
|
void |
setPassword(java.lang.String pwd)
Set the password which we will use when connecting to this Queue Manager
|
void |
setPort(java.lang.Integer p)
Set the TCP port on which is used for communication with this Queue Manager
|
void |
setRemoteMTA(boolean val) |
void |
setSaslMechanism(java.lang.String mech)
Configure the name of the SASL mechanism which we want to use for authentication
|
void |
setUseACP127CMPort(boolean value)
Configure this Queue Manager object to use the ACP127 channel port
|
void |
setUseACP127OTAMPort(boolean value)
Configure this Queue Manager object to use the OTAM port
|
void |
setUsername(java.lang.String n)
Set the username which we will use when connecting to this Queue Manager
|
void |
setUseTls(boolean use)
Set the flag which indicates whether TLS should be used for this connection
|
void |
shutdown(SomCommandListener listener)
Tell the Queue Manager to shut down
|
java.lang.Integer |
somVersion()
Get SOM version for the Queue Manager
|
java.lang.Integer |
status()
Get Queue Manager status code
|
java.lang.String |
statusString()
Get Queue Manager status as string
|
java.lang.Integer |
storedRecipients()
Get number of recipient addresses in queue
|
java.lang.Integer |
totalDrs()
Get the total number of DRs in the Queue
|
java.lang.Integer |
totalInAssoc()
Get the current number of inbound associations to the Queue Manager
|
java.lang.Integer |
totalMsgs()
Get the current number of messages in the Queue
|
java.lang.Integer |
totalOutAssoc()
Get the current number of outbound associations from the Queue Manager
|
java.lang.Integer |
totalVolume()
Get the current volume of messages in the queue
|
java.lang.Integer |
transmittedVolume()
Get total volume of transmitted messages
|
java.lang.String |
version()
Get Queue Manager version string
|
addAttribute, addAttribute, addBindListener, clearAttributes, getBooleanAttributeValue, getDoubleAttributeValue, getIntegerAttributeValue, getSession, getStringAttributeValue, notifyBindListeners, notifyListener, notifyListeners, parsePairs, print_str, print, removeBindListener, setSkipNotifications
public java.lang.Integer som_version
public static final int SOM_QMGR_DISCONNECTED
public static final int SOM_QMGR_CONNECTING
public static final int SOM_QMGR_CONNECTED_ANON
public static final int SOM_QMGR_CONNECTED_AUTH
public static final int QMGR_STATUS_UP
public static final int QMGR_STATUS_DOWN
public static final int QMGR_STATUS_HALTED
public static final int QMGR_STATUS_CONGESTED
public static final int QMGR_STATUS_RESTARTING
public static final int QMGR_STATUS_QUIESCING
public SomQmgrQueueManager()
public SomQmgrChannel[] getChannels()
public SomQmgrMessage[] getHeldMessages()
public SomQmgrChannel getChannel(com.isode.dsapi.DN channelDN) throws SomException
channelDN
- DN representation of a specific channel.SomException
- if there is no string representation for an existing channel's name.public boolean isConnectionExpected()
public int getState()
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, 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 command, int status, SomQmgrMessage object)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
command
- the SOM commandstatus
- operation statusobject
- a qmgr message objectpublic void handleResponse(SomCommand obj, int status, SomMessage msg)
SomQmgrHandler
handleResponse
in interface SomQmgrHandler
obj
- the SOM commandstatus
- operation statusmsg
- a message objectpublic java.lang.String getInfoString()
public java.lang.String getHoldInfoString()
public void getStatus(SomCommandListener listener) throws SomException
listener
- Object to notify when update complete, which may be nullSomException
- on errorpublic void getSubordinates(SomCommandListener listener) throws SomException
listener
- Object to notify when update complete, which may be nullSomException
- on errorpublic void getSubordinateChannels(SomCommandListener listener) throws SomException
listener
- Object to notify when update complete, which may be nullSomException
- on errorpublic void searchForHeldMessages(SomCommandListener listener) throws SomException
listener
- object to notify when command completesSomException
- on errorpublic void reprocess(SomCommandListener listener) throws SomException
listener
- Listener to notify when operation is complete, which may be nullSomException
- on errorpublic void performCkadr(SomCommandListener listener, SomQmgrHandler handler, SomQmgrCKADROptions options) throws SomException
listener
- Object to notify when update complete, which may be nullhandler
- Object which will handle result of operation, which may not be nulloptions
- Arguments to ckadr operationSomException
- on errorpublic java.lang.Integer getPort()
public void setPort(java.lang.Integer p)
p
- Port to usepublic java.lang.Integer getACP127CMPort()
public void setACP127CMPort(java.lang.Integer p)
p
- Port to usepublic java.lang.Integer getACPOTAMPort()
public void setACPOTAMPort(java.lang.Integer p)
p
- Port to usepublic java.lang.String getHostName()
public void setHostName(java.lang.String n)
n
- Hostname to usepublic java.lang.String getUsername()
public void setUsername(java.lang.String n)
n
- Username for connection (may be a SASL id) which may not be nullpublic java.lang.String getPassword()
public void setPassword(java.lang.String pwd)
pwd
- Password which may be nullpublic java.lang.String getFriendlyName()
public void setFriendlyName(java.lang.String fname)
fname
- friendly name which may not be nullpublic static void setConnectionTimeout(int value)
value
- the timeout valuepublic void setUseTls(boolean use)
use
- true to use TLSpublic boolean getUseTls()
public void connect() throws SomException
SomException
- on errorpublic void connectACP127CM() throws SomException
SomException
- on errorpublic void connectACPOTAM() throws SomException
SomException
- on errorpublic void disconnect() throws SomException
SomException
- on errorpublic void incrementMaxChannels(SomCommandListener listener) throws SomException
listener
- Object to be notified when operation complete, which may be nullSomException
- on errorpublic void decrementMaxChannels(SomCommandListener listener) throws SomException
listener
- Object to be notified when operation complete, which may be nullSomException
- on errorpublic void enableSubmission(SomCommandListener listener) throws SomException
listener
- Object to be notified when operation complete, which may be nullSomException
- on errorpublic void disableSubmission(SomCommandListener listener) throws SomException
listener
- Object to be notified when operation complete, which may be nullSomException
- on errorpublic void enableAllChannels(SomCommandListener listener) throws SomException
listener
- Object to be notified when operation complete, which may be nullSomException
- on errorpublic void disableAllChannels(SomCommandListener listener) throws SomException
listener
- Object to be notified when operation complete, which may be nullSomException
- on errorpublic void rereadQueue(SomCommandListener listener) throws SomException
listener
- Object to be notified when operation complete, which may be nullSomException
- on errorpublic void restart(SomCommandListener listener) throws SomException
listener
- Object to be notified when operation complete, which may be nullSomException
- on errorpublic void shutdown(SomCommandListener listener) throws SomException
listener
- Object to be notified when operation complete, which may be nullSomException
- on errorpublic void reloadConfiguration(SomCommandListener listener) throws SomException
listener
- Object to be notified when operation complete, which may be nullSomException
- on errorpublic void auditString(java.lang.String type, java.lang.String key, java.lang.String value, SomCommandListener listener) throws SomException
SomException
public java.lang.Integer addrIn() throws SomException
SomException
- on errorpublic java.lang.String getErrorText()
public java.lang.Integer addrOut() throws SomException
SomException
- on errorpublic java.lang.String boottime() throws SomException
SomException
- on errorpublic java.lang.Integer currChans() throws SomException
SomException
- on errorpublic java.lang.Integer inAssoc() throws SomException
SomException
- on errorpublic java.lang.Integer maxChans() 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.Integer msgsInPerSec() throws SomException
SomException
- on errorpublic java.lang.Integer msgsOutPerSec() throws SomException
SomException
- on errorpublic java.lang.Integer opsPerSecond() throws SomException
SomException
- on errorpublic java.lang.Integer outAssoc() throws SomException
SomException
- on errorpublic java.lang.String reporttime() throws SomException
SomException
- on errorpublic java.lang.Integer runnableChans() throws SomException
SomException
- on errorpublic java.lang.Integer totalDrs() throws SomException
SomException
- on errorpublic java.lang.Integer totalInAssoc() throws SomException
SomException
- on errorpublic java.lang.Integer totalMsgs() throws SomException
SomException
- on errorpublic java.lang.Integer heldMsgs() throws SomException
SomException
- on errorpublic java.lang.Integer totalOutAssoc() throws SomException
SomException
- on errorpublic java.lang.Integer totalVolume() throws SomException
SomException
- on errorpublic java.lang.String version() throws SomException
SomException
- on errorpublic java.lang.String hostname() throws SomException
SomException
- on errorpublic java.lang.Integer chanRate() throws SomException
SomException
- on errorpublic java.lang.String dirname() throws SomException
SomException
- on errorpublic java.lang.Integer failedConvert() throws SomException
SomException
- on errorpublic java.lang.Integer failedInAssoc() 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 oprateMax() throws SomException
SomException
- on errorpublic java.lang.Integer oprateReserve() throws SomException
SomException
- on errorpublic java.lang.Integer receivedVolume() throws SomException
SomException
- on errorpublic java.lang.Integer rejectedAssoc() throws SomException
SomException
- on errorpublic java.lang.Integer somVersion() throws SomException
SomException
- on errorpublic java.lang.Integer status() throws SomException
SomException
- on errorpublic java.lang.String statusString() throws SomException
SomException
- on errorpublic java.lang.String osType() throws SomException
SomException
- on errorpublic java.lang.Integer storedRecipients() throws SomException
SomException
- on errorpublic java.lang.Integer transmittedVolume() throws SomException
SomException
- on errorpublic void minimise(int priority, java.util.Date start, java.util.Date stop, SomCommandListener listener) throws SomException
priority
- minimum priority for MINIMISEstart
- start time (UTC time string) which may be nullstop
- stop time (UTC time string) which may be nulllistener
- object to be notified when operation complete which may be nullSomException
- on errorpublic java.lang.Integer getCurrentTimeOffset()
public java.util.Date getCurrentTime()
public java.util.Vector<java.lang.String> getHostAliases()
public void setHostAliases(java.util.List<java.lang.String> hostAliases)
hostAliases
- which may be nullpublic void setNoServices(java.lang.Boolean val)
val
- true if we do not want to manage servicespublic java.lang.Boolean getNoServices()
public void setSaslMechanism(java.lang.String mech)
mech
- mechanism name which may be nullpublic java.lang.String getSaslMechanism()
public void setUseACP127OTAMPort(boolean value)
value
- true if this object should use the OTAM portpublic void setUseACP127CMPort(boolean value)
value
- true if this object should use the ACP127 channel portpublic boolean getUseACP127OTAMPort()
public boolean getUseACP127CMPort()
public java.lang.String getAcp127TestTapeTemplateDir()
public void setAcp127TestTapeTemplateDir(java.lang.String acp127TestTapeTemplateDir)
acp127TestTapeTemplateDir
- test tape template directorypublic boolean getUseACP127RepairPort()
public java.lang.Integer getACP127RepairPort()
public java.lang.Integer loggingFreePercent() throws SomException
SomException
- on errorpublic java.lang.Integer archiveFreePercent() throws SomException
SomException
- on errorpublic java.lang.Integer queueFreePercent() throws SomException
SomException
- on errorpublic java.lang.String lastOperation() throws SomException
SomException
public java.lang.String lastOperationTime() throws SomException
SomException
public com.isode.dsapi.DN getConfigDN()
public void setConfigDN(com.isode.dsapi.DN configDN)
public boolean isRemoteMTA()
public void setRemoteMTA(boolean val)
Version: 18.0v6-0
Copyright (c) 2017-2020 Isode