ServerSocketInterface (NetPhantom® 8.0 Java API Specification)

All Known Subinterfaces:
ServerSocketInterface2, ServerSocketInterface3
All Known Implementing Classes:
DefaultServerSocket, NetPhantomJSSEServerSocket
```
public interface ServerSocketInterface
```
ServerSocketInterface is used by servers to listen for requests from clients for [SSL] connections. The ServerSocketInterface is extended by the ServerSocketInterface2 that listens on the specified port; optional arguments specify the backlog of client connection requests.
As SSL requires additional parameters that are generally implementation dependent, the "server.ini" file object is passed along. This makes it possible to access information in - typically - the "[SSL]" section of the file.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SSLINFO_CLIENTCERT_ISSUER` Performs the SSL handshake, if necessary, and gets the client certificate issuer in form of CN=nnn\|O=nnn\|L=nnn\|S=nnn\|C=NN, CN=Common Name, O=Organization, L=Locality, S=State or province, C=Country, and "\|" is character '\0'.
`static int`	`SSLINFO_CLIENTCERT_PUBLICKEYFORMAT` Get the "Public key format".
`static int`	`SSLINFO_CLIENTCERT_SERIALNUMBER` The client certificate serial number (null for none, otherwise a hex string without spaces).
`static int`	`SSLINFO_CLIENTCERT_SIGNATUREALGORITHM` Get the "Signature Algorithm".
`static int`	`SSLINFO_CLIENTCERT_SUBJECT` Performs the SSL handshake, if necessary, and gets the client certificate subject in form of CN=nnn\|OU=nnn\|O=nnn\|L=nnn\|S=nnn\|C=NN\|E=nnn, CN=Common Name, OU=Organizational Unit, O=Organization, L=Locality, S=State or province, C=Country, E=Email address, and "\|" is character '\0'.
`static int`	`SSLINFO_CLIENTCERT_VALIDFROM` Performs the SSL handshake, if necessary, and gets the client certificate "Valid from" date in the server date country settings.
`static int`	`SSLINFO_CLIENTCERT_VALIDTO` Performs the SSL handshake, if necessary, and gets the client certificate "Valid to" date in the server date country settings.
`static int`	`SSLINFO_CLIENTCERT_VERSION` Get the "Version" as an integer.
`static int`	`SSLINFO_GETCIPHER` The level of information: the name of the cipher being used.
`static int`	`SSLINFO_GETEFFECTIVEBITS` The level of information: The number of effective bits for encryption.
`static int`	`SSLINFO_ISENCRYPTED` The level of information: "0" or "1" if encrypted or not.
`static int`	`SSLINFO_ISSTRONGENCRYPTED` The level of information: "0" or "1" if strong encrypted (>=128 bits) or not.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this socket.
`InetAddress`	`getInetAddress()` Returns the local address of this server socket.
`String`	`getInformation(ISocket socket, int index)` Returns SSL information about this socket.
`String`	`getLocalAddress(ISocket socket)` Gets the local address of the socket.
`String`	`getLocalName(ISocket socket)` Gets the local name of the socket.
`int`	`getLocalPort()` Returns the port on which this socket is listening.
`int`	`getMapToPort()` Gets the port number being mapped to externally.
`String`	`getPortID()` Gets the port ID.
`boolean`	`isEncrypted(ISocket socket)` Checks if encryption (with SSL with any encryption - not only signing) is used.
`boolean`	`isLoadBalanced()` Checks if the port is load balanced.
`boolean`	`isStrongEncrypted(ISocket socket)` Checks if strong encryption (using SSL) is used.
`boolean`	`isUsingSSL()` Returns if SSL is used or not.
`boolean`	`renegotiateSession(ISocket socket, boolean isStrongEncryptionRequired, boolean isClientAuthenticationRequired, String accessControlID, Thread readerThread)` If an SSL connection is not using strong encryption or if a client certificate is required, call this method.
`void`	`setExternalSSL(boolean isExternal)` Sets the external SSL flag.
`void`	`setLoadBalancing(boolean isLoadBalanced)` Sets load balancing.
`String`	`toString()` Returns the implementation address and implementation port of this socket as a String.

- Field Detail
  - SSLINFO_ISENCRYPTED
```
static final int SSLINFO_ISENCRYPTED
```
    The level of information: "0" or "1" if encrypted or not.
    See Also:
    Constant Field Values
  - SSLINFO_ISSTRONGENCRYPTED
```
static final int SSLINFO_ISSTRONGENCRYPTED
```
    The level of information: "0" or "1" if strong encrypted (>=128 bits) or not.
    See Also:
    Constant Field Values
  - SSLINFO_GETEFFECTIVEBITS
```
static final int SSLINFO_GETEFFECTIVEBITS
```
    The level of information: The number of effective bits for encryption.
    See Also:
    Constant Field Values
  - SSLINFO_GETCIPHER
```
static final int SSLINFO_GETCIPHER
```
    The level of information: the name of the cipher being used.
    See Also:
    Constant Field Values
  - SSLINFO_CLIENTCERT_SERIALNUMBER
```
static final int SSLINFO_CLIENTCERT_SERIALNUMBER
```
    The client certificate serial number (null for none, otherwise a hex string without spaces).
    See Also:
    Constant Field Values
  - SSLINFO_CLIENTCERT_SUBJECT
```
static final int SSLINFO_CLIENTCERT_SUBJECT
```
    Performs the SSL handshake, if necessary, and gets the client certificate subject in form of CN=nnn|OU=nnn|O=nnn|L=nnn|S=nnn|C=NN|E=nnn, CN=Common Name, OU=Organizational Unit, O=Organization, L=Locality, S=State or province, C=Country, E=Email address, and "|" is character '\0'.
    Returns null if client certificate authentication or SSL is not used.
    See Also:
    Constant Field Values
  - SSLINFO_CLIENTCERT_ISSUER
```
static final int SSLINFO_CLIENTCERT_ISSUER
```
    Performs the SSL handshake, if necessary, and gets the client certificate issuer in form of CN=nnn|O=nnn|L=nnn|S=nnn|C=NN, CN=Common Name, O=Organization, L=Locality, S=State or province, C=Country, and "|" is character '\0'.
    Returns null if client certificate authentication or SSL is not used.
    See Also:
    Constant Field Values
  - SSLINFO_CLIENTCERT_VALIDFROM
```
static final int SSLINFO_CLIENTCERT_VALIDFROM
```
    Performs the SSL handshake, if necessary, and gets the client certificate "Valid from" date in the server date country settings.
    Returns null if client certificate authentication or SSL is not used.
    See Also:
    Constant Field Values
  - SSLINFO_CLIENTCERT_VALIDTO
```
static final int SSLINFO_CLIENTCERT_VALIDTO
```
    Performs the SSL handshake, if necessary, and gets the client certificate "Valid to" date in the server date country settings.
    Returns null if client certificate authentication or SSL is not used.
    See Also:
    Constant Field Values
  - SSLINFO_CLIENTCERT_VERSION
```
static final int SSLINFO_CLIENTCERT_VERSION
```
    Get the "Version" as an integer.
    Returns null if client certificate authentication or SSL is not used.
    See Also:
    Constant Field Values
  - SSLINFO_CLIENTCERT_SIGNATUREALGORITHM
```
static final int SSLINFO_CLIENTCERT_SIGNATUREALGORITHM
```
    Get the "Signature Algorithm".
    Returns null if client certificate authentication or SSL is not used.
    See Also:
    Constant Field Values
  - SSLINFO_CLIENTCERT_PUBLICKEYFORMAT
```
static final int SSLINFO_CLIENTCERT_PUBLICKEYFORMAT
```
    Get the "Public key format".
    Returns null if client certificate authentication or SSL is not used.
    See Also:
    Constant Field Values
- Method Detail
  - getInformation
```
String getInformation(ISocket socket,
                      int index)
