com.sun.jdmk.comm
Class HttpsConnectorServer

java.lang.Object
  com.sun.jdmk.comm.CommunicatorServer
      com.sun.jdmk.comm.GenericHttpConnectorServer
          com.sun.jdmk.comm.HttpsConnectorServer

All Implemented Interfaces:

CommunicatorServerMBean, GenericHttpConnectorServerMBean, HttpsConnectorServerMBean, Runnable, MBeanRegistration, NotificationBroadcaster

Deprecated. The JMX Remote API should be used in preference to the legacy Java DMK connector classes. This class may be removed in a future version of Java DMK. See JdmkLegacyConnector.

public class HttpsConnectorServer
extends GenericHttpConnectorServer
implements HttpsConnectorServerMBean

This class implements the server part of the HTTP/SSL connector. This class inherits most of its behavior. It performs only TCP-specific tasks:

• it creates, reads, writes and closes the SSL sockets,
• it defines the default port of the connector: 8084.

See Also:

HttpsConnectorClient

Field Summary

Fields inherited from class com.sun.jdmk.comm.CommunicatorServer

HTML_TYPE, HTTP_TYPE, HTTPS_TYPE, OFFLINE, ONLINE, RMI_TYPE, SNMP_TYPE, STARTING, STOPPING

Constructor Summary

HttpsConnectorServer()
Deprecated. Constructs an HttpsConnectorServer.

HttpsConnectorServer(int port)
Deprecated. Constructs an HttpsConnectorServer.

HttpsConnectorServer(int port, AuthInfo[] authInfoList)
Deprecated. Constructs an HttpsConnectorServer.

HttpsConnectorServer(int port, AuthInfo[] authInfoList, InetAddress bindAddr)
Deprecated. Constructs an HttpsConnectorServer.

HttpsConnectorServer(int port, AuthInfo[] authInfoList, InetAddress bindAddr, boolean needClientAuth)
Deprecated. Constructs an HttpsConnectorServer.

HttpsConnectorServer(int port, InetAddress bindAddr)
Deprecated. Constructs an HttpsConnectorServer.

Method Summary

boolean	getNeedClientAuth() Deprecated. Returns true if client authentication is required on SSL connections accepted by the server socket created by this connector server.
String	getProtocol() Deprecated. Returns the name of the protocol used.
int	getTimeout() Deprecated. Returns setting for Timeout.
ObjectName	preRegister(MBeanServer server, ObjectName name) Deprecated. Allows the MBean to perform any operations it needs before being registered in the MBean server.
void	setTimeout(int value) Deprecated. Enables/disables Timeout with the specified timeout, in milliseconds.

Methods inherited from class com.sun.jdmk.comm.GenericHttpConnectorServer

addUserAuthenticationInfo, doBind, doError, doProcess, doReceive, doUnbind, getActiveClientCount, getLastConnectedClient, getMaxActiveClientCount, getServedClientCount, isAuthenticationOn, postDeregister, postRegister, preDeregister, removeUserAuthenticationInfo, setMaxActiveClientCount, setMBeanServer, stop

Methods inherited from class com.sun.jdmk.comm.CommunicatorServer

addNotificationListener, getHost, getMBeanServer, getNotificationInfo, getPort, getState, getStateString, isActive, removeNotificationListener, run, setPort, start, waitState

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.jdmk.comm.GenericHttpConnectorServerMBean

getActiveClientCount, getLastConnectedClient, getMaxActiveClientCount, getServedClientCount, isAuthenticationOn, setMaxActiveClientCount

Methods inherited from interface com.sun.jdmk.comm.CommunicatorServerMBean

getHost, getPort, getState, getStateString, isActive, setPort, start, stop, waitState

Constructor Detail

HttpsConnectorServer

public HttpsConnectorServer()

Deprecated.

Constructs an HttpsConnectorServer.

Initializes this connector server with the default port (8084) and SSL client authentication required.

HttpsConnectorServer

public HttpsConnectorServer(int port)

Deprecated.

Constructs an HttpsConnectorServer.

Initializes this connector server with the specified port and SSL client authentication required.

Parameters:

port - The port number.

HttpsConnectorServer

public HttpsConnectorServer(int port,
                            AuthInfo[] authInfoList)

Deprecated.

