com.prosysopc.ua.server

Class NodeManagementServiceHandler

java.lang.Object

com.prosysopc.ua.server.ServiceHandler

com.prosysopc.ua.server.NodeManagementServiceHandler

public class NodeManagementServiceHandler
extends ServiceHandler

A base implementation of NodeManagementServiceSetHandler.

This base class adds a small layer of abstraction by handling the OPC UA request messages and dispatched responses. It delegates the operation to virtual methods, which by default only return "Not implemented" service results.

You can normally use the standard implementation, NodeManagerUaNode, which provides a basic implementation of actual node management.

If you wish to create a completely customized node manager, you can override this class and override the public methods that you wish to implement.

Field Summary

Fields inherited from class com.prosysopc.ua.server.ServiceHandler

stringTable

Constructor Summary

Constructors

Constructor and Description
NodeManagementServiceHandler(SessionManager sessionManager, NodeManagerTable nodeManagerTable) Create the NodeManagementServiceSetHandler.

Method Summary

Modifier and Type	Method and Description
protected NodeId	addNode(ServiceContext serviceContext, AddNodesItem nodeToAdd)
protected void	addNodes(ServiceContext serviceContext, AddNodesRequest request, AddNodesResponse response)
protected void	addReference(ServiceContext serviceContext, AddReferencesItem addReferencesItem)
protected void	addReferences(ServiceContext serviceContext, AddReferencesRequest request, AddReferencesResponse response)
protected void	browse(ServiceContext serviceContext, BrowseRequest request, BrowseResponse response)
protected void	browseNext(ServiceContext serviceContext, BrowseNextRequest request, BrowseNextResponse response)
protected BrowseContinuationPoint	browseNode(ServiceContext serviceContext, List<ReferenceDescription> referenceDescriptions, NodeId nodeId, int maxReferences, BrowseDirection browseDirection, NodeId referenceTypeId, Boolean includeSubTypes, EnumSet<NodeClass> nodeClassSet, EnumSet<BrowseResultMask> resultSet, ViewDescription view, int startIndex) Get an array of Reference Descriptions for the node.
protected void	call(ServiceContext serviceContext, CallRequest request, CallResponse response)
protected Variant[]	callMethod(ServiceContext serviceContext, NodeId objectId, NodeId methodId, Variant[] inputArguments, StatusCode[] inputArgumentResults, DiagnosticInfo[] inputArgumentDiagnosticInfos)
protected void	deleteNode(ServiceContext serviceContext, DeleteNodesItem deleteNodesItem)
protected void	deleteNodes(ServiceContext serviceContext, DeleteNodesRequest request, DeleteNodesResponse response)
protected void	deleteReference(ServiceContext serviceContext, DeleteReferencesItem deleteReferencesItem)
protected void	deleteReferences(ServiceContext serviceContext, DeleteReferencesRequest request, DeleteReferencesResponse response)
protected org.slf4j.Logger	getLogger()
int	getMaxNodesPerBrowse()
int	getMaxNodesPerMethodCall()
int	getMaxNodesPerNodeManagement()
int	getMaxNodesPerRegisterNodes()
int	getMaxNodesPerTranslateBrowsePathsToNodeIds()
int	getMaxReferencesPerNode() The maximum number of references to return per node, before returning a continuation point.
protected UaView	getView(NodeId viewId, UnsignedInteger viewVersion, DateTime timestamp) Return the View object corresponding to the viewId.
protected void	init()
void	onAddNodes(EndpointServiceRequest<AddNodesRequest,AddNodesResponse> req)
void	onAddReferences(EndpointServiceRequest<AddReferencesRequest,AddReferencesResponse> req)
void	onBrowse(EndpointServiceRequest<BrowseRequest,BrowseResponse> req)
void	onBrowseNext(EndpointServiceRequest<BrowseNextRequest,BrowseNextResponse> req)
void	onCall(EndpointServiceRequest<CallRequest,CallResponse> req)
void	onDeleteNodes(EndpointServiceRequest<DeleteNodesRequest,DeleteNodesResponse> req)
void	onDeleteReferences(EndpointServiceRequest<DeleteReferencesRequest,DeleteReferencesResponse> req)
void	onQueryFirst(EndpointServiceRequest<QueryFirstRequest,QueryFirstResponse> req)
void	onQueryNext(EndpointServiceRequest<QueryNextRequest,QueryNextResponse> req)
void	onRegisterNodes(EndpointServiceRequest<RegisterNodesRequest,RegisterNodesResponse> req)
void	onTranslateBrowsePathsToNodeIds(EndpointServiceRequest<TranslateBrowsePathsToNodeIdsRequest,TranslateBrowsePathsToNodeIdsResponse> req)
void	onUnregisterNodes(EndpointServiceRequest<UnregisterNodesRequest,UnregisterNodesResponse> req)
protected void	queryFirst(ServiceContext serviceContext, QueryFirstRequest request, QueryFirstResponse response)
protected void	queryNext(ServiceContext serviceContext, QueryNextRequest request, QueryNextResponse response)
protected NodeId	registerNode(ServiceContext serviceContext, NodeId nodeId)
protected void	registerNodes(ServiceContext serviceContext, RegisterNodesRequest request, RegisterNodesResponse response)
void	setMaxNodesPerBrowse(int maxNodesPerBrowse) Safety limit for the maximum request size for browse.
void	setMaxNodesPerMethodCall(int maxNodesPerMethodCall) Safety limit for the maximum request size for method calls.
void	setMaxNodesPerNodeManagement(int maxNodesPerNodeManagement) Safety limit for the maximum request size for node management operations.
void	setMaxNodesPerRegisterNodes(int maxNodesPerRegisterNodes) Safety limit for the maximum request size for registering/unregistering nodes.
void	setMaxNodesPerTranslateBrowsePathsToNodeIds(int maxNodesPerTranslateBrowsePathsToNodeIds) Safety limit for the maximum request size for TranslateBrowsePathToNodeIds.
void	setMaxReferencesPerNode(int maxReferencesPerNode) Define the maximum number of references to return per node, before returning a continuation point.
void	start()
protected BrowsePathTarget[]	translateBrowsePath(ServiceContext serviceContext, NodeId startingNode, RelativePath relativePath)
protected void	translateBrowsePathsToNodeIds(ServiceContext serviceContext, TranslateBrowsePathsToNodeIdsRequest request, TranslateBrowsePathsToNodeIdsResponse response)
protected void	unregisterNode(ServiceContext serviceContext, NodeId nodeId)
protected void	unregisterNodes(ServiceContext serviceContext, UnregisterNodesRequest request, UnregisterNodesResponse response)