```
    Returns SSL information about this socket.
    Parameters:
    index - index of the information requested.
    Returns:
    null when this is not an SSL socket or if the information is not available.
  - getPortID
```
String getPortID()
```
    Gets the port ID.
  - setExternalSSL
```
void setExternalSSL(boolean isExternal)
```
    Sets the external SSL flag. The method isUsingSSL may then return true even if the interface is not really SSL.
  - isUsingSSL
```
boolean isUsingSSL()
```
    Returns if SSL is used or not.
  - isEncrypted
```
boolean isEncrypted(ISocket socket)
```
    Checks if encryption (with SSL with any encryption - not only signing) is used.
  - isStrongEncrypted
```
boolean isStrongEncrypted(ISocket socket)
```
    Checks if strong encryption (using SSL) is used.
  - setLoadBalancing
```
void setLoadBalancing(boolean isLoadBalanced)
```
    Sets load balancing.
  - isLoadBalanced
```
boolean isLoadBalanced()
```
    Checks if the port is load balanced.
  - renegotiateSession
```
boolean renegotiateSession(ISocket socket,
                           boolean isStrongEncryptionRequired,
                           boolean isClientAuthenticationRequired,
                           String accessControlID,
                           Thread readerThread)
                    throws IOException
```
    If an SSL connection is not using strong encryption or if a client certificate is required, call this method.
    Returns:
    false if the socket is not an SSL socket connection.
    Throws:
    IOException - for negotiation or other I/O failures.
  - getInetAddress
```
InetAddress getInetAddress()
```
    Returns the local address of this server socket.
    Returns:
    the address to which this socket is connected, or null if the socket is not yet connected. If the server socket is not yet created, null is returned.
  - getLocalName
```
String getLocalName(ISocket socket)
```
    Gets the local name of the socket. This value is cached once retrieved.
    Returns:
    null if no local name exists.
  - getLocalAddress
```
String getLocalAddress(ISocket socket)
```
    Gets the local address of the socket. This value is cached once retrieved.
    Returns:
    string formatted as 1.2.3.4.
  - getLocalPort
```
int getLocalPort()
```
    Returns the port on which this socket is listening.
    Returns:
    the port number to which this socket is listening. If the server socket is not yet created, -1 is returned.
  - getMapToPort
```
int getMapToPort()
```
    Gets the port number being mapped to externally. If no mapping is done, the same value as getLocalPort is returned.
    Returns:
    the port number to which this socket is listening and is mapped to. If the server socket is not yet created, -1 is returned.
  - close
```
void close()
    throws IOException
