com.goldencode.p2j.util.osresource

Class LowLevelSocketImpl

java.lang.Object

com.goldencode.p2j.util.osresource.LowLevelSocketImpl

All Implemented Interfaces:

LowLevelSocket

public class LowLevelSocketImpl
extends java.lang.Object
implements LowLevelSocket

This class acts as a delegate for the server-side to the created java socket.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	LowLevelSocketImpl.ReadListener This class is dedicated to listening for incoming socket data.
static class	LowLevelSocketImpl.SocketData A container holding the various client-socket data.
private static class	LowLevelSocketImpl.StagedInput Due to the nature of java sockets and how the 4GL sockets behave, all reading must be done in a dedicated thread.
private static class	LowLevelSocketImpl.WorkArea Container for the context-local data.

Field Summary

Fields

Modifier and Type	Field and Description
private static ContextLocal<LowLevelSocketImpl.WorkArea>	local The context-local data of this class.
private static CentralLogger	LOG Logger
private static java.lang.Object	modToken Token used to authenticate with the dispatcher when registering APIs.

Constructor Summary

Constructors

Constructor and Description
LowLevelSocketImpl(boolean local) Create an instance and export its API to the network.

Method Summary

Modifier and Type	Method and Description
int	connect(long resourceId, java.lang.String host, int port, int timeout) Establish a connection to the given host and port.
int	connectSSL(long resourceId, java.lang.String host, int port, java.lang.String serverName, boolean nosessionreuse, boolean nohostverify, java.lang.String protocol, int timeout) Establish a SSL connection to the given host and port.
private static javax.net.ssl.SSLSocket	createSslSocket(java.lang.String host, int port, java.lang.String serverName, java.net.InetAddress inetAddress, int localPort, int timeout, boolean nohostverify, boolean errManager, java.lang.String protocol) Worker for creating a SSL socket and secure it according to specifications.
boolean	disconnect(int id) Disconnect this socket.
long	getBytesAvailable(int id) Get the available bytes to be read.
boolean	getKeepAlive(int id) Get the SO_KEEPALIVE option value for this socket.
java.lang.String	getLocalHost(int id) Get the IP address of this side of this connection.
int	getLocalPort(int id) Get the port number of this side of this connection.
int	getReceiveBufferSize(int id) Get the SO_RCVBUF option value for this socket.
java.lang.String	getRemoteHost(int id) Get the host IP address of the remote side of this connection.
int	getRemotePort(int id) Get the port number of the remote side of this connection.
boolean	getReuseAddress(int id) Get the SO_REUSEADDR option value for this socket.
int	getSendBufferSize(int id) Get the SO_SNDBUF option value for this socket.
int	getSoLinger(int id) Get the SO_LINGER option value for this socket.
int	getSoTimeout(int id) Get the SO_RCVTIMEO option value for this socket.
java.lang.String	getSslServerName(int id) In case of a SSL connection, get the digital certificate subject name of the server for the current SSL session; else, return null.
boolean	getTcpNoDelay(int id) Get the TCP_NODELAY option value for this socket.
boolean	isConnected(int id) Check if the java socket is still connected.
private static boolean	isReady(int id, java.util.concurrent.CountDownLatch ready) Wait until all socket-related threads are initialized.
private static LowLevelSocketImpl.SocketData	locate(int id) Identify the socket socket data using the given ID.
private static java.net.Socket	locateSocket(int id) Identify the associated socket for the given ID.
long	read(int id, memptr buffer, long pos, long len, int mode) Java implementation for the READ() SOCKET method, this will read the specified number of bytes from the available data on the socket, and put it inside the memory buffer argument at the specified position.
static LowLevelSocketImpl.SocketData	registerClientSocket(java.net.Socket client, boolean ssl) When the server socket accepts a new connection, this will make sure the new socket is registered and a SocketImpl resource is also created on P2J server side.
void	setKeepAlive(int id, boolean on) Set the SO_KEEPALIVE option for this socket.
static void	setNoHostVerify(boolean noHostVerify) Sets value for the -nohostverify CONNECT arg.
void	setReceiveBufferSize(int id, int size) Set the SO_RCVBUF value (the receive buffer size) for this socket.
void	setReuseAddress(int id, boolean on) Set the SO_REUSEADDR option for this socket.
void	setSendBufferSize(int id, int size) Set the SO_SNDBUF value (the send buffer size) for this socket.
void	setSoLinger(int id, boolean on, int linger) Set the SO_LINGER option for this socket.
void	setSoTimeout(int id, int timeout) Set the SO_RCVTIMEO value (the number of seconds the socket waits to receive data before timing out) for this socket.
void	setTcpNoDelay(int id, boolean on) Set the TCP_NODELAY option for this socket.
long	write(int id, memptr buffer, long pos, long len) Java implementation for the WRITE() SOCKET method, this will write data from the specified buffer location (position and number of bytes) to the socket.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