Methods inherited from class com.prosysopc.ua.server.ServiceHandler

checkRequestLength, createServiceContext, fireRequestResponse, getEncoderContext, getMaxOperationsPerRequest, getNode, getNodeManagerTable, getOperationLimits, getServer, getSessionManager, handleServiceResultException, hasNode, localizationHintsForServiceContext, setMaxOperationsPerRequest, setRequestResponseListener, toExtensionObject, validateEncoding, validateEncoding, validateOperationalDiagnostics, validateRequest, validateRequest, validateResponse, validateResponse, validateServiceDiagnostics

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeManagementServiceHandler

public NodeManagementServiceHandler(SessionManager sessionManager,
                                    NodeManagerTable nodeManagerTable)

Create the NodeManagementServiceSetHandler.

Parameters:

sessionManager - The serviceContext manager that handles the sessions

getNodeManagerTable - ()

rootManager - The root node manager that handles the OPCUA namespace

Method Detail

getMaxNodesPerBrowse

public int getMaxNodesPerBrowse()

Returns:

the maxNodesPerBrowse

See Also:

setMaxNodesPerBrowse(int), getMaxNodesPerBrowse()

getMaxNodesPerMethodCall

public int getMaxNodesPerMethodCall()

Returns:

the maxNodesPerMethodCall

See Also:

setMaxNodesPerMethodCall(int)

getMaxNodesPerNodeManagement

public int getMaxNodesPerNodeManagement()

Returns:

the maxNodesPerNodeManagement

See Also:

setMaxNodesPerNodeManagement(int)

getMaxNodesPerRegisterNodes

public int getMaxNodesPerRegisterNodes()

Returns:

the maxNodesPerRegisterNodes

See Also:

setMaxNodesPerRegisterNodes(int)

getMaxNodesPerTranslateBrowsePathsToNodeIds

public int getMaxNodesPerTranslateBrowsePathsToNodeIds()

Returns:

the maxNodesPerTranslateBrowsePathsToNodeIds

See Also:

setMaxNodesPerTranslateBrowsePathsToNodeIds(int)

getMaxReferencesPerNode

public int getMaxReferencesPerNode()

The maximum number of references to return per node, before returning a continuation point. This is a safety limit in case the client does not provide any limit of it's own.

Returns:

the maxReferencesPerNode

See Also:

setMaxReferencesPerNode(int), getMaxNodesPerBrowse()

onAddNodes

public final void onAddNodes(EndpointServiceRequest<AddNodesRequest,AddNodesResponse> req)
                      throws ServiceFaultException

Throws:

ServiceFaultException

onAddReferences

public final void onAddReferences(EndpointServiceRequest<AddReferencesRequest,AddReferencesResponse> req)
                           throws ServiceFaultException

Throws:

ServiceFaultException

onBrowse

public final void onBrowse(EndpointServiceRequest<BrowseRequest,BrowseResponse> req)
                    throws ServiceFaultException

Throws:

ServiceFaultException

onBrowseNext

public final void onBrowseNext(EndpointServiceRequest<BrowseNextRequest,BrowseNextResponse> req)
                        throws ServiceFaultException

Throws:

ServiceFaultException

onCall

public final void onCall(EndpointServiceRequest<CallRequest,CallResponse> req)
                  throws ServiceFaultException

Throws:

ServiceFaultException

onDeleteNodes

public final void onDeleteNodes(EndpointServiceRequest<DeleteNodesRequest,DeleteNodesResponse> req)
                         throws ServiceFaultException

Throws:

ServiceFaultException

onDeleteReferences

public final void onDeleteReferences(EndpointServiceRequest<DeleteReferencesRequest,DeleteReferencesResponse> req)
                              throws ServiceFaultException

Throws:

ServiceFaultException

onQueryFirst

public final void onQueryFirst(EndpointServiceRequest<QueryFirstRequest,QueryFirstResponse> req)
                        throws ServiceFaultException

Throws:

ServiceFaultException

onQueryNext

public final void onQueryNext(EndpointServiceRequest<QueryNextRequest,QueryNextResponse> req)
                       throws ServiceFaultException

Throws:

ServiceFaultException

onRegisterNodes

public final void onRegisterNodes(EndpointServiceRequest<RegisterNodesRequest,RegisterNodesResponse> req)
                           throws ServiceFaultException

Throws:

ServiceFaultException

onTranslateBrowsePathsToNodeIds

public final void onTranslateBrowsePathsToNodeIds(EndpointServiceRequest<TranslateBrowsePathsToNodeIdsRequest,TranslateBrowsePathsToNodeIdsResponse> req)
                                           throws ServiceFaultException

Throws:

ServiceFaultException

onUnregisterNodes

public final void onUnregisterNodes(EndpointServiceRequest<UnregisterNodesRequest,UnregisterNodesResponse> req)
                             throws ServiceFaultException

Throws:

ServiceFaultException

setMaxNodesPerBrowse

public void setMaxNodesPerBrowse(int maxNodesPerBrowse)

Safety limit for the maximum request size for browse. Limits the number of nodes that can be requested in one call.

If the value is 0 or negative, the limit is not used. In this case, the ServiceHandler#setMaxOperationsPerRequest() is used to limit the request size.

The value is reflected to ServerCapabilities/OperationLimits.

Parameters:

maxNodesPerBrowse - the maxNodesPerBrowse to set

See Also:

setMaxReferencesPerNode(int)

setMaxNodesPerMethodCall

public void setMaxNodesPerMethodCall(int maxNodesPerMethodCall)

Safety limit for the maximum request size for method calls. Limits the number of nodes that can be requested in one call.

If the value is 0 or negative, the limit is not used. In this case, the ServiceHandler#setMaxOperationsPerRequest() is used to limit the request size.

The value is reflected to ServerCapabilities/OperationLimits.

Parameters:

maxNodesPerMethodCall - the maxNodesPerMethodCall to set

setMaxNodesPerNodeManagement

public void setMaxNodesPerNodeManagement(int maxNodesPerNodeManagement)

Safety limit for the maximum request size for node management operations. Limits the number of nodes that can be requested in one call.

If the value is 0 or negative, the limit is not used. In this case, the ServiceHandler#setMaxOperationsPerRequest() is used to limit the request size.

The value is reflected to ServerCapabilities/OperationLimits.

Parameters:

maxNodesPerNodeManagement - the maxNodesPerNodeManagement to set

setMaxNodesPerRegisterNodes

public void setMaxNodesPerRegisterNodes(int maxNodesPerRegisterNodes)

Safety limit for the maximum request size for registering/unregistering nodes. Limits the number of nodes that can be requested in one call.

If the value is 0 or negative, the limit is not used. In this case, the ServiceHandler#setMaxOperationsPerRequest() is used to limit the request size.

The value is reflected to ServerCapabilities/OperationLimits.

Parameters:

maxNodesPerRegisterNodes - the maxNodesPerRegisterNodes to set

setMaxNodesPerTranslateBrowsePathsToNodeIds

public void setMaxNodesPerTranslateBrowsePathsToNodeIds(int maxNodesPerTranslateBrowsePathsToNodeIds)

Safety limit for the maximum request size for TranslateBrowsePathToNodeIds. Limits the number of nodes that can be requested in one call.

If the value is 0 or negative, the limit is not used. In this case, the ServiceHandler#setMaxOperationsPerRequest() is used to limit the request size.

The value is reflected to ServerCapabilities/OperationLimits.

Parameters:

maxNodesPerTranslateBrowsePathsToNodeIds - the maxNodesPerTranslateBrowsePathsToNodeIds to set

setMaxReferencesPerNode

public void setMaxReferencesPerNode(int maxReferencesPerNode)

Define the maximum number of references to return per node, before returning a continuation point. This is a safety limit in case the client does not provide any limit of it's own.

Default: 10000

Parameters:

maxReferencesPerNode - the maxReferencesPerNode to set

start

public void start()
           throws StatusException,
                  UaNodeFactoryException

Throws:

StatusException

UaNodeFactoryException

addNode

protected NodeId addNode(ServiceContext serviceContext,
                         AddNodesItem nodeToAdd)
                  throws StatusException,
                         ServiceException,
                         UaNodeFactoryException

Throws:

StatusException

ServiceException

UaNodeFactoryException

addNodes

protected void addNodes(ServiceContext serviceContext,
                        AddNodesRequest request,
                        AddNodesResponse response)
                 throws ServiceException

Parameters:

serviceContext -

request -

response -

Throws:

ServiceException

addReference

protected void addReference(ServiceContext serviceContext,
                            AddReferencesItem addReferencesItem)
                     throws StatusException,
                            ServiceException

Parameters:

serviceContext -

addReferencesItem -

Throws:

ServiceException

StatusException

addReferences

protected void addReferences(ServiceContext serviceContext,
                             AddReferencesRequest request,
                             AddReferencesResponse response)
                      throws ServiceException

Parameters:

serviceContext -

request -

response -

Throws:

ServiceException

browse

protected void browse(ServiceContext serviceContext,
                      BrowseRequest request,
                      BrowseResponse response)
               throws ServiceException

Parameters:

serviceContext -

viewDescription -

browseDescriptions -

maxReferencesPerNodeToReturn -

d -

Throws:

ServiceException

browseNext

protected void browseNext(ServiceContext serviceContext,
                          BrowseNextRequest request,
                          BrowseNextResponse response)
                   throws ServiceException

Parameters:

serviceContext -

request -

response -

Throws:

ServiceException

browseNode

protected BrowseContinuationPoint browseNode(ServiceContext serviceContext,
                                             List<ReferenceDescription> referenceDescriptions,
                                             NodeId nodeId,
                                             int maxReferences,
                                             BrowseDirection browseDirection,
                                             NodeId referenceTypeId,
                                             Boolean includeSubTypes,
                                             EnumSet<NodeClass> nodeClassSet,
                                             EnumSet<BrowseResultMask> resultSet,
                                             ViewDescription view,
                                             int startIndex)
                                      throws ServiceException,
                                             StatusException

Get an array of Reference Descriptions for the node.

Parameters:

serviceContext - The serviceContext under which the operation is performed.

nodeId -

maxReferences -

resultSet -

nodeClassSet -

includeSubTypes -

referenceTypeId -

browseDirection -

view -

startIndex -

Returns:

Throws:

ServiceException

StatusException

call

protected void call(ServiceContext serviceContext,
                    CallRequest request,
                    CallResponse response)
             throws ServiceException

Parameters:

serviceContext -

request -

response -

Throws:

ServiceException

callMethod

