com.prosysopc.ua.stack.transport

Interface ServerSecureChannel

All Known Implementing Classes:

AbstractServerSecureChannel, HttpsServerSecureChannel, OpcTcpServerSecureChannel

public interface ServerSecureChannel

Server side Secure channel.

Method Summary

Modifier and Type	Method and Description
void	close() Close the secure channel.
AsyncResult<ServerSecureChannel>	closeAsync() Close the secure channel.
void	dispose() Close and dispose.
ServerConnection	getConnection() Get current socket connection if applicable for the binding type.
String	getConnectURL() Return the URL of the connection.
Endpoint	getEndpoint() Get endpoint
KeyPair	getLocalCertificate() Get Local Application Instance Certificate
MessageSecurityMode	getMessageSecurityMode() Get message security mode.
void	getPendingServiceRequests(Collection<EndpointServiceRequest<?,?>> result) Get all unanswered service requests.
Cert	getRemoteCertificate() Get Remote Application Instance Certificate
int	getSecureChannelId() Get secure channel ID
SecurityPolicy	getSecurityPolicy() Get security policy
Server	getServer() Get Server
boolean	isOpen() Is the secure channel open.
boolean	needsCertificate()

Method Detail

close

void close()

Close the secure channel. This method does nothing if the channel is already closed or has never been opened.

This method sends CloseSecureChannelRequest to the server and closes the socket connection. If sending of the message fails and thus the servers never receives notification about closed secure channel, then there is no resend attempt, instead the secure channel will eventually time out in the server.

All pending requests will fault with Bad_SecureChannelClosed

closeAsync

AsyncResult<ServerSecureChannel> closeAsync()

Close the secure channel. This method does nothing if the channel is already closed or has never been opened.

This method sends CloseSecureChannelRequest to the server and closes the socket connection. If sending of the message fails and thus the servers never receives notification about closed secure channel, then there is no resend attempt, instead the secure channel will eventually time out in the server.

All pending requests will fault with Bad_SecureChannelClosed

Returns:

asynchronous monitor object

dispose

void dispose()

Close and dispose. The object becomes unusuable.

getConnection

ServerConnection getConnection()

Get current socket connection if applicable for the binding type.

Returns:

connection or null

getConnectURL

String getConnectURL()

Return the URL of the connection. This value is only available when the channel is in Open or Closing state, if not the return value is null.

Returns:

connect URL or null

getEndpoint

Endpoint getEndpoint()

Get endpoint

Returns:

Endpoint

getLocalCertificate

KeyPair getLocalCertificate()

Get Local Application Instance Certificate

Returns:

Local Application Instance Certificate

getMessageSecurityMode

MessageSecurityMode getMessageSecurityMode()

Get message security mode.

Returns:

security mode or null

getPendingServiceRequests

void getPendingServiceRequests(Collection<EndpointServiceRequest<?,?>> result)

Get all unanswered service requests.

Parameters:

result - container to fill with unanswered service requests

getRemoteCertificate

Cert getRemoteCertificate()

Get Remote Application Instance Certificate

Returns:

Remote Application Instance Certificate

getSecureChannelId

int getSecureChannelId()

Get secure channel ID

Returns:

secure channel id

getSecurityPolicy

SecurityPolicy getSecurityPolicy()

Get security policy

Returns:

security policy or null if channel has not been initialized

getServer

Server getServer()

Get Server

Returns:

server

isOpen

boolean isOpen()

Is the secure channel open.

Returns:

true if the channel is open

needsCertificate

boolean needsCertificate()