modToken

private static java.lang.Object modToken

Token used to authenticate with the dispatcher when registering APIs.

local

private static ContextLocal<LowLevelSocketImpl.WorkArea> local

The context-local data of this class.

Constructor Detail

LowLevelSocketImpl

LowLevelSocketImpl(boolean local)

Create an instance and export its API to the network.

Parameters:

local - true to register purely on a local basis (no remote/network access to these methods).

Method Detail

setNoHostVerify

public static void setNoHostVerify(boolean noHostVerify)

Sets value for the -nohostverify CONNECT arg.

Parameters:

noHostVerify - The value for the -nohostverify CONNECT arg

createSslSocket

private static javax.net.ssl.SSLSocket createSslSocket(java.lang.String host,
                                                       int port,
                                                       java.lang.String serverName,
                                                       java.net.InetAddress inetAddress,
                                                       int localPort,
                                                       int timeout,
                                                       boolean nohostverify,
                                                       boolean errManager,
                                                       java.lang.String protocol)
                                                throws java.io.IOException,
                                                       java.lang.SecurityException

Worker for creating a SSL socket and secure it according to specifications.

Documentation states that OpenEdge keeps the public keys (certificates) as individual files in a per-installation store (directory DLC/certs). We use per-client JKS storage facilities in a unified trusted-cert.store in client installation. Certificates need to be imported with java keytool:

    keytool -import -alias a_server -file a_server.cer -keystore trusted-cert.store
 

The location of the store and password for access it can be passed-in at client startup as bootstrap config value with the default value of trusted-cert.store in the current directory. Apparently OpenEdge's mkhashfile utility uses the rehashing function for creating (not so) unique ids for each imported certificate. A similar (if not identical) feature is offered by OpenSSL:

    openssl x509 -in a_server.pem -noout -hash
 

Parameters:

host - The host name/IP to connect to.

port - The port on the host.

serverName - The server name indicator (SNI) set via -servername, for TLS connections.

inetAddress - The local host name/IP to bind the socket to.

localPort - The port on the local machine.

timeout - Socket timeout (in milliseconds), or 0 if it never expires.

nohostverify - If true, disables host verification for connection using HTTPS.

errManager - Instruct how to handle encountered errors. If true ant exception is fed to P2J ErrorManager, otherwise let the caller handle it using normal java exceptions.

protocol - The standard name of the requested protocol as defined by the SSLContext class.

Returns:

The newly build and secured socket.

Throws:

java.io.IOException - If any problems are encountered in the process.

java.lang.SecurityException

registerClientSocket

public static LowLevelSocketImpl.SocketData registerClientSocket(java.net.Socket client,
                                                                 boolean ssl)
                                                          throws java.io.IOException

When the server socket accepts a new connection, this will make sure the new socket is registered and a SocketImpl resource is also created on P2J server side.

Parameters:

client - The client socket.

ssl - Flag indicating if this is a SSL connection.

Returns:

The created SocketImpl instance with the details of the new socket.

Throws:

java.io.IOException - If the socket's input or output streams couldn't be obtained.

locate

private static LowLevelSocketImpl.SocketData locate(int id)

Identify the socket socket data using the given ID.

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

locateSocket

private static java.net.Socket locateSocket(int id)

Identify the associated socket for the given ID.

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

isReady

private static boolean isReady(int id,
                               java.util.concurrent.CountDownLatch ready)

Wait until all socket-related threads are initialized.

Parameters:

id - The socket ID on P2J client side.

ready - The signal to wait on. If null, it returns true.

Returns:

true if all threads are initialized or ready is null; false if someone interrupted the CountDownLatch.await()

connect

public int connect(long resourceId,
                   java.lang.String host,
                   int port,
                   int timeout)
            throws java.io.IOException

Establish a connection to the given host and port.

Specified by:

connect in interface LowLevelSocket

Parameters:

resourceId - The ID of the associated SocketImpl resource on server side.

host - The IP address or name of the target host.

port - The port number.

timeout - connect timeout

Returns:

The ID of the associated socket, if the connection was established.

Throws:

java.io.IOException - In case of errors while establishing the connection.

connectSSL

public int connectSSL(long resourceId,
                      java.lang.String host,
                      int port,
                      java.lang.String serverName,
                      boolean nosessionreuse,
                      boolean nohostverify,
                      java.lang.String protocol,
                      int timeout)
               throws java.io.IOException,
                      java.security.GeneralSecurityException

Establish a SSL connection to the given host and port.

Specified by:

connectSSL in interface LowLevelSocket

Parameters:

resourceId - The ID of the associated SocketImpl resource on server side.

host - The IP address or name of the target host.

port - The port number.

serverName - The server name indicator (SNI) set via -servername, for TLS connections.

nosessionreuse - Flag indicating that the ssl session ID must not be reused.

nohostverify - Flag indicating that the target host name must not be validated against the certificate's principal name.

protocol - The standard name of the requested protocol as defined by the SSLContext class.

timeout - connect timeout

Returns:

The ID of the associated socket, if the connection was established.

Throws:

java.io.IOException - In case of errors while establishing the connection.

java.security.GeneralSecurityException - In case of errors while establishing the SSL connection.

isConnected

public boolean isConnected(int id)

Check if the java socket is still connected.

Specified by:

isConnected in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

true if the java socket is still connected.

disconnect

public boolean disconnect(int id)

Disconnect this socket.

Specified by:

disconnect in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

true if no errors were encountered during disconnect.

getBytesAvailable

public long getBytesAvailable(int id)

Get the available bytes to be read.

Specified by:

getBytesAvailable in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

read

public long read(int id,
                 memptr buffer,
                 long pos,
                 long len,
                 int mode)
          throws java.io.IOException

Java implementation for the READ() SOCKET method, this will read the specified number of bytes from the available data on the socket, and put it inside the memory buffer argument at the specified position.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

During READ processing, the read listener will be blocked from raising new READ-RESPONSE events.

Specified by:

read in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

buffer - The memory buffer where read() puts the data.

pos - The position in the memory buffer where the data is added.

len - The number of bytes to read from the socket.

mode - The mode to set for the reading operation.

Returns:

The number of read bytes. 0 means a timeout during read, -1 meas the stream reached EOF (socket closed).

Throws:

java.io.IOException - In case IO errors were encountered during read.

write

public long write(int id,
                  memptr buffer,
                  long pos,
                  long len)
           throws java.io.IOException

Java implementation for the WRITE() SOCKET method, this will write data from the specified buffer location (position and number of bytes) to the socket.

Specified by:

write in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

buffer - The memory buffer from which the data will be written to the socket.

pos - The position in the memory buffer from where the data to be taken starts.

len - The number of bytes to take from the memory buffer.

Returns:

The number of written bytes.

Throws:

java.io.IOException - In case IO errors were encoubtered during write.

getSslServerName

public java.lang.String getSslServerName(int id)

In case of a SSL connection, get the digital certificate subject name of the server for the current SSL session; else, return null.

Specified by:

getSslServerName in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

getTcpNoDelay

public boolean getTcpNoDelay(int id)
                      throws java.net.SocketException

Get the TCP_NODELAY option value for this socket. See Socket.getTcpNoDelay() for more details.

Specified by:

getTcpNoDelay in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

Throws:

java.net.SocketException - If the socket option could not be interrogated.

getSoLinger

public int getSoLinger(int id)
                throws java.net.SocketException

Get the SO_LINGER option value for this socket. See Socket.getSoLinger() for more details.

Specified by:

getSoLinger in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

Throws:

java.net.SocketException - If the socket option could not be interrogated.

getKeepAlive

public boolean getKeepAlive(int id)
                     throws java.net.SocketException

Get the SO_KEEPALIVE option value for this socket. See Socket.getKeepAlive() for more details.

Specified by:

getKeepAlive in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

Throws:

java.net.SocketException - If the socket option could not be interrogated.

getReuseAddress

public boolean getReuseAddress(int id)
                        throws java.net.SocketException

Get the SO_REUSEADDR option value for this socket. See Socket.getReuseAddress() for more details.