protected Variant[] callMethod(ServiceContext serviceContext,
                               NodeId objectId,
                               NodeId methodId,
                               Variant[] inputArguments,
                               StatusCode[] inputArgumentResults,
                               DiagnosticInfo[] inputArgumentDiagnosticInfos)
                        throws StatusException

Parameters:

serviceContext -

objectId -

methodId -

inputArguments -

inputArgumentDiagnosticInfos -

inputArgumentResults -

Returns:

Throws:

StatusException

deleteNode

protected void deleteNode(ServiceContext serviceContext,
                          DeleteNodesItem deleteNodesItem)
                   throws StatusException

Parameters:

serviceContext -

deleteNodesItem -

Throws:

StatusException

deleteNodes

protected void deleteNodes(ServiceContext serviceContext,
                           DeleteNodesRequest request,
                           DeleteNodesResponse response)
                    throws ServiceException

Parameters:

serviceContext -

request -

response -

Throws:

ServiceException

deleteReference

protected void deleteReference(ServiceContext serviceContext,
                               DeleteReferencesItem deleteReferencesItem)
                        throws StatusException

Parameters:

serviceContext -

deleteReferencesItem -

Throws:

StatusException

deleteReferences

protected void deleteReferences(ServiceContext serviceContext,
                                DeleteReferencesRequest request,
                                DeleteReferencesResponse response)
                         throws ServiceException

Parameters:

serviceContext -

request -

response -

Throws:

ServiceException

getLogger

protected org.slf4j.Logger getLogger()

Overrides:

getLogger in class ServiceHandler

Returns:

the logger

getView

protected UaView getView(NodeId viewId,
                         UnsignedInteger viewVersion,
                         DateTime timestamp)
                  throws ServiceException

Return the View object corresponding to the viewId.

Override the method in your own implementation to support custom views.

Parameters:

viewId - The NodeId of the requested view. This is never Null - in such cases the method is not even called.

timestamp - timestamp of the view

viewVersion - version of the view

Returns:

The view or null, if the view nodes are not used

Throws:

ServiceException - StatusCodes.Bad_ViewIdUnknown if the defined view does not exist; Bad_ViewVersionInvalid if the version is not valid

init

protected void init()
             throws StatusException,
                    UaNodeFactoryException

Throws:

UaNodeFactoryException

StatusException

queryFirst

protected void queryFirst(ServiceContext serviceContext,
                          QueryFirstRequest request,
                          QueryFirstResponse response)
                   throws ServiceException

Parameters:

serviceContext -

request -

response -

Throws:

ServiceException

queryNext

protected void queryNext(ServiceContext serviceContext,
                         QueryNextRequest request,
                         QueryNextResponse response)
                  throws ServiceException

Parameters:

serviceContext -

request -

response -

Throws:

ServiceException

registerNode

protected NodeId registerNode(ServiceContext serviceContext,
                              NodeId nodeId)
                       throws StatusException

Parameters:

serviceContext -

nodeId -

Returns:

Throws:

StatusException

registerNodes

protected void registerNodes(ServiceContext serviceContext,
                             RegisterNodesRequest request,
                             RegisterNodesResponse response)
                      throws ServiceException

Parameters:

serviceContext -

request -

response -

Throws:

ServiceException

translateBrowsePath

protected BrowsePathTarget[] translateBrowsePath(ServiceContext serviceContext,
                                                 NodeId startingNode,
                                                 RelativePath relativePath)
                                          throws StatusException

Parameters:

serviceContext -

startingNode -

relativePath -

Returns:

Throws:

StatusException

translateBrowsePathsToNodeIds

protected void translateBrowsePathsToNodeIds(ServiceContext serviceContext,
                                             TranslateBrowsePathsToNodeIdsRequest request,
                                             TranslateBrowsePathsToNodeIdsResponse response)
                                      throws ServiceException

Parameters:

serviceContext -

request -

response -

Throws:

ServiceException

unregisterNode

protected void unregisterNode(ServiceContext serviceContext,
                              NodeId nodeId)
                       throws StatusException

Parameters:

serviceContext -

nodeId -

Throws:

StatusException

unregisterNodes

protected void unregisterNodes(ServiceContext serviceContext,
                               UnregisterNodesRequest request,
                               UnregisterNodesResponse response)
                        throws ServiceException

Parameters:

nodeIds -

Throws:

ServiceException