com.prosysopc.ua.server

Class SubscriptionManager

java.lang.Object

com.prosysopc.ua.server.SubscriptionManager

public class SubscriptionManager
extends Object

A standard implementation of the subscription manager of an OPC UA client. The subscription manager requires a NodeManager which it uses to locate the nodes.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<SubscriptionManagerListener>	listeners
protected NodeManagerTable	nodeManagerTable
protected SessionManager	sessionManager

Constructor Summary

Constructors

Constructor and Description
SubscriptionManager(SessionManager sessionManager, NodeManagerTable nodeManagerTable)

Method Summary

Modifier and Type	Method and Description
protected void	acknowledge(ServiceContext serviceContext, PublishRequest request, PublishResponse response)
protected void	acknowledgeSubscriptions(ServiceContext serviceContext, SubscriptionAcknowledgement[] acks, StatusCode[] results, DiagnosticInfo[] diagnostics)
void	addListener(SubscriptionManagerListener listener) Add a new SubscriptionManagerListener.
protected SubscriptionBase	addSubscription(ServiceContext serviceContext, CreateSubscriptionRequest request) Add a new subscription.
protected void	addTriggeringLink(Subscription s, MonitoredItemBase triggeringItem, UnsignedInteger linkToAdd)
protected NumericRange	checkIndexRangeForMonitoredItem(String indexRange, UnsignedInteger attributeId)
protected void	checkSession(ServiceContext serviceContext, Subscription subscription)
protected void	close()
protected MonitoredDataItem	createMonitoredDataItem(ServiceContext serviceContext, Subscription subscription, MonitoredItemCreateRequest itemToCreate, TimestampsToReturn timestampsToReturn, MonitoringFilter filter)
protected MonitoredItem	createMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredItemCreateRequest itemToCreate, EventFilter eventFilter)
protected MonitoredItem	createMonitoredItem(ServiceContext serviceContext, Subscription subscription, TimestampsToReturn timestampsToReturn, MonitoredItemCreateRequest itemToCreate)
protected Subscription	createSubscription(SubscriptionManager subscriptionManager, UnsignedInteger subscriptionId, Boolean publishingEnabled, double revisedPublishingInterval, UnsignedInteger revisedLifetimeCount, UnsignedInteger revisedMaxKeepAliveCount, UnsignedInteger maxNotificationsPerPublish, UnsignedByte priority) This method can be overridden to use subtyped Subscription.
protected MonitoredItemBase	deleteMonitoredItem(ServiceContext serviceContext, Subscription subscription, UnsignedInteger itemId)
int	getMaxMonitoredItemsPerSubscription() Returns maximum number of MonitoredItems allowed in a Subscription.
int	getMaxNotificationsPerPublish() The limit for the maximum number of notifications parameter which is defined per subscription.
double	getMaxPublishingInterval()
int	getMaxPublishRequestCount()
int	getMaxRetransmissionQueueSize() The maximum number of notification messages to keep in the retransmit queue, which is used to enable Republish calls from the client.
double	getMaxSamplingInterval()
int	getMaxSubscriptionCount() Maximum number of concurrent subscriptions per session.
double	getMinPublishingInterval()
double	getMinSamplingInterval()
UnsignedInteger	getNextSubscriptionId() Returns the SubscriptionId to be used when Clients make Subscriptions.
protected Subscription	getNextSubscriptionToPublish(ServiceContext serviceContext, long timeoutHint) Find the next subscription from the publish queue
NodeManagerTable	getNodeManagerTable()
protected BlockingQueue<SubscriptionBase>	getPublishQueue(Session session)
SessionManager	getSessionManager()
Subscription	getSubscription(UnsignedInteger subscriptionId) Find the subscription by a subscriptionId
int	getSubscriptionCount() Number of managed subscriptions.
Collection<Subscription>	getSubscriptions() Get the current Subscription(s) in the server.
boolean	hasListener(SubscriptionManagerListener listener) Check if the manager already has the specified listener.
boolean	isImmediatePublishing() Whether immediate publishing is enabled.
boolean	isRunning()
boolean	isTrackModelChanges() See setTrackModelChanges(boolean).
protected MonitoredItem	modifyMonitoredItem(ServiceContext serviceContext, Subscription subscription, MonitoredItemModifyRequest request, TimestampsToReturn timestampsToReturn, MonitoringParameters params)
protected SubscriptionBase	modifySubscription(ServiceContext serviceContext, ModifySubscriptionRequest request)
protected UnsignedInteger	nextSubscriptionId() Find the next Subscription ID.
protected void	publish(ServiceContext serviceContext, PublishRequest request, PublishResponse response)
void	removeListener(SubscriptionManagerListener listener) Remove a SubscriptionManagerListener.
protected void	removeSubscription(ServiceContext serviceContext, Subscription subscription, boolean removeFromQueue)
protected void	removeTriggeringLink(SubscriptionBase s, MonitoredItemBase triggeringItem, UnsignedInteger linkToRemove)
protected void	republish(ServiceContext serviceContext, RepublishRequest request, RepublishResponse response)
void	setImmediatePublishing(boolean immediatePublishEnabled) Enable immediate publishing.
void	setMaxMonitoredItemsPerSubscription(int maxMonitoredItemsPerSubscription)
void	setMaxNotificationsPerPublish(int maxNotificationsPerPublish) Define the limit for MaxNotificationsPerPublish that the clients may define for each subscription.
void	setMaxPublishingInterval(double maxPublishingInterval) Define the maximum value for PublishingInterval of any subscription.
void	setMaxPublishRequestCount(int maxPublishRequestCount) Define the maximum number of PublishRequests to accept from the client at a time.
void	setMaxRetransmissionQueueSize(int maxRetransmissionQueueSize) Define the maximum number of notification messages to keep in the retransmit queue, which is used to enable Republish calls from the client.
void	setMaxSamplingInterval(double maxSamplingInterval) Define the maximum value for SamplingInterval of any MonitoredItem.
void	setMaxSubscriptionCount(int maxSubscriptionCount) Define the maximum number of Subscriptions to enable per session.
void	setMinPublishingInterval(double minPublishingInterval) Define the minimum value for PublishingInterval of any subscription.
void	setMinSamplingInterval(double minSamplingInterval) Define the minimum value for SamplingInterval of any MonitoredItem.
protected void	setMonitoringMode(ServiceContext serviceContext, Subscription subscription, UnsignedInteger monitoredItemId, MonitoringMode mode)
void	setNextSubscriptionId(UnsignedInteger subscriptionId) Set the next SubscriptionId to be used when Clients make Subscriptions.
protected void	setPublishingMode(ServiceContext serviceContext, UnsignedInteger subscriptionId, Boolean publishingEnabled)
void	setTrackModelChanges(boolean trackModelChanges) If set to true (by default false), MonitoredItems will work even if an UaNode is deleted and another UaNode then later added with the same NodeId.
protected void	setTriggering(ServiceContext serviceContext, SetTriggeringRequest request, SetTriggeringResponse response)
protected void	start() Starts the manager.
protected Subscription	transferSubscription(ServiceContext serviceContext, UnsignedInteger subscriptionId, boolean sendInitialValues) Handle TransferSubscriptions call.