Specified by:

getReuseAddress in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

Throws:

java.net.SocketException - If the socket option could not be interrogated.

getReceiveBufferSize

public int getReceiveBufferSize(int id)
                         throws java.net.SocketException

Get the SO_RCVBUF option value for this socket. See Socket.getReceiveBufferSize() for more details.

Specified by:

getReceiveBufferSize in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

Throws:

java.net.SocketException - If the socket option could not be interrogated.

getSendBufferSize

public int getSendBufferSize(int id)
                      throws java.net.SocketException

Get the SO_SNDBUF option value for this socket. See Socket.getSendBufferSize() for more details.

Specified by:

getSendBufferSize in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

Throws:

java.net.SocketException - If the socket option could not be interrogated.

getSoTimeout

public int getSoTimeout(int id)
                 throws java.net.SocketException

Get the SO_RCVTIMEO option value for this socket. See Socket.getSoTimeout() for more details.

Specified by:

getSoTimeout in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

Throws:

java.net.SocketException - If the socket option could not be interrogated.

setTcpNoDelay

public void setTcpNoDelay(int id,
                          boolean on)
                   throws java.net.SocketException

Set the TCP_NODELAY option for this socket. See Socket.setTcpNoDelay(boolean) for more details.

Specified by:

setTcpNoDelay in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

on - The TCP_NODELAY value.

Throws:

java.net.SocketException - If the socket option could not be set.

setSoLinger

public void setSoLinger(int id,
                        boolean on,
                        int linger)
                 throws java.net.SocketException

Set the SO_LINGER option for this socket. See Socket.setSoLinger(boolean, int) for more details.

Specified by:

setSoLinger in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

on - true to turn on the SO_LINGER option.

linger - The linger time.

Throws:

java.net.SocketException - If the socket option could not be set.

setKeepAlive

public void setKeepAlive(int id,
                         boolean on)
                  throws java.net.SocketException

Set the SO_KEEPALIVE option for this socket. See Socket.setKeepAlive(boolean) for more details.

Specified by:

setKeepAlive in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

on - The SO_KEEPALIVE value.

Throws:

java.net.SocketException - If the socket option could not be set.

setReuseAddress

public void setReuseAddress(int id,
                            boolean on)
                     throws java.net.SocketException

Set the SO_REUSEADDR option for this socket. See Socket.setReuseAddress(boolean) for more details.

Specified by:

setReuseAddress in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

on - The SO_REUSEADDR value.

Throws:

java.net.SocketException - If the socket option could not be set.

setReceiveBufferSize

public void setReceiveBufferSize(int id,
                                 int size)
                          throws java.net.SocketException

Set the SO_RCVBUF value (the receive buffer size) for this socket. See Socket.setReceiveBufferSize(int) for more details.

Specified by:

setReceiveBufferSize in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

size - The SO_RCVBUF value.

Throws:

java.net.SocketException - If the socket option could not be set.

setSendBufferSize

public void setSendBufferSize(int id,
                              int size)
                       throws java.net.SocketException

Set the SO_SNDBUF value (the send buffer size) for this socket. See Socket.setSendBufferSize(int) for more details.

Specified by:

setSendBufferSize in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

size - The SO_SNDBUF value.

Throws:

java.net.SocketException - If the socket option could not be set.

setSoTimeout

public void setSoTimeout(int id,
                         int timeout)
                  throws java.net.SocketException

Set the SO_RCVTIMEO value (the number of seconds the socket waits to receive data before timing out) for this socket. See Socket.setSoTimeout(int) for more details.

Specified by:

setSoTimeout in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

timeout - The SO_RCVTIMEO value.

Throws:

java.net.SocketException - If the socket option could not be set.

getLocalHost

public java.lang.String getLocalHost(int id)

Get the IP address of this side of this connection.

Specified by:

getLocalHost in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

getLocalPort

public int getLocalPort(int id)

Get the port number of this side of this connection.

Specified by:

getLocalPort in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

getRemoteHost

public java.lang.String getRemoteHost(int id)

Get the host IP address of the remote side of this connection.

Specified by:

getRemoteHost in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.

getRemotePort

public int getRemotePort(int id)

Get the port number of the remote side of this connection.

Specified by:

getRemotePort in interface LowLevelSocket

Parameters:

id - The ID of the associated socket on P2J Client side.

Returns:

See above.