com.prosysopc.ua.server

Class SubscriptionServiceHandler

java.lang.Object

com.prosysopc.ua.server.ServiceHandler

com.prosysopc.ua.server.SubscriptionServiceHandler

public class SubscriptionServiceHandler
extends ServiceHandler

A base implementation of SubscriptionServiceSetHandler.

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, SubscriptionManager , which provides a basic implementation of actual node management.

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

Field Summary

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

stringTable

Constructor Summary

Constructors

Constructor and Description
SubscriptionServiceHandler(SubscriptionManager subscriptionManager)

Method Summary

Modifier and Type	Method and Description
protected void	createMonitoredItems(ServiceContext serviceContext, CreateMonitoredItemsRequest request, CreateMonitoredItemsResponse response)
protected void	createSubscription(ServiceContext serviceContext, CreateSubscriptionRequest request, CreateSubscriptionResponse response)
protected void	deleteMonitoredItems(ServiceContext serviceContext, DeleteMonitoredItemsRequest request, DeleteMonitoredItemsResponse response)
protected void	deleteSubscriptions(ServiceContext serviceContext, DeleteSubscriptionsRequest request, DeleteSubscriptionsResponse response)
protected org.slf4j.Logger	getLogger()
int	getMaxMonitoredItemsPerCall()
protected void	modifyMonitoredItems(ServiceContext serviceContext, ModifyMonitoredItemsRequest request, ModifyMonitoredItemsResponse response)
protected void	modifySubscription(ServiceContext serviceContext, ModifySubscriptionRequest request, ModifySubscriptionResponse response)
void	onCreateMonitoredItems(EndpointServiceRequest<CreateMonitoredItemsRequest,CreateMonitoredItemsResponse> req)
void	onCreateSubscription(EndpointServiceRequest<CreateSubscriptionRequest,CreateSubscriptionResponse> req)
void	onDeleteMonitoredItems(EndpointServiceRequest<DeleteMonitoredItemsRequest,DeleteMonitoredItemsResponse> req)
void	onDeleteSubscriptions(EndpointServiceRequest<DeleteSubscriptionsRequest,DeleteSubscriptionsResponse> req)
void	onModifyMonitoredItems(EndpointServiceRequest<ModifyMonitoredItemsRequest,ModifyMonitoredItemsResponse> req)
void	onModifySubscription(EndpointServiceRequest<ModifySubscriptionRequest,ModifySubscriptionResponse> req)
void	onPublish(EndpointServiceRequest<PublishRequest,PublishResponse> req)
void	onRepublish(EndpointServiceRequest<RepublishRequest,RepublishResponse> req)
void	onSetMonitoringMode(EndpointServiceRequest<SetMonitoringModeRequest,SetMonitoringModeResponse> req)
void	onSetPublishingMode(EndpointServiceRequest<SetPublishingModeRequest,SetPublishingModeResponse> req)
void	onSetTriggering(EndpointServiceRequest<SetTriggeringRequest,SetTriggeringResponse> req)
void	onTransferSubscriptions(EndpointServiceRequest<TransferSubscriptionsRequest,TransferSubscriptionsResponse> req)
void	setMaxMonitoredItemsPerCall(int maxMonitoredItemsPerCall) Safety limit for the maximum request size for monitored item related requests.
protected void	setMonitoringMode(ServiceContext serviceContext, SetMonitoringModeRequest request, SetMonitoringModeResponse response)
protected void	setPublishingMode(ServiceContext serviceContext, SetPublishingModeRequest request, SetPublishingModeResponse response)
protected void	transferSubscriptions(ServiceContext serviceContext, TransferSubscriptionsRequest request, TransferSubscriptionsResponse 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

SubscriptionServiceHandler

public SubscriptionServiceHandler(SubscriptionManager subscriptionManager)

Parameters:

subscriptionManager -

Method Detail

getMaxMonitoredItemsPerCall

public int getMaxMonitoredItemsPerCall()

Returns:

the maxMonitoredItemsPerCall

See Also:

setMaxMonitoredItemsPerCall(int)

onCreateMonitoredItems

public final void onCreateMonitoredItems(EndpointServiceRequest<CreateMonitoredItemsRequest,CreateMonitoredItemsResponse> req)
                                  throws ServiceFaultException

Throws:

ServiceFaultException

onCreateSubscription

public final void onCreateSubscription(EndpointServiceRequest<CreateSubscriptionRequest,CreateSubscriptionResponse> req)
                                throws ServiceFaultException

Throws:

ServiceFaultException

onDeleteMonitoredItems

public final void onDeleteMonitoredItems(EndpointServiceRequest<DeleteMonitoredItemsRequest,DeleteMonitoredItemsResponse> req)
                                  throws ServiceFaultException

Throws:

ServiceFaultException

onDeleteSubscriptions

public final void onDeleteSubscriptions(EndpointServiceRequest<DeleteSubscriptionsRequest,DeleteSubscriptionsResponse> req)
                                 throws ServiceFaultException

Throws:

ServiceFaultException

onModifyMonitoredItems

public final void onModifyMonitoredItems(EndpointServiceRequest<ModifyMonitoredItemsRequest,ModifyMonitoredItemsResponse> req)
                                  throws ServiceFaultException

Throws:

ServiceFaultException

onModifySubscription

public final void onModifySubscription(EndpointServiceRequest<ModifySubscriptionRequest,ModifySubscriptionResponse> req)
                                throws ServiceFaultException

Throws:

ServiceFaultException

onPublish

public final void onPublish(EndpointServiceRequest<PublishRequest,PublishResponse> req)
                     throws ServiceFaultException

Throws:

ServiceFaultException

onRepublish

public final void onRepublish(EndpointServiceRequest<RepublishRequest,RepublishResponse> req)
                       throws ServiceFaultException

Throws:

ServiceFaultException

onSetMonitoringMode

public final void onSetMonitoringMode(EndpointServiceRequest<SetMonitoringModeRequest,SetMonitoringModeResponse> req)
                               throws ServiceFaultException

Throws:

ServiceFaultException

onSetPublishingMode

public final void onSetPublishingMode(EndpointServiceRequest<SetPublishingModeRequest,SetPublishingModeResponse> req)
                               throws ServiceFaultException

Throws:

ServiceFaultException

onSetTriggering

public final void onSetTriggering(EndpointServiceRequest<SetTriggeringRequest,SetTriggeringResponse> req)
                           throws ServiceFaultException

Throws:

ServiceFaultException

onTransferSubscriptions

public final void onTransferSubscriptions(EndpointServiceRequest<TransferSubscriptionsRequest,TransferSubscriptionsResponse> req)
                                   throws ServiceFaultException

Throws:

ServiceFaultException

setMaxMonitoredItemsPerCall

public void setMaxMonitoredItemsPerCall(int maxMonitoredItemsPerCall)

Safety limit for the maximum request size for monitored item related requests. 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:

maxMonitoredItemsPerCall - the maxMonitoredItemsPerCall to set

createMonitoredItems

protected void createMonitoredItems(ServiceContext serviceContext,
                                    CreateMonitoredItemsRequest request,
                                    CreateMonitoredItemsResponse response)
                             throws ServiceException

Throws:

ServiceException

createSubscription

protected void createSubscription(ServiceContext serviceContext,
                                  CreateSubscriptionRequest request,
                                  CreateSubscriptionResponse response)
                           throws ServiceException

Throws:

ServiceException

deleteMonitoredItems

protected void deleteMonitoredItems(ServiceContext serviceContext,
                                    DeleteMonitoredItemsRequest request,
                                    DeleteMonitoredItemsResponse response)
                             throws ServiceException

Throws:

ServiceException

deleteSubscriptions

protected void deleteSubscriptions(ServiceContext serviceContext,
                                   DeleteSubscriptionsRequest request,
                                   DeleteSubscriptionsResponse response)
                            throws ServiceException

Throws:

ServiceException

getLogger

protected org.slf4j.Logger getLogger()

Overrides:

getLogger in class ServiceHandler

Returns:

the logger

modifyMonitoredItems

protected void modifyMonitoredItems(ServiceContext serviceContext,
                                    ModifyMonitoredItemsRequest request,
                                    ModifyMonitoredItemsResponse response)
                             throws ServiceException

Throws:

ServiceException

modifySubscription

protected void modifySubscription(ServiceContext serviceContext,
                                  ModifySubscriptionRequest request,
                                  ModifySubscriptionResponse response)
                           throws ServiceException

Throws:

ServiceException

setMonitoringMode

protected void setMonitoringMode(ServiceContext serviceContext,
                                 SetMonitoringModeRequest request,
                                 SetMonitoringModeResponse response)
                          throws ServiceException

Throws:

ServiceException

setPublishingMode

protected void setPublishingMode(ServiceContext serviceContext,
                                 SetPublishingModeRequest request,
                                 SetPublishingModeResponse response)
                          throws ServiceException

Throws:

ServiceException

transferSubscriptions

protected void transferSubscriptions(ServiceContext serviceContext,
                                     TransferSubscriptionsRequest request,
                                     TransferSubscriptionsResponse response)
                              throws ServiceException

Throws:

ServiceException