com.sun.jdmk.comm
Interface JdmkLegacyConnector


public interface JdmkLegacyConnector

Java DMK legacy connectors (HTTP, HTTPS and RMI) can be created through the standard JMXConnectorFactory and JMXConnectorServerFactory since Java DMK 5.1.

The factories will wrap a JDMK legacy connector into a JMXConnector or a JMXConnectorServer.

This interface specifies a protocol name for each JDMK legacy connector which will be recognized by the JMX factories, and a list of configuration properties which can be passed to the factories at creation time.

The {link #getWrapped()} method is specified by this interface in order to allow users to get the original wrapped JDMK legacy connector.

Since:
Java DMK 5.1

Field Summary
static String CLIENT_LOCALHOST
          Specifies a String object as a local host for a client (HTTP/HTTPS/RMI) to receive notifications from its server.
static String HTTP_CLIENT_AUTHINFO
          Specifies an AuthInfo object used by an HTTP/HTTPS client to connect to its server.
static String HTTP_CONNECTOR
          Specifies a protocol name for the JDMK HTTP connector.
static String HTTP_SERVER_AUTHINFO_LIST
          Specifies a list of AuthInfo (com.sun.jdmk.comm.AuthInfo[]) for an HTTP or HTTPS connector server.
static String HTTP_SERVER_LOCAL_ADDRESS
          Specifies the local InetAddress the HTTP/HTTPS connector server will bind to.
static String HTTPS_CONNECTOR
          Specifies a protocol name for the JDMK HTTPS connector.
static String HTTPS_SERVER_NEED_CLIENT_AUTH
          Specifies the SSL needClientAuth flag used by the HTTPS connector server to require or to not require mutual authentication.
static String RMI_CONNECTOR
          Specifies a protocol name for the JDMK RMI connector.
 
Method Summary
 Object getWrapped()
          Returns a wrapped JDMK legacy connector client or server.
 

Field Detail

HTTP_CONNECTOR

static final String HTTP_CONNECTOR
Specifies a protocol name for the JDMK HTTP connector.

The value is the string "jdmk-http".

See Also:
Constant Field Values

HTTPS_CONNECTOR

static final String HTTPS_CONNECTOR
Specifies a protocol name for the JDMK HTTPS connector.

The value is the string "jdmk-https".

See Also:
Constant Field Values

RMI_CONNECTOR

static final String RMI_CONNECTOR
Specifies a protocol name for the JDMK RMI connector.

The value is the string "jdmk-rmi".

See Also:
Constant Field Values

HTTP_SERVER_AUTHINFO_LIST

static final String HTTP_SERVER_AUTHINFO_LIST
Specifies a list of AuthInfo (com.sun.jdmk.comm.AuthInfo[]) for an HTTP or HTTPS connector server.

The key value is the string "com.sun.jdmk.http.server.authinfo.list".

See Also:
Constant Field Values

HTTP_SERVER_LOCAL_ADDRESS

static final String HTTP_SERVER_LOCAL_ADDRESS
Specifies the local InetAddress the HTTP/HTTPS connector server will bind to.

The key value is the string "com.sun.jdmk.http.server.local.address".

See Also:
Constant Field Values

HTTPS_SERVER_NEED_CLIENT_AUTH

static final String HTTPS_SERVER_NEED_CLIENT_AUTH
Specifies the SSL needClientAuth flag used by the HTTPS connector server to require or to not require mutual authentication. By default the HTTPS connector server requires client authentication.

The key value is the string "com.sun.jdmk.https.server.need.client.auth", the value type is a String that must be "true" or "false".

This property can be also used in the client side map to specify the needClientAuth flag for the HTTPS server the client will create when listening for notifications in push mode.

See Also:
Constant Field Values

CLIENT_LOCALHOST

static final String CLIENT_LOCALHOST
Specifies a String object as a local host for a client (HTTP/HTTPS/RMI) to receive notifications from its server.

The key value is "com.sun.jdmk.client.localhost", the value type is String, the string represents the hostname or IP address.

See Also:
Constant Field Values

HTTP_CLIENT_AUTHINFO

static final String HTTP_CLIENT_AUTHINFO
Specifies an AuthInfo object used by an HTTP/HTTPS client to connect to its server.

The key value is "com.sun.jdmk.http.client.authinfo", the value type is com.sun.jdmk.comm.AuthInfo.

See Also:
Constant Field Values
Method Detail

getWrapped

Object getWrapped()
Returns a wrapped JDMK legacy connector client or server. A user should know to which JDMK legacy connector the returned object should be cast: HTTP client/server, HTTPS client/server or RMI client/server.

The returned object is used to call those methods specified only in the original JDMK legacy connector, for example the methods to configure the Heartbeat service. A user should call directly a method from the JMXConnector/Server wrapper if that method is mapped by the wrapper.


Open Source build 02
opendmk-1.0-b02 2007.10.01_19:17:46_MEST

Copyright 1998-2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.