org.eclipse.milo.opcua.sdk.server.api

Class SimpleAddressSpaceFilter

java.lang.Object

org.eclipse.milo.opcua.sdk.server.api.SimpleAddressSpaceFilter

All Implemented Interfaces:

AddressSpaceFilter

public abstract class SimpleAddressSpaceFilter
extends Object
implements AddressSpaceFilter

A simple AddressSpaceFilter that delegates each of the filter operations to a simple filter on NodeId using the most reasonable NodeId from that operation's request as the filter criteria.

Constructor Summary

Constructors

Constructor and Description
SimpleAddressSpaceFilter()

Method Summary

Modifier and Type	Method and Description
static SimpleAddressSpaceFilter	create(Predicate<NodeId> nodeIdFilter) Create a new SimpleAddressSpaceFilter that uses a Predicate on NodeId.
static SimpleAddressSpaceFilter	create(Predicate<NodeId> nodeIdFilter, Predicate<NodeId> monitoredItemFilter) Create a new SimpleAddressSpaceFilter that uses a separate Predicate for NodeIds and MonitoredItems.
boolean	filterAddNodes(OpcUaServer server, AddNodesItem addNodesItem) Return true if the add nodes operation for addNodesItem should be handled by the AddressSpace this filter belongs to.
boolean	filterAddReferences(OpcUaServer server, AddReferencesItem addReferencesItem) Return true if the add references operation for addReferencesItem should be handled by the AddressSpace this filter belongs to.
boolean	filterBrowse(OpcUaServer server, NodeId nodeId) Return true if the browse operation for nodeId should be handled by the AddressSpace this filter belongs to.
boolean	filterCall(OpcUaServer server, CallMethodRequest callMethodRequest) Return true if the call method operation for callMethodRequest should be handled by the AddressSpace this filter belongs to.
boolean	filterDeleteNodes(OpcUaServer server, DeleteNodesItem deleteNodesItem) Return true if the delete nodes operation for deleteNodesItem should be handled by the AddressSpace this filter belongs to.
boolean	filterDeleteReferences(OpcUaServer server, DeleteReferencesItem deleteReferencesItem) Return true if the delete references operation for deleteReferencesITem should be handled by the AddressSpace this filter belongs to.
boolean	filterHistoryRead(OpcUaServer server, HistoryReadValueId historyReadValueId) Return true if the history read operation for historyReadValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterHistoryUpdate(OpcUaServer server, HistoryUpdateDetails historyUpdateDetails) Return true if the history update operation for historyUpdateDetails should be handled by the AddressSpace this filter belongs to.
protected abstract boolean	filterMonitoredItem(NodeId nodeId) Return true if the operation on the MonitoredItem for nodeId should be handled by this filter's AddressSpace.
protected abstract boolean	filterNode(NodeId nodeId) Return true if the operation nodeId belongs to should be handled this filter's AddressSpace.
boolean	filterOnCreateDataItem(OpcUaServer server, ReadValueId readValueId) Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterOnCreateEventItem(OpcUaServer server, ReadValueId readValueId) Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterOnDataItemsCreated(OpcUaServer server, ReadValueId readValueId) Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterOnDataItemsDeleted(OpcUaServer server, ReadValueId readValueId) Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterOnDataItemsModified(OpcUaServer server, ReadValueId readValueId) Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterOnEventItemsCreated(OpcUaServer server, ReadValueId readValueId) Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterOnEventItemsDeleted(OpcUaServer server, ReadValueId readValueId) Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterOnEventItemsModified(OpcUaServer server, ReadValueId readValueId) Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterOnModifyDataItem(OpcUaServer server, ReadValueId readValueId) Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterOnModifyEventItem(OpcUaServer server, ReadValueId readValueId) Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterOnMonitoringModeChanged(OpcUaServer server, ReadValueId readValueId) Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterRead(OpcUaServer server, ReadValueId readValueId) Return true if the read operation for readValueId should be handled by the AddressSpace this filter belongs to.
boolean	filterRegisterNode(OpcUaServer server, NodeId nodeId) Return true if the register node operation for nodeId should be handled by the AddressSpace this filter belongs to.
boolean	filterUnregisterNode(OpcUaServer server, NodeId nodeId) Return true if the unregister node operation for nodeId should be handled by the AddressSpace this filter belongs to.
boolean	filterWrite(OpcUaServer server, WriteValue writeValue) Return true if the write operation for writeValue should be handled by the AddressSpace this filter belongs to.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleAddressSpaceFilter

public SimpleAddressSpaceFilter()

Method Detail

create

public static SimpleAddressSpaceFilter create(Predicate<NodeId> nodeIdFilter)

Create a new SimpleAddressSpaceFilter that uses a Predicate on NodeId.

Parameters:

nodeIdFilter - a Predicate that tests a NodeId.

Returns:

a new SimpleAddressSpaceFilter that uses a Predicate on NodeId.

create

public static SimpleAddressSpaceFilter create(Predicate<NodeId> nodeIdFilter,
                                              Predicate<NodeId> monitoredItemFilter)

Create a new SimpleAddressSpaceFilter that uses a separate Predicate for NodeIds and MonitoredItems.

Parameters:

nodeIdFilter - a Predicate that tests a NodeId.

monitoredItemFilter - a Predicate that tests a NodeId targeted by a MonitoredItem.

Returns:

a new SimpleAddressSpaceFilter that uses a Predicate on NodeId.

filterNode

protected abstract boolean filterNode(NodeId nodeId)

Return true if the operation nodeId belongs to should be handled this filter's AddressSpace.

This is not an indication that a Node for nodeId exists, rather, it's an indication that this AddressSpace would be responsible for the Node *if it did* exist.

Parameters:

nodeId - a NodeId.

Returns:

true if the operation nodeId belongs to should be handled this filter's AddressSpace.

filterMonitoredItem

protected abstract boolean filterMonitoredItem(NodeId nodeId)

Return true if the operation on the MonitoredItem for nodeId should be handled by this filter's AddressSpace.

Parameters:

nodeId - the NodeId of MonitoredItem being operated on.

Returns:

true if the operation on the MonitoredItem for nodeId should be handled by this filter's AddressSpace.

filterBrowse

public boolean filterBrowse(OpcUaServer server,
                            NodeId nodeId)

Description copied from interface: AddressSpaceFilter

Return true if the browse operation for nodeId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterBrowse in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

nodeId - the NodeId from the browse operation.

Returns:

true if the browse operation for nodeId should be handled the the AddressSpace this filter belongs to.

See Also:

ViewServices.browse(BrowseContext, ViewDescription, NodeId)

filterRegisterNode

public boolean filterRegisterNode(OpcUaServer server,
                                  NodeId nodeId)

Description copied from interface: AddressSpaceFilter

Return true if the register node operation for nodeId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterRegisterNode in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

nodeId - the NodeId to register.

Returns:

true if the register node operation for nodeId should be handled by the AddressSpace this filter belongs to.

See Also:

ViewServices.registerNodes(RegisterNodesContext, List)

filterUnregisterNode

public boolean filterUnregisterNode(OpcUaServer server,
                                    NodeId nodeId)

Description copied from interface: AddressSpaceFilter

Return true if the unregister node operation for nodeId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterUnregisterNode in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

nodeId - the NodeId to unregister.

Returns:

true if the unregister node operation for nodeId should be handled by the AddressSpace this filter belongs to.

See Also:

ViewServices.unregisterNodes(UnregisterNodesContext, List)

filterRead

public boolean filterRead(OpcUaServer server,
                          ReadValueId readValueId)

Description copied from interface: AddressSpaceFilter

Return true if the read operation for readValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterRead in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

readValueId - the ReadValueId from the read operation.

Returns:

true if the read operation for readValueId should be handled by the AddressSpace this filter belongs to.

See Also:

AttributeServices.read(ReadContext, Double, TimestampsToReturn, List)

filterWrite

public boolean filterWrite(OpcUaServer server,
                           WriteValue writeValue)

Description copied from interface: AddressSpaceFilter

Return true if the write operation for writeValue should be handled by the AddressSpace this filter belongs to.

Specified by:

filterWrite in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

writeValue - the WriteValue from the write operation.

Returns:

true if the write operation for writeValue should be handled by the AddressSpace this filter belongs to.

See Also:

AttributeServices.write(WriteContext, List)

filterHistoryRead

