Summary: Protected Ctors | Methods | Inherited Methods | [Expand All]

public abstract class

SSLServerSocket

extends ServerSocket

java.lang.Object
↳	java.net.ServerSocket
	↳	javax.net.ssl.SSLServerSocket

Class Overview

The extension of ServerSocket which provides secure server sockets based on protocols like SSL, TLS, or others.

Summary

Protected Constructors
	SSLServerSocket() Only to be used by subclasses.
	SSLServerSocket(int port) Only to be used by subclasses.
	SSLServerSocket(int port, int backlog) Only to be used by subclasses.
	SSLServerSocket(int port, int backlog, InetAddress address) Only to be used by subclasses.

Public Methods
abstract boolean	getEnableSessionCreation() Returns whether new SSL sessions may be established for new connections.
abstract String[]	getEnabledCipherSuites() Returns the names of the enabled cipher suites to be used for new connections.
abstract String[]	getEnabledProtocols() Returns the names of the enabled protocols to be used for new connections.
abstract boolean	getNeedClientAuth() Returns whether server-mode connections will be configured to require client authentication.
abstract String[]	getSupportedCipherSuites() Returns the names of the supported cipher suites.
abstract String[]	getSupportedProtocols() Returns the names of the supported protocols.
abstract boolean	getUseClientMode() Returns whether new connection will act in client mode when handshaking.
abstract boolean	getWantClientAuth() Returns whether server-mode connections will be configured to request client authentication.
abstract void	setEnableSessionCreation(boolean flag) Sets whether new SSL sessions may be established for new connections.
abstract void	setEnabledCipherSuites(String[] suites) Sets the names of the cipher suites to be enabled for new connections.
abstract void	setEnabledProtocols(String[] protocols) Sets the names of the protocols to be enabled for new connections.
abstract void	setNeedClientAuth(boolean need) Sets whether server-mode connections will be configured to require client authentication.
abstract void	setUseClientMode(boolean mode) Sets whether new connections should act in client mode when handshaking.
abstract void	setWantClientAuth(boolean want) Sets whether server-mode connections will be configured to request client authentication.

[Expand]

Inherited Methods

From class java.net.ServerSocket

Socket	accept() Waits for an incoming request and blocks until the connection is opened.
void	bind(SocketAddress localAddr) Binds this server socket to the given local socket address with a maximum backlog of 50 unaccepted connections.
void	bind(SocketAddress localAddr, int backlog) Binds this server socket to the given local socket address.
void	close() Closes this server socket and its implementation.
ServerSocketChannel	getChannel() Gets the related channel if this instance was created by a `ServerSocketChannel`.
InetAddress	getInetAddress() Gets the local IP address of this server socket or `null` if the socket is unbound.
int	getLocalPort() Gets the local port of this server socket or `-1` if the socket is unbound.
SocketAddress	getLocalSocketAddress() Gets the local socket address of this server socket or `null` if the socket is unbound.
int	getReceiveBufferSize() Gets the value for the receive buffer size socket option `SocketOptions.SO_RCVBUF`.
boolean	getReuseAddress() Gets the value of the socket option `SocketOptions.SO_REUSEADDR`.
synchronized int	getSoTimeout() Gets the socket `accept timeout`.
final void	implAccept(Socket aSocket) Invokes the server socket implementation to accept a connection on the given socket `aSocket`.
boolean	isBound() Returns whether this server socket is bound to a local address and port or not.
boolean	isClosed() Returns whether this server socket is closed or not.
void	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets performance preferences for connection time, latency and bandwidth.
void	setReceiveBufferSize(int size) Sets the server socket receive buffer size `SocketOptions.SO_RCVBUF`.
void	setReuseAddress(boolean reuse) Sets the value for the socket option `SocketOptions.SO_REUSEADDR`.
synchronized void	setSoTimeout(int timeout) Sets the `accept timeout` in milliseconds for this socket.
synchronized static void	setSocketFactory(SocketImplFactory aFactory) Sets the server socket implementation factory of this instance.
String	toString() Returns a textual representation of this server socket including the address, port and the state.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Called before the object's memory is reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Protected Constructors

protected SSLServerSocket ()

Since: API Level 1

Only to be used by subclasses.

Creates a TCP server socket with the default authentication context.

Throws

IOException	if creating the socket fails.

protected SSLServerSocket (int port)

Since: API Level 1

Only to be used by subclasses.

Creates a TCP server socket on the specified port with the default authentication context. The connection's default backlog size is 50 connections.

Parameters

port	the port to listen on.

Throws

IOException	if creating the socket fails.

protected SSLServerSocket (int port, int backlog)

Since: API Level 1

Only to be used by subclasses.

Creates a TCP server socket on the specified port using the specified backlog and the default authentication context.

Parameters

port	the port to listen on.
backlog	the number of pending connections to queue.

Throws

IOException	if creating the socket fails.

protected SSLServerSocket (int port, int backlog, InetAddress address)

