com.inductiveautomation.opcua.subscriptions

Interface SubscriptionServiceProvider

All Superinterfaces:

PublishRequestConsumer

All Known Subinterfaces:

Subscription

public interface SubscriptionServiceProvider
extends PublishRequestConsumer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SubscriptionServiceProvider.SetTriggeringResult

Method Summary

Modifier and Type	Method and Description
void	modify(ModifySubscriptionRequest request) Modifies this Subscription to reflect the parameters in the given ModifySubscriptionRequest.
java.util.List<StatusCode>	modifyMonitoringMode(java.util.List<UInt32> monitoredItemIds, MonitoringMode monitoringMode) Changes the MonitoringMode for the given list of IMonitoredItem id's.
NotificationMessage	republish(RepublishRequest request) Requests a NotificationMessage with sequence number specified in the RepublishRequest from the retransmission queue so it can be republished.
void	setPublishingEnabled(boolean publishingEnabled) Turns publishing on or off for this Subscription.
SubscriptionServiceProvider.SetTriggeringResult	setTriggering(UInt32 triggeringItemId, java.util.List<UInt32> linksToAdd, java.util.List<UInt32> linksToRemove) Create and/or delete triggering links for a triggering IMonitoredItem.

Methods inherited from interface com.inductiveautomation.opcua.subscriptions.PublishRequestConsumer

acknowledge, consume

Method Detail

setPublishingEnabled

void setPublishingEnabled(boolean publishingEnabled)

Turns publishing on or off for this Subscription.

Parameters:

publishingEnabled - true to turn publishing on, false to turn it off.

modify

void modify(ModifySubscriptionRequest request)

Modifies this Subscription to reflect the parameters in the given ModifySubscriptionRequest.

Parameters:

request - The ModifySubscriptionRequest containing new parameters for this Subscription.

republish

NotificationMessage republish(RepublishRequest request)

Requests a NotificationMessage with sequence number specified in the RepublishRequest from the retransmission queue so it can be republished. A null return value indicates that the requested message is no longer available.

Parameters:

request - A RepublishRequest containing a sequence number identifying the NotificationMessage requested.

Returns:

The NotificationMessage requested in the RepublishRequest.

modifyMonitoringMode

java.util.List<StatusCode> modifyMonitoringMode(java.util.List<UInt32> monitoredItemIds,
                                                MonitoringMode monitoringMode)

Changes the MonitoringMode for the given list of IMonitoredItem id's.

Parameters:

monitoredItemIds - List of IMonitoredItem id's to change the MonitoringMode of.

monitoringMode - The new MonitoringMode.

Returns:

setTriggering

SubscriptionServiceProvider.SetTriggeringResult setTriggering(UInt32 triggeringItemId,
                                                              java.util.List<UInt32> linksToAdd,
                                                              java.util.List<UInt32> linksToRemove)
                                                       throws UAException

Create and/or delete triggering links for a triggering IMonitoredItem.

Parameters:

triggeringItemId - The triggering item.

linksToAdd - The server ids of items that will be added as triggering links.

linksToRemove - The server ids of items that will be removed as triggering links.

Throws:

UAException - A UAException ontaining a Bad_MonitoredItemIdInvalid StatusCode if the IMonitoredItem specified by the triggeringItemId does not exist.