Constructs an HttpsConnectorServer.

Initializes this connector server with the specified port, user authentication information list and SSL client authentication required.

Parameters:

port - The port number.

authInfoList - The user authentication information list. If authInfoList is null no user authentication is performed.

HttpsConnectorServer

public HttpsConnectorServer(int port,
                            InetAddress bindAddr)

Deprecated.

Constructs an HttpsConnectorServer.

Initializes this connector server with the specified port, local IP address to bind to and SSL client authentication required.

Parameters:

port - The port number.

bindAddr - The local IP address the server will bind to. If bindAddr is null, it will default accepting connections on any/all local addresses.

HttpsConnectorServer

public HttpsConnectorServer(int port,
                            AuthInfo[] authInfoList,
                            InetAddress bindAddr)

Deprecated.

Constructs an HttpsConnectorServer.

Initializes this connector server with the specified port, user authentication information list, local IP address to bind to and SSL client authentication required.

Parameters:

port - The port number.

authInfoList - The user authentication information list. If authInfoList is null no user authentication is performed.

bindAddr - The local IP address the server will bind to. If bindAddr is null, it will default accepting connections on any/all local addresses.

HttpsConnectorServer

public HttpsConnectorServer(int port,
                            AuthInfo[] authInfoList,
                            InetAddress bindAddr,
                            boolean needClientAuth)

Deprecated.

Constructs an HttpsConnectorServer.

Initializes this connector server with the specified port, user authentication information list, local IP address to bind to and SSL client authentication flag.

Parameters:

port - The port number.

authInfoList - The user authentication information list. If authInfoList is null no user authentication is performed.

bindAddr - The local IP address the server will bind to. If bindAddr is null, it will default accepting connections on any/all local addresses.

needClientAuth - true to require client authentication on SSL connections accepted by the server socket created by this connector server; false to not require client authentication.

Since:

Java DMK 5.1

Method Detail

preRegister

public ObjectName preRegister(MBeanServer server,
                              ObjectName name)
                       throws Exception

Deprecated.

Allows the MBean to perform any operations it needs before being registered in the MBean server. If the name of the HTTPS connector server MBean is not specified, it is initialized with the default value: com.sun.jdmk.ServiceName.DOMAIN: com.sun.jdmk.ServiceName.HTTPS_CONNECTOR_SERVER. If any exception is raised, the HTTPS connector server MBean will not be registered in the MBean server.

Specified by:

preRegister in interface MBeanRegistration

Overrides:

preRegister in class GenericHttpConnectorServer

Parameters:

server - The MBeanServer in which the MBean will be registered.

name - The object name of the MBean.

Returns:

The name of the registered MBean.

Throws:

Exception - This exception should be caught by the MBeanServer and re-thrown as an MBeanRegistrationException.

getProtocol

public String getProtocol()

Deprecated.

Returns the name of the protocol used.

Specified by:

getProtocol in interface CommunicatorServerMBean

Specified by:

getProtocol in class CommunicatorServer

Returns:

The string "https".

getTimeout

public int getTimeout()

Deprecated.

Returns setting for Timeout.

0 returns implies that the option is disabled (i.e. timeout of infinity).

The default value for timeout is 60000 milliseconds.

Specified by:

getTimeout in interface HttpsConnectorServerMBean

Returns:

The current value of the "Timeout" property.

setTimeout

public void setTimeout(int value)
                throws IllegalStateException

Deprecated.

Enables/disables Timeout with the specified timeout, in milliseconds.

With this option set to a non-zero timeout, a read() call on the InputStream associated with this Socket will block for only this amount of time. If the timeout expires, a InterruptedIOException is raised, though the Socket is still valid. The option must be enabled prior to entering the blocking operation to have effect. The timeout must be > 0. A timeout of zero is interpreted as an infinite timeout.

The default value for timeout is 60000 milliseconds.

Specified by:

setTimeout in interface HttpsConnectorServerMBean

Parameters:

value - The new value of the property.

Throws:

IllegalStateException - This method has been invoked while the connector was ONLINE or STARTING.

getNeedClientAuth

public final boolean getNeedClientAuth()

Deprecated.

Returns true if client authentication is required on SSL connections accepted by the server socket created by this connector server.

Returns:

true if client authentication is required

Since:

Java DMK 5.1