public boolean filterHistoryRead(OpcUaServer server,
                                 HistoryReadValueId historyReadValueId)

Description copied from interface: AddressSpaceFilter

Return true if the history read operation for historyReadValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterHistoryRead in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

historyReadValueId - the HistoryReadValueId from the history read operation.

Returns:

true if the history read operation for historyReadValueId should be handled by the AddressSpace this filter belongs to.

See Also:

AttributeHistoryServices.historyRead(HistoryReadContext, HistoryReadDetails, TimestampsToReturn, List)

filterHistoryUpdate

public boolean filterHistoryUpdate(OpcUaServer server,
                                   HistoryUpdateDetails historyUpdateDetails)

Description copied from interface: AddressSpaceFilter

Return true if the history update operation for historyUpdateDetails should be handled by the AddressSpace this filter belongs to.

Specified by:

filterHistoryUpdate in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

historyUpdateDetails - the HistoryUpdateDetails from the history update operation.

Returns:

true if the history update operation for historyUpdateDetails should be handled by the AddressSpace this filter belongs to.

See Also:

AttributeHistoryServices.historyUpdate(HistoryUpdateContext, List)

filterCall

public boolean filterCall(OpcUaServer server,
                          CallMethodRequest callMethodRequest)

Description copied from interface: AddressSpaceFilter

Return true if the call method operation for callMethodRequest should be handled by the AddressSpace this filter belongs to.

Specified by:

filterCall in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

callMethodRequest - the CallMethodRequest from the call method operation.

Returns:

true if the call method operation for callMethodRequest should be handled by the AddressSpace this filter belongs to.

See Also:

MethodServices.call(CallContext, List)

filterOnCreateDataItem

public boolean filterOnCreateDataItem(OpcUaServer server,
                                      ReadValueId readValueId)

Description copied from interface: AddressSpaceFilter

Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterOnCreateDataItem in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

readValueId - the ReadValueId from the monitored item operation.

Returns:

true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

See Also:

MonitoredItemServices.onCreateDataItem(ReadValueId, Double, UInteger, BiConsumer)

filterOnModifyDataItem

public boolean filterOnModifyDataItem(OpcUaServer server,
                                      ReadValueId readValueId)

Description copied from interface: AddressSpaceFilter

Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterOnModifyDataItem in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

readValueId - the ReadValueId from the monitored item operation.

Returns:

true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

See Also:

MonitoredItemServices.onModifyDataItem(ReadValueId, Double, UInteger, BiConsumer)

filterOnCreateEventItem

public boolean filterOnCreateEventItem(OpcUaServer server,
                                       ReadValueId readValueId)

Description copied from interface: AddressSpaceFilter

Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterOnCreateEventItem in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

readValueId - the ReadValueId from the monitored item operation.

Returns:

true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

See Also:

MonitoredItemServices.onCreateEventItem(ReadValueId, UInteger, Consumer)

filterOnModifyEventItem

public boolean filterOnModifyEventItem(OpcUaServer server,
                                       ReadValueId readValueId)

Description copied from interface: AddressSpaceFilter

Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterOnModifyEventItem in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

readValueId - the ReadValueId from the monitored item operation.

Returns:

true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

See Also:

MonitoredItemServices.onModifyEventItem(ReadValueId, UInteger, Consumer)

filterOnDataItemsCreated

public boolean filterOnDataItemsCreated(OpcUaServer server,
                                        ReadValueId readValueId)

Description copied from interface: AddressSpaceFilter

Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterOnDataItemsCreated in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

readValueId - the ReadValueId from the monitored item operation.

Returns:

true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

See Also:

MonitoredItemServices.onDataItemsCreated(List)

filterOnDataItemsModified

public boolean filterOnDataItemsModified(OpcUaServer server,
                                         ReadValueId readValueId)

Description copied from interface: AddressSpaceFilter

Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterOnDataItemsModified in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

readValueId - the ReadValueId from the monitored item operation.

Returns:

true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

See Also:

MonitoredItemServices.onDataItemsModified(List)

filterOnDataItemsDeleted

public boolean filterOnDataItemsDeleted(OpcUaServer server,
                                        ReadValueId readValueId)

Description copied from interface: AddressSpaceFilter

Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterOnDataItemsDeleted in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