Since: API Level 1

Only to be used by subclasses.

Creates a TCP server socket on the specified port, using the specified backlog, listening on the specified interface, and using the default authentication context.

Parameters

port	the port the listen on.
backlog	the number of pending connections to queue.
address	the address of the interface to accept connections on.

Throws

IOException	if creating the socket fails.

Public Methods

public abstract boolean getEnableSessionCreation ()

Since: API Level 1

Returns whether new SSL sessions may be established for new connections.

Returns

true if new SSL sessions may be established, false if existing SSL sessions must be reused.

public abstract String[] getEnabledCipherSuites ()

Since: API Level 1

Returns the names of the enabled cipher suites to be used for new connections.

Returns

the names of the enabled cipher suites to be used for new connections.

public abstract String[] getEnabledProtocols ()

Since: API Level 1

Returns the names of the enabled protocols to be used for new connections.

Returns

the names of the enabled protocols to be used for new connections.

public abstract boolean getNeedClientAuth ()

Since: API Level 1

Returns whether server-mode connections will be configured to require client authentication.

Returns

true if client authentication is required, false if no client authentication is needed.

public abstract String[] getSupportedCipherSuites ()

Since: API Level 1

Returns the names of the supported cipher suites.

Returns

the names of the supported cipher suites.

public abstract String[] getSupportedProtocols ()

Since: API Level 1

Returns the names of the supported protocols.

Returns

the names of the supported protocols.

public abstract boolean getUseClientMode ()

Since: API Level 1

Returns whether new connection will act in client mode when handshaking.

Returns

true if new connections will act in client mode when handshaking, false if not.

public abstract boolean getWantClientAuth ()

Since: API Level 1

Returns whether server-mode connections will be configured to request client authentication.

Returns

true is client authentication will be requested, false if no client authentication is needed.

public abstract void setEnableSessionCreation (boolean flag)

Since: API Level 1

Sets whether new SSL sessions may be established for new connections.

Parameters

flag	`true` if new SSL sessions may be established, `false` if existing SSL sessions must be reused.

public abstract void setEnabledCipherSuites (String[] suites)

Since: API Level 1

Sets the names of the cipher suites to be enabled for new connections. Only cipher suites returned by getSupportedCipherSuites() are allowed.

Parameters

suites	the names of the to be enabled cipher suites.

Throws

IllegalArgumentException	if one of the cipher suite names is not supported.

public abstract void setEnabledProtocols (String[] protocols)

Since: API Level 1

Sets the names of the protocols to be enabled for new connections. Only protocols returned by getSupportedProtocols() are allowed.

Parameters

protocols	the names of the to be enabled protocols.

Throws

IllegalArgumentException	if one of the protocols is not supported.

public abstract void setNeedClientAuth (boolean need)

Since: API Level 1

Sets whether server-mode connections will be configured to require client authentication. The client authentication is one of the following:

authentication required
authentication requested
no authentication needed

This method overrides the setting of setWantClientAuth(boolean).

Parameters

need	`true` if client authentication is required, `false` if no authentication is needed.

public abstract void setUseClientMode (boolean mode)

Since: API Level 1

Sets whether new connections should act in client mode when handshaking.

Parameters

mode	`true` if new connections should act in client mode, `false` if not.

public abstract void setWantClientAuth (boolean want)

Since: API Level 1

Sets whether server-mode connections will be configured to request client authentication. The client authentication is one of the following:

authentication required
authentication requested
no authentication needed

This method overrides the setting of setNeedClientAuth(boolean).

Parameters

want	`true` if client authentication should be requested, `false` if no authentication is needed.

Interfaces

Classes

Enums

Exceptions

SSLServerSocket

Class Overview

Summary

Protected Constructors

protected SSLServerSocket ()

Throws

protected SSLServerSocket (int port)

Parameters

Throws

protected SSLServerSocket (int port, int backlog)

Parameters

Throws

protected SSLServerSocket (int port, int backlog, InetAddress address)

Parameters

Throws

Public Methods

public abstract boolean getEnableSessionCreation ()

Returns

public abstract String[] getEnabledCipherSuites ()

Returns

public abstract String[] getEnabledProtocols ()

Returns

public abstract boolean getNeedClientAuth ()

Returns

public abstract String[] getSupportedCipherSuites ()

Returns

public abstract String[] getSupportedProtocols ()

Returns

public abstract boolean getUseClientMode ()

Returns

public abstract boolean getWantClientAuth ()

Returns

public abstract void setEnableSessionCreation (boolean flag)

Parameters

public abstract void setEnabledCipherSuites (String[] suites)

Parameters

Throws

public abstract void setEnabledProtocols (String[] protocols)

Parameters

Throws

public abstract void setNeedClientAuth (boolean need)

Parameters

public abstract void setUseClientMode (boolean mode)

Parameters

public abstract void setWantClientAuth (boolean want)

Parameters