public class IntegrationNodeConnectionParameters extends java.lang.Object implements BrokerConnectionParameters
Applications should create an instance of this class to connect to an
integration node using its hostname and web administration port.
In order to attempt a connection, the instance must then be passed to the
BrokerProxy.getInstance
method. For example:
BrokerProxy.getInstance( new IntegrationNodeConnectionParameters( "mymachine.domain.com", 4414));Note that once the getInstance() method has been called, modifying the IntegrationNodeConnectionParameters object will have no effect on existing connections.
To connect to an integration node defined on the local machine, it is recommended
that you use BrokerProxy.getLocalInstance
instead.
class
com.ibm.broker.config.proxy.IntegrationNodeConnectionParameters
implements
com.ibm.broker.config.proxy.BrokerConnectionParameters
|
|
Responsibilities | Represents a set of IP connection parameters to an integration node. |
Constructor and Description |
---|
IntegrationNodeConnectionParameters(java.lang.String filename)
Constructs a new instance that refers to connection properties in the
file with the supplied fully qualified name.
|
IntegrationNodeConnectionParameters(java.lang.String ip,
int port)
Takes the parameters required to make an IP-based connection to an
integration node.
|
IntegrationNodeConnectionParameters(java.lang.String ip,
int port,
java.lang.String userName,
java.lang.String password,
boolean useSSL)
Takes the parameters required to make an IP-based connection to an
integration node.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBrokerName()
Returns the name of the integration node
|
java.lang.String |
getHostname()
Returns the IP address or hostname of the integration node as stored in the properties file.
|
java.lang.String |
getIp()
Returns the IP address or hostname of the integration node
|
int |
getPort()
Returns the port used by the web admin listener that is started by the integration node
|
com.ibm.broker.config.proxy.CommsMessageSerializer |
getProtocol()
This method is required by the IBM Integration API (CMP) and
should not be called by user applications.
|
java.lang.String |
getQueueManager() |
com.ibm.broker.config.proxy.Receiver |
getReceiver()
This method is required by the IBM Integration API (CMP) and
should not be called by user applications.
|
com.ibm.broker.config.proxy.Sender |
getSender()
This method is required by the IBM Integration API (CMP) and
should not be called by user applications.
|
java.lang.String |
getSessionIDString()
Returns a String representation of the session Id for this connection
to the broker.
|
java.lang.String |
getUserID()
Returns the user ID to be used for administration security credentials.
|
boolean |
isLocal() |
boolean |
isPasswordSet() |
void |
setAdvancedConnectionParameters(int maxRetries,
int retryWaitMillis)
Sets advanced options for a connection to the Integration Node.
|
void |
setPassword(java.lang.String password) |
void |
setUserID(java.lang.String userName) |
java.lang.String |
toString()
For diagnostic information, this method displays
the current connection parameters.
|
void |
validate(BrokerProxy proxy)
This method is required by the IBM Integration API (CMP) and
should not be called by user applications.
|
public IntegrationNodeConnectionParameters(java.lang.String ip, int port)
ip
- IP Address of the target integration node.port
- Web admin port of the target integration node.public IntegrationNodeConnectionParameters(java.lang.String ip, int port, java.lang.String userName, java.lang.String password, boolean useSSL)
ip
- IP Address of the target integration node.port
- Web admin port of the target integration node.userName
- User name defined to the remote integration node (this is a web user account)password
- password for User name.useSSL
- Connect to the remote integration node using SSL connectivity.public IntegrationNodeConnectionParameters(java.lang.String filename)
filename
- Path and file name of the parameter file, which must be in
the *.broker format. Supplying a null or blank parameter
here has the same effect as calling the empty constructor.public java.lang.String getQueueManager()
public java.lang.String getIp()
public java.lang.String getHostname()
public int getPort()
public boolean isLocal()
public java.lang.String getBrokerName()
public void setAdvancedConnectionParameters(int maxRetries, int retryWaitMillis)
maxRetries
- The number of times the IBM Integration API
(CMP) should retry sending messages after consecutive
failures. If this is set to -1, the existing value will be
used.retryWaitMillis
- The time (in milliseconds) the IBM
Integration API (CMP) should wait inbetween retries. If this
is set to -1, the existing value will be used.public com.ibm.broker.config.proxy.CommsMessageSerializer getProtocol()
getProtocol
in interface BrokerConnectionParameters
public com.ibm.broker.config.proxy.Receiver getReceiver() throws ConfigManagerProxyLoggedException
getReceiver
in interface BrokerConnectionParameters
ConfigManagerProxyLoggedException
- if the Receiver could
not be initialized.public com.ibm.broker.config.proxy.Sender getSender() throws ConfigManagerProxyLoggedException
getSender
in interface BrokerConnectionParameters
ConfigManagerProxyLoggedException
- if the Sender could
not be initialized.public java.lang.String getUserID()
getUserID
in interface BrokerConnectionParameters
public void setUserID(java.lang.String userName)
public void setPassword(java.lang.String password)
public boolean isPasswordSet()
public java.lang.String getSessionIDString()
public void validate(BrokerProxy proxy) throws ConfigManagerProxyLoggedException
BrokerConnectionParameters
validate
in interface BrokerConnectionParameters
ConfigManagerProxyLoggedException
public java.lang.String toString()
toString
in class java.lang.Object