Methods inherited from class java.lang.Object

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

Field Detail

listeners

protected final List<SubscriptionManagerListener> listeners

nodeManagerTable

protected final NodeManagerTable nodeManagerTable

sessionManager

protected final SessionManager sessionManager

Constructor Detail

SubscriptionManager

public SubscriptionManager(SessionManager sessionManager,
                           NodeManagerTable nodeManagerTable)

Parameters:

sessionManager -

nodeManagerTable -

Method Detail

addListener

public void addListener(SubscriptionManagerListener listener)

Add a new SubscriptionManagerListener.

Parameters:

listener - the listener to add. Must not be null

getMaxMonitoredItemsPerSubscription

public int getMaxMonitoredItemsPerSubscription()

Returns maximum number of MonitoredItems allowed in a Subscription. Default is 1000.

See Also:

setMaxMonitoredItemsPerSubscription(int)

getMaxNotificationsPerPublish

public int getMaxNotificationsPerPublish()

The limit for the maximum number of notifications parameter which is defined per subscription. If the parameter is 0, then no limit is defined and the values defined by clients are used for each subscription.

If this value is defined, the client requested values are modified down to this value, if they would exceed it.

Default: 50000

Returns:

the maximum number of notifications in a single publish message

See Also:

setMaxNotificationsPerPublish(int)

getMaxPublishingInterval

public double getMaxPublishingInterval()

Returns:

the maxPublishingInterval

See Also:

setMaxPublishingInterval(double)

getMaxPublishRequestCount

public int getMaxPublishRequestCount()

Returns:

the maxPublishRequestCount

getMaxRetransmissionQueueSize

public int getMaxRetransmissionQueueSize()

The maximum number of notification messages to keep in the retransmit queue, which is used to enable Republish calls from the client.

Returns:

the maxRetransmissionQueueSize

getMaxSamplingInterval

public double getMaxSamplingInterval()

Returns:

the maxSamplingInterval

See Also:

setMaxSamplingInterval(double)

getMaxSubscriptionCount

