com.prosysopc.ua.server

Class ServiceHandler

java.lang.Object

com.prosysopc.ua.server.ServiceHandler

Direct Known Subclasses:

AttributeServiceHandler, NodeManagementServiceHandler, SessionServiceHandler, SubscriptionServiceHandler

public abstract class ServiceHandler
extends Object

A base class for ServiceHandler implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String[]	stringTable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceHandler(SessionManager sessionManager)
	ServiceHandler(SessionManager sessionManager, NodeManagerTable nodeManagerTable) Create a new ServiceManager attached to a serviceContext manager

Method Summary

Modifier and Type	Method and Description
protected void	checkRequestLength(Object[] requestObjects, int maxOperations)
protected ServiceContext	createServiceContext(RequestHeader requestHeader, ServiceRequest<?> serviceRequest) Create the serviceContext object used to identify the session and other parameters of a service call.
protected void	fireRequestResponse(ServiceRequest request, ServiceResponse response, ServiceContext serviceContext) This method should be called every time a response has been handled.
protected EncoderContext	getEncoderContext()
protected org.slf4j.Logger	getLogger()
static int	getMaxOperationsPerRequest() The maximum number of operations allowed per service request.
UaNode	getNode(NodeId nodeId) Find the Node for nodeId.
NodeManagerTable	getNodeManagerTable()
protected OperationLimitsTypeNode	getOperationLimits()
UaServer	getServer()
SessionManager	getSessionManager()
protected void	handleServiceResultException(ServiceResponse response, ServiceException e) Handle the ServiceException by converting it to the ServiceResult in the response.
boolean	hasNode(NodeId nodeId)
protected static List<Locale>	localizationHintsForServiceContext(ServiceContext serviceContext)
static void	setMaxOperationsPerRequest(int maxOperationsPerRequest) Define the maximum number of operations allowed per service request.
void	setRequestListener(RequestListener listener) Sets the Request Listener.
void	setRequestResponseListener(RequestResponseListener listener) Sets the Request-Response Listener.
protected static ExtensionObject	toExtensionObject(ServiceContext serviceContext, Structure data, QualifiedName dataEncoding, EncoderContext encoderContext)
static DiagnosticInfo[]	validateOperationalDiagnostics(ServiceRequest request, DiagnosticInfo[] diagnosticInfos)
protected ServiceContext	validateRequest(EndpointServiceRequest<?,?> endpointRequest) If the given EndpointServiceRequest is an instance of UaLoopbackClient.InternalEndpointServiceRequest (i.e.
protected ServiceContext	validateRequest(ServiceRequest request, ServerSecureChannel serverSecureChannel)
protected void	validateResponse(ServiceRequest request, ServiceResponse response, ServiceContext serviceContext) Validates the service response by setting the timestamp to current.
protected DiagnosticInfo[]	validateResponse(ServiceRequest request, ServiceResponse response, ServiceContext serviceContext, DiagnosticInfo[] operationalDiagnosticInfos)
protected DiagnosticInfo	validateServiceDiagnostics(ServiceRequest request, DiagnosticInfo diagnosticInfo)

Methods inherited from class java.lang.Object

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

Field Detail

stringTable

protected static final String[] stringTable

Constructor Detail

ServiceHandler

public ServiceHandler(SessionManager sessionManager,
                      NodeManagerTable nodeManagerTable)

Create a new ServiceManager attached to a serviceContext manager

Parameters:

sessionManager -

nodeManagerTable -

ServiceHandler

protected ServiceHandler(SessionManager sessionManager)

Method Detail

getMaxOperationsPerRequest

public static int getMaxOperationsPerRequest()

The maximum number of operations allowed per service request. This is a general safety limit for all service calls. If the client exceeds this limit, a ServiceException with StatusCodes.Bad_TooManyOperations is thrown.

Returns:

the maxOperationsPerRequest

setMaxOperationsPerRequest

public static void setMaxOperationsPerRequest(int maxOperationsPerRequest)

Define the maximum number of operations allowed per service request. This is a general safety limit for all service calls. If the client exceeds this limit, a ServiceException with StatusCodes.Bad_TooManyOperations is thrown.

Default: 10000

Parameters:

maxOperationsPerRequest - the maxOperationsPerRequest to set. If 0 or negative, no limit is used.

validateOperationalDiagnostics

public static DiagnosticInfo[] validateOperationalDiagnostics(ServiceRequest request,
                                                              DiagnosticInfo[] diagnosticInfos)

Parameters:

request -

diagnosticInfos -

Returns:

localizationHintsForServiceContext

protected static List<Locale> localizationHintsForServiceContext(ServiceContext serviceContext)

toExtensionObject

protected static ExtensionObject toExtensionObject(ServiceContext serviceContext,
                                                   Structure data,
                                                   QualifiedName dataEncoding,
                                                   EncoderContext encoderContext)
                                            throws ServiceException

Parameters:

data -

dataEncoding -

Returns:

Throws:

ServiceException

getNode

public final UaNode getNode(NodeId nodeId)
                     throws StatusException

Find the Node for nodeId. This is a final method. Override findNode, which is called by this method

Parameters:

nodeId - The ID of the node to look for.

Returns:

The node

Throws:

StatusException - Bad_NodeIdInvalid, if the nodeId is null. Bad_NodeIdUnknown, if the node is not found

getNodeManagerTable

public NodeManagerTable getNodeManagerTable()

Returns:

the nodeManagerTable

getServer

public UaServer getServer()

getSessionManager

public SessionManager getSessionManager()

Returns:

the sessionManager

hasNode

public boolean hasNode(NodeId nodeId)

setRequestListener

public void setRequestListener(RequestListener listener)

Sets the Request Listener. Called for every request, after internal initial validation has passed.

See RequestListener for more info.

setRequestResponseListener

public void setRequestResponseListener(RequestResponseListener listener)

Sets the Request-Response Listener. Use this only in case you want to log every Request-Response pair which the server receives and responses. Usually used only for debugging purposes.

See RequestResponseListener for more info.

checkRequestLength

protected void checkRequestLength(Object[] requestObjects,
                                  int maxOperations)
                           throws ServiceException

Throws:

ServiceException

createServiceContext

protected ServiceContext createServiceContext(RequestHeader requestHeader,
                                              ServiceRequest<?> serviceRequest)
                                       throws ServiceException

Create the serviceContext object used to identify the session and other parameters of a service call. In most cases, this is based on the RequestHeader.getAuthenticationToken(). Note that when the ServiceRequest is CreateSessionRequest, this method returns a ServiceContext whose Session is null, as the Session doesn't exist until the request is handled.

Parameters:

requestHeader - The session token used to identity the session during communications

serviceRequest - The service request from which the requestHeader is

Returns:

The serviceContext

Throws:

ServiceException - If the serviceContext is not found, StatusCode = Bad_SessionIdInvalid

fireRequestResponse

protected void fireRequestResponse(ServiceRequest request,
                                   ServiceResponse response,
                                   ServiceContext serviceContext)

This method should be called every time a response has been handled.

Parameters:

request - The Request from client

response - The Response to the request from server

serviceContext -

getEncoderContext

protected EncoderContext getEncoderContext()

getLogger

protected org.slf4j.Logger getLogger()

getOperationLimits

protected OperationLimitsTypeNode getOperationLimits()

Returns:

handleServiceResultException

protected void handleServiceResultException(ServiceResponse response,
                                            ServiceException e)

Handle the ServiceException by converting it to the ServiceResult in the response. Also set ServiceDiagnostics from the exception.

Parameters:

response - The response message to set

e - The exception info

validateRequest

protected ServiceContext validateRequest(EndpointServiceRequest<?,?> endpointRequest)
                                  throws ServiceException

If the given EndpointServiceRequest is an instance of UaLoopbackClient.InternalEndpointServiceRequest (i.e. it originates from the UaLoopbackClient), returns ServiceContext.INTERNAL_OPERATION_CONTEXT, otherwise the return is based from validateRequest(ServiceRequest, ServerSecureChannel) called with (EndpointServiceRequest.getRequest() and EndpointServiceRequest.getChannel()).

Throws:

ServiceException

validateRequest

protected ServiceContext validateRequest(ServiceRequest request,
                                         ServerSecureChannel serverSecureChannel)
                                  throws ServiceException

Parameters:

request - the request message

serverSecureChannel -

Returns:

Throws:

ServiceException

validateResponse

protected void validateResponse(ServiceRequest request,
                                ServiceResponse response,
                                ServiceContext serviceContext)

Validates the service response by setting the timestamp to current.

Parameters:

response - the response to validate - it must not be null

serviceContext -

validateResponse

protected DiagnosticInfo[] validateResponse(ServiceRequest request,
                                            ServiceResponse response,
                                            ServiceContext serviceContext,
                                            DiagnosticInfo[] operationalDiagnosticInfos)

Parameters:

request -

response -

serviceContext -

operationalDiagnosticInfos -

Returns:

validateServiceDiagnostics

protected DiagnosticInfo validateServiceDiagnostics(ServiceRequest request,
                                                    DiagnosticInfo diagnosticInfo)

Parameters:

request -

diagnosticInfo -

Returns: