com.prosysopc.ua.stack.transport.tcp.nio

Class OpcTcpServerConnection

java.lang.Object

com.prosysopc.ua.stack.utils.AbstractState<CloseableObjectState,ServiceResultException>

com.prosysopc.ua.stack.transport.tcp.nio.AbstractServerConnection

com.prosysopc.ua.stack.transport.tcp.nio.OpcTcpServerConnection

All Implemented Interfaces:

CloseableObject, ServerConnection, IStatefulObject<CloseableObjectState,ServiceResultException>

public class OpcTcpServerConnection
extends AbstractServerConnection

OpcTcpServerConnection class.

Author:

jaro

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.stack.transport.ServerConnection

ServerConnection.SecureChannelListener

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(IConnectionListener listener) Add response listener
protected void	cancelTimeoutTimer() cancelTimeoutTimer.
CloseableObject	close() close.
protected BufferMonitorState	flush(long position) flush.
static long	getHandshakeTimeout() Getter for the field handshakeTimeout.
SocketAddress	getLocalAddress() Get local socket address
SocketAddress	getRemoteAddress() Get remote socket address
protected CertificateValidator	getRemoteCertificateValidator() Remote Certificate Validator, invoked upon connect
protected void	handleAcknowledgeMessage(Acknowledge a) handleAcknowledgeMessage.
protected void	handleAsymmChunk(ByteBuffer chunk) handleAsymmChunk.
protected void	handleChunk(ByteBuffer chunk) handleChunk.
protected void	handleCloseChunk(ByteBuffer chunk) handleCloseChunk.
protected void	handleCloseSecureChannelRequest(InputMessage mb) handleCloseSecureChannelRequest.
protected void	handleErrorMessage(ErrorMessage e) handleErrorMessage.
protected void	handleHelloMessage(Hello h) handleHelloMessage.
protected void	handleOpenSecureChannelRequest(InputMessage mb) handleOpenSecureChannelRequest.
protected void	handleRawChunk(ByteBuffer chunk) handleRawChunk.
protected void	handleSecureMessage(InputMessage mb) handleSecureMessage.
protected void	handleSymmChunk(ByteBuffer chunk) handleSymmChunk.
boolean	hasActiveSession() Returns true if this connection has Session that is Activated and not timed out (nor closed).
void	init() Start listening for data from the connection, note that data might be processed already before this method returns.
boolean	isPurgeEligible() Returns true if this connection is eligble to be purged if we approach max number of connections, false if this connection is valid and should not be purged.
boolean	isReverse() Return true if this connection is a reverse connection i.e.
protected void	onStateTransition(CloseableObjectState oldState, CloseableObjectState newState) Override this.
void	removeConnectionListener(IConnectionListener listener) Add response listener
protected void	sendAcknowledge(Acknowledge a) sendAcknowledge.
protected int	sendAsymmSecureMessage(AsyncWrite msg, SecurityConfiguration securityConfiguration, int secureChannelId, int requestNumber, AtomicInteger sendSequenceNumber) sendAsymmSecureMessage.
protected void	sendChunks(ByteBuffer... chunks) Send chunks.
protected void	sendError(ErrorMessage e) sendError.
protected void	sendHello(Hello h) sendHello.
protected void	sendReverseHello(ReverseHello rh)
protected void	sendSecureMessage(AsyncWrite msg, SecurityToken token, int requestId, int messageType, AtomicInteger sendSequenceNumber) sendSecureMessage.
void	setActiveSession(boolean hasActiveSession) Set does this connection has active session.
protected void	setError(ServiceResultException e) setError.
static void	setHandshakeTimeout(long handshakeTimeout) Define the handshake timeout for new connections.
protected OpcTcpServerSecureChannel	validateSecureChannelId(int reqSecureChannelId) Throws Bad_SecureChannelIdInvalid if the securechannel is null or doesn't have the given id.

Methods inherited from class com.prosysopc.ua.stack.transport.tcp.nio.AbstractServerConnection

addChannelListener, addSecureChannelListener, fireSecureChannelAttached, fireSecureChannelDetached, getConnectURL, getRemoteCertificate, getSecureChannels, onListenerException, removeChannelListener, removeSecureChannelListener, setError, setError, toString

Methods inherited from class com.prosysopc.ua.stack.utils.AbstractState