public int getMaxSubscriptionCount()

Maximum number of concurrent subscriptions per session. Default: Integer.MAX_VALUE

Returns:

the current value

getMinPublishingInterval

public double getMinPublishingInterval()

Returns:

See Also:

setMinPublishingInterval(double)

getMinSamplingInterval

public double getMinSamplingInterval()

Returns:

the minSamplingInterval

See Also:

setMinSamplingInterval(double)

getNextSubscriptionId

public UnsignedInteger getNextSubscriptionId()

Returns the SubscriptionId to be used when Clients make Subscriptions. This value is incremented internally for each Subscription. This can be used after UaServer.shutdown(int, String) and persisted (outside SDK's scope) and set again via setNextSubscriptionId(UnsignedInteger) after the application has been restarted to have a continuous range of SubscriptionIds after a restart.

The default value is Instant.getEpochSecond() from Java Epoch converted to UnsignedInteger, wrapping back to 1 on UnsignedInteger range overflow.

getNodeManagerTable

public NodeManagerTable getNodeManagerTable()

Returns:

the node manager table

getSessionManager

public SessionManager getSessionManager()

Returns:

the sessionManager

getSubscription

public Subscription getSubscription(UnsignedInteger subscriptionId)
                             throws ServiceException

Find the subscription by a subscriptionId

Parameters:

subscriptionId - the ID

Returns:

the subscription

Throws:

StatusException - if no subscription is found

ServiceException

getSubscriptionCount

public int getSubscriptionCount()

Number of managed subscriptions.

getSubscriptions

public Collection<Subscription> getSubscriptions()

Get the current Subscription(s) in the server. The returned collection is a snapshot and unmodifiable, i.e. it doesn't contain any newly added Subscriptions after the call is made. If you wish to observe additions/removals, use addListener(SubscriptionManagerListener) first, and then call this to get the existing subscriptions.

hasListener

public boolean hasListener(SubscriptionManagerListener listener)

Check if the manager already has the specified listener.

Parameters:

listener - the listener to check

listener -

Returns:

true if the listener is already defined for the manager

isImmediatePublishing

public boolean isImmediatePublishing()

Whether immediate publishing is enabled.

When enabled, changes in monitored items result into immediate publish notification, if the previous notification was sent longer than PublishInterval ago.

See Also:

setImmediatePublishing(boolean)

isRunning

public boolean isRunning()

Returns:

true after the manager is running - when the server is running.

isTrackModelChanges

public boolean isTrackModelChanges()

See setTrackModelChanges(boolean).

removeListener

public void removeListener(SubscriptionManagerListener listener)

Remove a SubscriptionManagerListener.

Parameters:

listener -

setImmediatePublishing

public void setImmediatePublishing(boolean immediatePublishEnabled)

Enable immediate publishing.

When enabled, changes in monitored items result into immediate publish notification, if the previous notification was sent longer than PublishInterval ago.

If this setting is enabled, the server will try to dispatch the first notifications as soon as possible. On the other hand, it may be useful to keep this disabled, if your server is generating bursts of value changes every now and then, since the ImmedieatPublish will result into the burst to be broken to two separate notifications that are sent one PublishingInterval apart.

If the ImmediatePublish is disabled, the subscriptions are checked with a fixed PublishingInterval cycle.

Default: false

setMaxMonitoredItemsPerSubscription

public void setMaxMonitoredItemsPerSubscription(int maxMonitoredItemsPerSubscription)

See Also:

getMaxMonitoredItemsPerSubscription()

setMaxNotificationsPerPublish

public void setMaxNotificationsPerPublish(int maxNotificationsPerPublish)

Define the limit for MaxNotificationsPerPublish that the clients may define for each subscription.

Default: 50000

Parameters:

maxNotificationsPerPublish -

See Also:

getMaxNotificationsPerPublish()

setMaxPublishingInterval

public void setMaxPublishingInterval(double maxPublishingInterval)

Define the maximum value for PublishingInterval of any subscription. If the requested value exceeds this, it is revised to this value.

Default: 3600000

Parameters:

maxPublishingInterval - the maxPublishingInterval to set (in milliseconds)

setMaxPublishRequestCount

public void setMaxPublishRequestCount(int maxPublishRequestCount)

Define the maximum number of PublishRequests to accept from the client at a time. If the client sends more PublishRequests to the queue, the server will respond with a Bad_TooManyPublishRequests error.

The value defines the maximum per client session.

Parameters:

maxPublishRequestCount - the new limit. Default is 100. Use 0 to set the default value.

setMaxRetransmissionQueueSize

public void setMaxRetransmissionQueueSize(int maxRetransmissionQueueSize)

Define the maximum number of notification messages to keep in the retransmit queue, which is used to enable Republish calls from the client.

Parameters:

maxRetransmissionQueueSize - the new size (default is 10)

setMaxSamplingInterval

public void setMaxSamplingInterval(double maxSamplingInterval)

Define the maximum value for SamplingInterval of any MonitoredItem. If the requested value exceeds this, it is revised to this value.

Default: 3600000

Parameters:

maxSamplingInterval - the maxSamplingInterval to set (in milliseconds)

setMaxSubscriptionCount

public void setMaxSubscriptionCount(int maxSubscriptionCount)

Define the maximum number of Subscriptions to enable per session.

Parameters:

maxSubscriptionCount - the maxSubscriptionCount to set. Default is INTEGER.MAX_VALUE

setMinPublishingInterval

public void setMinPublishingInterval(double minPublishingInterval)

Define the minimum value for PublishingInterval of any subscription. If the requested value exceeds this, it is revised to this value.

Default: 100

Parameters:

minPublishingInterval - the minPublishingInterval to set (in milliseconds). The value must be greater than 0.

setMinSamplingInterval

public void setMinSamplingInterval(double minSamplingInterval)

Define the minimum value for SamplingInterval of any MonitoredItem. If the requested value exceeds this, it is revised to this value.

Default: 1

Parameters:

minSamplingInterval - the minSamplingInterval to set. (in milliseconds)

setNextSubscriptionId

public void setNextSubscriptionId(UnsignedInteger subscriptionId)

Set the next SubscriptionId to be used when Clients make Subscriptions. This value is incremented for each Subscription made (wrapping back to 1 after UnsignedInteger.MAX_VALUE). Note that this should not be called while the server is running. Please see getNextSubscriptionId().

Parameters:

subscriptionId - the subscriptionId for the next subscription, this is incremented for each subscription. If null or 0 is given, 1 is used instead.

setTrackModelChanges

public void setTrackModelChanges(boolean trackModelChanges)

If set to true (by default false), MonitoredItems will work even if an UaNode is deleted and another UaNode then later added with the same NodeId. If enabled may cause a performance issues on any node additions or removals depending on the number of MonitoredItems. For MonitoredDataItems this will also cause a StatusCodes.Bad_NodeIdUnknown sent when a node is removed.

acknowledge

protected void acknowledge(ServiceContext serviceContext,
                           PublishRequest request,
                           PublishResponse response)

acknowledgeSubscriptions

protected void acknowledgeSubscriptions(ServiceContext serviceContext,
                                        SubscriptionAcknowledgement[] acks,
                                        StatusCode[] results,
                                        DiagnosticInfo[] diagnostics)

addSubscription

protected SubscriptionBase addSubscription(ServiceContext serviceContext,
                                           CreateSubscriptionRequest request)
                                    throws ServiceException

Add a new subscription.

Parameters:

serviceContext -

request -

Returns:

Throws:

ServiceException

addTriggeringLink

protected void addTriggeringLink(Subscription s,
                                 MonitoredItemBase triggeringItem,
                                 UnsignedInteger linkToAdd)
                          throws StatusException

Parameters:

s -

triggeringItem -

unsignedInteger -

Throws:

StatusException

checkIndexRangeForMonitoredItem

protected NumericRange checkIndexRangeForMonitoredItem(String indexRange,
                                                       UnsignedInteger attributeId)
                                                throws ServiceException

Parameters:

indexRange -

attributeId -

Returns:

Throws:

ServiceResultException

ServiceException

checkSession

protected void checkSession(ServiceContext serviceContext,
                            Subscription subscription)
                     throws ServiceException

Parameters:

serviceContext -

subscription -

Throws:

ServiceException

close

protected void close()

createMonitoredDataItem

protected MonitoredDataItem createMonitoredDataItem(ServiceContext serviceContext,
                                                    Subscription subscription,
                                                    MonitoredItemCreateRequest itemToCreate,
                                                    TimestampsToReturn timestampsToReturn,
                                                    MonitoringFilter filter)
                                             throws ServiceException,
                                                    StatusException

Parameters:

serviceContext -

subscription -

itemToCreate -

timestampsToReturn -

filter -

Throws:

StatusException

ServiceException

createMonitoredEventItem

protected MonitoredItem createMonitoredEventItem(ServiceContext serviceContext,
                                                 Subscription subscription,
                                                 MonitoredItemCreateRequest itemToCreate,
                                                 EventFilter eventFilter)
                                          throws StatusException

Parameters:

serviceContext -

subscription -

itemToCreate -

eventFilter -

Returns:

Throws:

StatusException

createMonitoredItem

protected MonitoredItem createMonitoredItem(ServiceContext serviceContext,
                                            Subscription subscription,
                                            TimestampsToReturn timestampsToReturn,
                                            MonitoredItemCreateRequest itemToCreate)
                                     throws StatusException,
                                            ServiceException

Parameters:

serviceContext -

subscription -

timestampsToReturn -

itemToCreate -

Returns:

Throws:

StatusException

ServiceException

createSubscription

protected Subscription createSubscription(SubscriptionManager subscriptionManager,
                                          UnsignedInteger subscriptionId,
                                          Boolean publishingEnabled,
                                          double revisedPublishingInterval,
                                          UnsignedInteger revisedLifetimeCount,
                                          UnsignedInteger revisedMaxKeepAliveCount,
                                          UnsignedInteger maxNotificationsPerPublish,
                                          UnsignedByte priority)

This method can be overridden to use subtyped Subscription.

deleteMonitoredItem

protected MonitoredItemBase deleteMonitoredItem(ServiceContext serviceContext,
                                                Subscription subscription,
                                                UnsignedInteger itemId)
                                         throws StatusException

Parameters:

serviceContext -

subscription -

itemId -

Throws:

StatusException

getNextSubscriptionToPublish

protected Subscription getNextSubscriptionToPublish(ServiceContext serviceContext,
                                                    long timeoutHint)
                                             throws ServiceException

Find the next subscription from the publish queue

Parameters:

serviceContext -

timeoutHint -

Returns:

Throws:

ServiceException

getPublishQueue

protected BlockingQueue<SubscriptionBase> getPublishQueue(Session session)

Parameters:

session -

Returns:

modifyMonitoredItem

protected MonitoredItem modifyMonitoredItem(ServiceContext serviceContext,
                                            Subscription subscription,
                                            MonitoredItemModifyRequest request,
                                            TimestampsToReturn timestampsToReturn,
                                            MonitoringParameters params)
                                     throws StatusException

Parameters:

serviceContext -

subscription -

request -

timestampsToReturn -

params -

Returns:

Throws:

StatusException

modifySubscription

protected SubscriptionBase modifySubscription(ServiceContext serviceContext,
                                              ModifySubscriptionRequest request)
                                       throws ServiceException

Parameters:

serviceContext -

request -

Returns:

Throws:

ServiceException

StatusException

nextSubscriptionId

protected UnsignedInteger nextSubscriptionId()

Find the next Subscription ID. The IDs start from 1 and they are reset whenever the application(or SubscriptionManager) is restarted.

publish

protected void publish(ServiceContext serviceContext,
                       PublishRequest request,
                       PublishResponse response)
                throws ServiceException

Throws:

ServiceException

removeSubscription

protected void removeSubscription(ServiceContext serviceContext,
                                  Subscription subscription,
                                  boolean removeFromQueue)
                           throws ServiceException

Parameters:

serviceContext -

subscription -

Throws:

ServiceException

removeTriggeringLink

protected void removeTriggeringLink(SubscriptionBase s,
                                    MonitoredItemBase triggeringItem,
                                    UnsignedInteger linkToRemove)
                             throws StatusException

Parameters:

s -

triggeringItem -

unsignedInteger -

Throws:

StatusException

republish

protected void republish(ServiceContext serviceContext,
                         RepublishRequest request,
                         RepublishResponse response)
                  throws ServiceException

Throws:

ServiceException

setMonitoringMode

protected void setMonitoringMode(ServiceContext serviceContext,
                                 Subscription subscription,
                                 UnsignedInteger monitoredItemId,
                                 MonitoringMode mode)
                          throws ServiceException,
                                 StatusException

Parameters:

serviceContext -

subscription -

monitoredItemId -

Throws:

StatusException

ServiceException

setPublishingMode

protected void setPublishingMode(ServiceContext serviceContext,
                                 UnsignedInteger subscriptionId,
                                 Boolean publishingEnabled)
                          throws ServiceException,
                                 StatusException

Parameters:

serviceContext -

subscriptionId -

publishingEnabled -

Throws:

ServiceException

StatusException

setTriggering

protected void setTriggering(ServiceContext serviceContext,
                             SetTriggeringRequest request,
                             SetTriggeringResponse response)
                      throws ServiceException

Throws:

ServiceException

start

protected void start()

Starts the manager.

transferSubscription

protected Subscription transferSubscription(ServiceContext serviceContext,
                                            UnsignedInteger subscriptionId,
                                            boolean sendInitialValues)
                                     throws ServiceException

Handle TransferSubscriptions call.

Throws:

ServiceException - on error