com.sun.jbi.util.jmx

Interface JMXConnectorSource

All Known Implementing Classes:

AppSrvJMXConnectorSource, JMXConnectorSourceImpl

public interface JMXConnectorSource

This interface is to be used by jbi components / services to get a JMX Client Connector. This is a wrapper around the JMXConnectorFactory and allows one to connect to a Connector Server, which may have proprietary extensions for Security. The corresponding client Connector Source would be made available through this interface.

Author:

Sun Microsystems, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
JMXConnector	getJMXConnector(boolean forceNew, Map environment) If the connection has already been created, return the existing JMXConnector unless 'forceNew' is true or the connection is currently null.
void	setCredentials(String username, String password)
void	setHostAndPort(String host, int port) If the JMX Connector Server's host and port cannot be identified from the JMX Service URL or if the JMXServiceURL is not set, then this is the process of indicating this information.
void	setIsSecure(boolean secureFlag)
void	setJMXServiceURL(JMXServiceURL jmxServiceURL) If the JMXServiceURL is setup using this method, the host, protocol and port set independently are overridden.
void	setTrustStore(File truststore, String type, char[] passwd)

Method Detail

setCredentials

void setCredentials(String username,
                  String password)

Parameters:

username - is the username to be used for the Connection.

password - is the user password.

setIsSecure

void setIsSecure(boolean secureFlag)

Parameters:

secureFlag - indicates whether the connection is to be secured (ex. use SSL)

setTrustStore

void setTrustStore(File truststore,
                 String type,
                 char[] passwd)

Parameters:

truststore - path to the JKS truststore file.

type - is the type of the Keystore ( JKS, JCEKS etc)

passwd - - the truststore password

setJMXServiceURL

void setJMXServiceURL(JMXServiceURL jmxServiceURL)

If the JMXServiceURL is setup using this method, the host, protocol and port set independently are overridden.

Parameters:

jmxServiceURL - - JMX Service URL

setHostAndPort

void setHostAndPort(String host,
                  int port)

If the JMX Connector Server's host and port cannot be identified from the JMX Service URL or if the JMXServiceURL is not set, then this is the process of indicating this information.

Parameters:

host - - hostname

port - - port

getJMXConnector

JMXConnector getJMXConnector(boolean forceNew,
                           Map environment)
                             throws IOException

If the connection has already been created, return the existing JMXConnector unless 'forceNew' is true or the connection is currently null.

Parameters:

forceNew - - create a new connection

environment - - a set of attributes to determine how the connection is made. This parameter can be null. Keys in this map must be Strings. The appropriate type of each associated value depends on the attribute. The contents of environment are not changed by this call

Returns:

the JMX Connector.

Throws:

IOException - if a connection cannot be established.