```
    Closes this socket.
    Throws:
    IOException - if an I/O error occurs when closing the socket.
  - toString
```
String toString()
```
    Returns the implementation address and implementation port of this socket as a String.
    Overrides:
    toString in class Object
    Returns:
    a string representation of this socket.

Interface ServerSocketInterface

Field Summary

Method Summary

Field Detail

SSLINFO_ISENCRYPTED

SSLINFO_ISSTRONGENCRYPTED

SSLINFO_GETEFFECTIVEBITS

SSLINFO_GETCIPHER

SSLINFO_CLIENTCERT_SERIALNUMBER

SSLINFO_CLIENTCERT_SUBJECT

SSLINFO_CLIENTCERT_ISSUER

SSLINFO_CLIENTCERT_VALIDFROM

SSLINFO_CLIENTCERT_VALIDTO

SSLINFO_CLIENTCERT_VERSION

SSLINFO_CLIENTCERT_SIGNATUREALGORITHM

SSLINFO_CLIENTCERT_PUBLICKEYFORMAT

Method Detail

getInformation

getPortID

setExternalSSL

isUsingSSL

isEncrypted

isStrongEncrypted

setLoadBalancing

isLoadBalanced

renegotiateSession

getInetAddress

getLocalName

getLocalAddress

getLocalPort

getMapToPort

close

toString