Package com.isode.som.qmgr.objects

Class SomQmgrAssociation

java.lang.Object

com.isode.som.qmgr.objects.SomQmgrObject

com.isode.som.qmgr.objects.SomQmgrAssociation

All Implemented Interfaces:

SomQmgrHandler, SomHandler

public class SomQmgrAssociation
extends SomQmgrObject
implements SomQmgrHandler

This class models an association between a channel (inbound or outbound) and a peer MTA of some type.

Author:

tc

Field Summary

Fields inherited from class com.isode.som.qmgr.objects.SomQmgrObject

errortext, somSession

Constructor Summary

Constructors

Constructor	Description
SomQmgrAssociation(SomSession session)	Create a new SomQmgrAssociation object for a specified channel and MTA
SomQmgrAssociation(SomSession session, String[] pairs)	Create a new SomQmgrAssociation object for a specified channel and MTA, populating it with data from type/value pairs

Method Summary

Modifier and Type	Method	Description
Integer	applIndex()	Get the application index value for the association
Integer	association()	Get the association id
Integer	associationType()	Get the association type
String	buildInfoString()
void	handleBindResponse(int status, 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, String detail)	Handles the response to control commands which return an OK/error response plus an info string
void	handleResponse(SomCommand command, int status, String[] pairs)	Handles the response to commands which return data about the current object - i.e.
String	startTime()	Get the time at which the association started

Methods inherited from class com.isode.som.qmgr.objects.SomQmgrObject

addAttribute, addAttribute, addBindListener, clearAttributes, getBooleanAttributeValue, getDoubleAttributeValue, getIntegerAttributeValue, getSession, getStringAttributeValue, notifyBindListeners, notifyListener, notifyListeners, parsePairs, print, print_str, removeBindListener, setSkipNotifications

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SomQmgrAssociation

public SomQmgrAssociation(SomSession session)

Create a new SomQmgrAssociation object for a specified channel and MTA

Parameters:

session - Session object for association which may not be null

SomQmgrAssociation

public SomQmgrAssociation(SomSession session,
 String[] pairs)

Create a new SomQmgrAssociation object for a specified channel and MTA, populating it with data from type/value pairs

Parameters:

session - Session object for association which may not be null

pairs - Array of data pairs which may not be null

Method Details

applIndex

public Integer applIndex()
                  throws SomException

Get the application index value for the association

Returns:

application index

Throws:

SomException - on error

association

public Integer association()
                    throws SomException

Get the association id

Returns:

association id

Throws:

SomException - on error

associationType

public Integer associationType()
                        throws SomException

Get the association type

Returns:

association type

Throws:

SomException - on error

startTime

public String startTime()
                 throws SomException

Get the time at which the association started

Returns:

Association start time (UTC Time String)

Throws:

SomException - on error

handleResponse

public void handleResponse(SomCommand command,
 int status,
 String detail)

Description copied from interface: SomQmgrHandler

Handles the response to control commands which return an OK/error response plus an info string

Specified by:

handleResponse in interface SomHandler

Specified by:

handleResponse in interface SomQmgrHandler

Parameters:

command - the SOM command

status - operation status

detail - detail on error

handleResponse

public void handleResponse(SomCommand command,
 int status,
 SomQmgrQueueManager object)

handleResponse

public void handleResponse(SomCommand command,
 int status,
 SomQmgrChannel object)

Description copied from interface: SomQmgrHandler

Handles the response to commands which return a list of channel objects

Specified by:

handleResponse in interface SomQmgrHandler

Parameters:

command - the SOM command

status - operation status

object - a channel object

handleResponse

public void handleResponse(SomCommand command,
 int status,
 SomQmgrMta object)

Description copied from interface: SomQmgrHandler

Handles the response to commands which return a list of MTA objects

Specified by:

handleResponse in interface SomQmgrHandler

Parameters:

command - the SOM command

status - operation status

object - a SOM Qmgr MTA object

handleResponse

public void handleResponse(SomCommand command,
 int status,
 SomQmgrMessage object)

Description copied from interface: SomQmgrHandler

Handles the response to commands which return a list of message objects

Specified by:

handleResponse in interface SomQmgrHandler

Parameters:

command - the SOM command

status - operation status

object - a qmgr message object

handleBindResponse

public void handleBindResponse(int status,
 String detail)

Description copied from interface: SomHandler

Handle the response to a Bind operation

Specified by:

handleBindResponse in interface SomHandler

Parameters:

status - operation status

detail - error detail on failure

handleResponse

public void handleResponse(SomCommand obj,
 int status,
 SomMessage msg)

Description copied from interface: SomQmgrHandler

Handles the response to commands which return a SomMessage object (i.e. read from the Queue or Archive).

Specified by:

handleResponse in interface SomQmgrHandler

Parameters:

obj - the SOM command

status - operation status

msg - a message object

handleResponse

public void handleResponse(SomCommand command,
 int status,
 String[] pairs)

Description copied from interface: SomQmgrHandler

Handles the response to commands which return data about the current object - i.e. we are refreshing an existing object.

Specified by:

handleResponse in interface SomQmgrHandler

Parameters:

command - the SOM command

status - operation status

pairs - data pairs

buildInfoString

public String buildInfoString()