Sonic Management API

com.sonicsw.mf.jmx.client
Class JMSConnectorAddress

java.lang.Object
  extended by com.sonicsw.mf.jmx.client.JMSConnectorAddress

public final class JMSConnectorAddress
extends java.lang.Object

Defines the JMS connector address. This object is used by the connector client to check that the address used as the argument of its connect method is of the appropriate type.

No defaults are made.

See Also:
JMSConnectorClient

Constructor Summary
JMSConnectorAddress(java.util.Hashtable env)
          Construct a JMS connector address using the given environment.
 
Method Summary
 boolean equals(java.lang.Object object)
          Compares the connector address with another connector address.
 java.util.Hashtable getEnv()
           
 java.lang.String getManagementNode()
           
 java.lang.String getServerIdentity()
          Where the address implies a dedicated communication channel to a particular connector server the server identity will not be null.
 int hashCode()
           
 void setManagementNode(java.lang.String node)
           
 void setServerIdentity(java.lang.String identity)
          If the connector client is to be dedicated to a particular Sonic container, the identity of that container must be provided prior to connecting.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JMSConnectorAddress

public JMSConnectorAddress(java.util.Hashtable env)
Construct a JMS connector address using the given environment.

The environment (specified as a hashtable of key/value pairs) should contain sufficient information from which a SonicMQ implementation of a JMS TopicConnectionFactory may be created. Each key should map to a java bean style attribute name of such a factory. The typical set of key [attribute] names will be:

           ConnectionURLs
           DefaultUser
           DefaultPassword
 

Method Detail

equals

public boolean equals(java.lang.Object object)
Compares the connector address with another connector address.

Two connector addresses will be equal if they have an environment with matching key/values pairs.

Overrides:
equals in class java.lang.Object
Parameters:
object - A connector adddress to test for equality.
Returns:
true if equal, false if not equal

getEnv

public java.util.Hashtable getEnv()
Returns:
The environment provided when constructing the connector.
See Also:
JMSConnectorAddress(Hashtable)

getManagementNode

public java.lang.String getManagementNode()

getServerIdentity

public java.lang.String getServerIdentity()
Where the address implies a dedicated communication channel to a particular connector server the server identity will not be null.

Returns:
The server identity or null if not set.
See Also:
setServerIdentity(String)

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

setManagementNode

public void setManagementNode(java.lang.String node)

setServerIdentity

public void setServerIdentity(java.lang.String identity)
If the connector client is to be dedicated to a particular Sonic container, the identity of that container must be provided prior to connecting. Each Sonic container contains a JMX MBeanServer whose default domain equals the container identity and all Sonic compliant component will be MBeans within that JMX default domain.

If the server identity is not set, remote MBeanServer methods from which the server identity cannot be derived, will fail.

Parameters:
identity - A tokenized string of the form "<mf domain>.<mf container name>", where:
           <mf domain>
              - is the management framework domain name for the
                deployment to which we are trying to connect
           <mf container name>
              - is the management framework container name for the
                particular container (and hence MBeanServer instance)
                to which we are trying to connect.
 

A value of null is a valid value, unsetting a previously set identity.

See Also:
JMSConnectorClient.connect(JMSConnectorAddress)

Sonic Management API

Copyright © 2001-2012 Progress Software Corporation. All Rights Reserved.
HTML formatted on 13-Mar-2012.