readValueId - the ReadValueId from the monitored item operation.

Returns:

true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

See Also:

MonitoredItemServices.onDataItemsDeleted(List)

filterOnEventItemsCreated

public boolean filterOnEventItemsCreated(OpcUaServer server,
                                         ReadValueId readValueId)

Description copied from interface: AddressSpaceFilter

Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterOnEventItemsCreated in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

readValueId - the ReadValueId from the monitored item operation.

Returns:

true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

See Also:

MonitoredItemServices.onEventItemsCreated(List)

filterOnEventItemsModified

public boolean filterOnEventItemsModified(OpcUaServer server,
                                          ReadValueId readValueId)

Description copied from interface: AddressSpaceFilter

Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterOnEventItemsModified in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

readValueId - the ReadValueId from the monitored item operation.

Returns:

true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

See Also:

MonitoredItemServices.onEventItemsModified(List)

filterOnEventItemsDeleted

public boolean filterOnEventItemsDeleted(OpcUaServer server,
                                         ReadValueId readValueId)

Description copied from interface: AddressSpaceFilter

Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterOnEventItemsDeleted in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

readValueId - the ReadValueId from the monitored item operation.

Returns:

true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

See Also:

MonitoredItemServices.onEventItemsDeleted(List)

filterOnMonitoringModeChanged

public boolean filterOnMonitoringModeChanged(OpcUaServer server,
                                             ReadValueId readValueId)

Description copied from interface: AddressSpaceFilter

Return true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

Specified by:

filterOnMonitoringModeChanged in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

readValueId - the ReadValueId from the monitored item operation.

Returns:

true if the monitored item operation for readValueId should be handled by the AddressSpace this filter belongs to.

See Also:

MonitoredItemServices.onMonitoringModeChanged(List)

filterAddNodes

public boolean filterAddNodes(OpcUaServer server,
                              AddNodesItem addNodesItem)

Description copied from interface: AddressSpaceFilter

Return true if the add nodes operation for addNodesItem should be handled by the AddressSpace this filter belongs to.

Specified by:

filterAddNodes in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

addNodesItem - the AddNodesItem from the add nodes operation.

Returns:

true if the add nodes operation for addNodesItem should be handled by the AddressSpace this filter belongs to.

See Also:

NodeManagementServices.addNodes(AddNodesContext, List)

filterDeleteNodes

public boolean filterDeleteNodes(OpcUaServer server,
                                 DeleteNodesItem deleteNodesItem)

Description copied from interface: AddressSpaceFilter

Return true if the delete nodes operation for deleteNodesItem should be handled by the AddressSpace this filter belongs to.

Specified by:

filterDeleteNodes in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

deleteNodesItem - the DeleteNodesItem from the delete nodes operation.

Returns:

Return true if the delete nodes operation for deleteNodesItem should be handled by the AddressSpace this filter belongs to.

See Also:

NodeManagementServices.deleteNodes(DeleteNodesContext, List)

filterAddReferences

public boolean filterAddReferences(OpcUaServer server,
                                   AddReferencesItem addReferencesItem)

Description copied from interface: AddressSpaceFilter

Return true if the add references operation for addReferencesItem should be handled by the AddressSpace this filter belongs to.

Specified by:

filterAddReferences in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

addReferencesItem - the AddReferencesItem from the add references operation.

Returns:

true if the add references operation for addReferencesItem should be handled by the AddressSpace this filter belongs to.

See Also:

NodeManagementServices.addReferences(AddReferencesContext, List)

filterDeleteReferences

public boolean filterDeleteReferences(OpcUaServer server,
                                      DeleteReferencesItem deleteReferencesItem)

Description copied from interface: AddressSpaceFilter

Return true if the delete references operation for deleteReferencesITem should be handled by the AddressSpace this filter belongs to.

Specified by:

filterDeleteReferences in interface AddressSpaceFilter

Parameters:

server - the OpcUaServer.

deleteReferencesItem - the DeleteReferencesItem from the delete references operation.

Returns:

true if the delete references operation for deleteReferencesITem should be handled by the AddressSpace this filter belongs to.

See Also:

NodeManagementServices.deleteReferences(DeleteReferencesContext, List)