addStateListener, addStateNotifiable, attemptSetState, clearError, getError, getState, hasError, isStateTransitionAllowed, removeStateListener, removeStateNotifiable, setState, setState, throwIfError, waitForState, waitForState, waitForStateUninterruptibly

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.prosysopc.ua.stack.utils.IStatefulObject

addStateListener, addStateNotifiable, getError, getState, removeStateListener, removeStateNotifiable, waitForState, waitForState, waitForStateUninterruptibly

Method Detail

getHandshakeTimeout

public static long getHandshakeTimeout()

Getter for the field handshakeTimeout.

Returns:

the handshakeTimeout

setHandshakeTimeout

public static void setHandshakeTimeout(long handshakeTimeout)

Define the handshake timeout for new connections. If the client does not establish a connection during the timeout, the socket is released. A smaller value might be usable to avoid DNS attacks.

Parameters:

handshakeTimeout - the handshakeTimeout to set. Default 600000 = 10 minutes.

addConnectionListener

public void addConnectionListener(IConnectionListener listener)

Add response listener

Specified by:

addConnectionListener in interface ServerConnection

Overrides:

addConnectionListener in class AbstractServerConnection

Parameters:

listener - a IConnectionListener object.

close

public CloseableObject close()

close.

Specified by:

close in interface CloseableObject

Overrides:

close in class AbstractServerConnection

Returns:

a CloseableObject object.

getLocalAddress

public SocketAddress getLocalAddress()

Get local socket address

Returns:

socket address

getRemoteAddress

public SocketAddress getRemoteAddress()

Description copied from interface: ServerConnection

Get remote socket address

Returns:

remote socket address

hasActiveSession

public boolean hasActiveSession()

Returns true if this connection has Session that is Activated and not timed out (nor closed). Returns false in other cases.

init

public void init()

Start listening for data from the connection, note that data might be processed already before this method returns.

isPurgeEligible

public boolean isPurgeEligible()

Returns true if this connection is eligble to be purged if we approach max number of connections, false if this connection is valid and should not be purged. Per 1.05 Part 4 section 5.5.2 "To protect against misbehaving Clientsand denial of service attacks, the Servershall close the oldest unused SecureChannelthat has no Sessionassigned before reaching the maximum number of supported SecureChannels.". However, in addition if the connection was formed via a ReverseHello, it is not considered to be eligible as server was the one initiating the connection. Thus this returns true, if this connection is neither a reverse connection and also has not yet been activated by a Session.

isReverse

public boolean isReverse()

Return true if this connection is a reverse connection i.e. where the server send a ReverseHello to a Client to initiate the connection.

removeConnectionListener

public void removeConnectionListener(IConnectionListener listener)

Description copied from class: AbstractServerConnection

Add response listener

Specified by:

removeConnectionListener in interface ServerConnection

Overrides:

removeConnectionListener in class AbstractServerConnection

Parameters:

listener - a IConnectionListener object.

setActiveSession

public void setActiveSession(boolean hasActiveSession)

Set does this connection has active session. Called internally.

cancelTimeoutTimer

protected void cancelTimeoutTimer()

cancelTimeoutTimer.

flush

protected BufferMonitorState flush(long position)
                            throws InterruptedException,
                                   IOException

flush.

Parameters:

position - a long.

Returns:

a BufferMonitorState object.

Throws:

InterruptedException - if any.

IOException - if any.

getRemoteCertificateValidator

protected CertificateValidator getRemoteCertificateValidator()

Description copied from class: AbstractServerConnection

Remote Certificate Validator, invoked upon connect

Specified by:

getRemoteCertificateValidator in class AbstractServerConnection

Returns:

a CertificateValidator object.

handleAcknowledgeMessage

protected void handleAcknowledgeMessage(Acknowledge a)
                                 throws ServiceResultException

handleAcknowledgeMessage.

Parameters:

a - a Acknowledge object.

Throws:

ServiceResultException - if any.

handleAsymmChunk

protected void handleAsymmChunk(ByteBuffer chunk)
                         throws ServiceResultException

handleAsymmChunk.

Parameters:

chunk - a ByteBuffer object.

Throws:

ServiceResultException - if any.

handleChunk

protected void handleChunk(ByteBuffer chunk)
                    throws ServiceResultException

handleChunk.

Parameters:

chunk - a ByteBuffer object.

Throws:

ServiceResultException - if any.

handleCloseChunk

protected void handleCloseChunk(ByteBuffer chunk)
                         throws ServiceResultException

handleCloseChunk.

Parameters:

chunk - a ByteBuffer object.

Throws:

ServiceResultException - if any.

handleCloseSecureChannelRequest

protected void handleCloseSecureChannelRequest(InputMessage mb)
                                        throws ServiceResultException

handleCloseSecureChannelRequest.

Parameters:

mb - a InputMessage object.

Throws:

ServiceResultException - if any.

handleErrorMessage

protected void handleErrorMessage(ErrorMessage e)

handleErrorMessage.

Parameters:

e - a ErrorMessage object.

handleHelloMessage

protected void handleHelloMessage(Hello h)
                           throws ServiceResultException

handleHelloMessage.

Parameters:

h - a Hello object.

Throws:

ServiceResultException - if any.

handleOpenSecureChannelRequest

protected void handleOpenSecureChannelRequest(InputMessage mb)
                                       throws ServiceResultException

handleOpenSecureChannelRequest.

Parameters:

mb - a InputMessage object.

Throws:

ServiceResultException - if any.

handleRawChunk

protected void handleRawChunk(ByteBuffer chunk)

handleRawChunk.

Parameters:

chunk - a ByteBuffer object.

handleSecureMessage

protected void handleSecureMessage(InputMessage mb)
                            throws ServiceResultException

handleSecureMessage.

Parameters:

mb - a InputMessage object.

Throws:

ServiceResultException - if any.

handleSymmChunk

protected void handleSymmChunk(ByteBuffer chunk)
                        throws ServiceResultException

handleSymmChunk.

Parameters:

chunk - a ByteBuffer object.

Throws:

ServiceResultException - if any.

onStateTransition

protected void onStateTransition(CloseableObjectState oldState,
                                 CloseableObjectState newState)

Override this.

Overrides:

onStateTransition in class AbstractServerConnection

Parameters:

oldState - a StateType object.

newState - a StateType object.

sendAcknowledge

protected void sendAcknowledge(Acknowledge a)
                        throws ServiceResultException

sendAcknowledge.

Parameters:

a - a Acknowledge object.

Throws:

ServiceResultException - if any.

sendAsymmSecureMessage

protected int sendAsymmSecureMessage(AsyncWrite msg,
                                     SecurityConfiguration securityConfiguration,
                                     int secureChannelId,
                                     int requestNumber,
                                     AtomicInteger sendSequenceNumber)
                              throws ServiceResultException

sendAsymmSecureMessage.

Send asymmetric secure message.

Specified by:

sendAsymmSecureMessage in class AbstractServerConnection

Parameters:

msg - a AsyncWrite object.

securityConfiguration - a SecurityConfiguration object.

secureChannelId - a int.

requestNumber - a int.

sendSequenceNumber - a AtomicInteger object.

Returns:

a int.

Throws:

ServiceResultException - if any.

sendChunks

protected void sendChunks(ByteBuffer... chunks)

Send chunks.

Parameters:

chunks - a ByteBuffer object.

sendError

protected void sendError(ErrorMessage e)
                  throws ServiceResultException

sendError.

Parameters:

e - a ErrorMessage object.

Throws:

ServiceResultException - if any.

sendHello

protected void sendHello(Hello h)

sendHello.

Parameters:

h - a Hello object.

sendReverseHello

protected void sendReverseHello(ReverseHello rh)

sendSecureMessage

protected void sendSecureMessage(AsyncWrite msg,
                                 SecurityToken token,
                                 int requestId,
                                 int messageType,
                                 AtomicInteger sendSequenceNumber)

sendSecureMessage.

Send symmetric secure message

Specified by:

sendSecureMessage in class AbstractServerConnection

Parameters:

msg - a AsyncWrite object.

token - a SecurityToken object.

requestId - a int.

messageType - a int.

sendSequenceNumber - a AtomicInteger object.

setError

protected void setError(ServiceResultException e)

Description copied from class: AbstractServerConnection

setError.

Overrides:

setError in class AbstractServerConnection

Parameters:

e - a ServiceResultException object.

validateSecureChannelId

protected OpcTcpServerSecureChannel validateSecureChannelId(int reqSecureChannelId)
                                                     throws ServiceResultException

Throws Bad_SecureChannelIdInvalid if the securechannel is null or doesn't have the given id. Otherwise returns the channel. Preferably every interaction with the securechannel would be done via this method by only interacting with the return value.

Throws:

ServiceResultException