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

Interface ViewServices

All Known Subinterfaces:

AddressSpace, AddressSpaceFragment, Namespace

All Known Implementing Classes:

AddressSpaceComposite, AddressSpaceManager, ForwardingAddressSpace, ManagedAddressSpace, ManagedAddressSpaceFragment, ManagedAddressSpaceFragmentWithLifecycle, ManagedAddressSpaceWithLifecycle, ManagedNamespace, ManagedNamespaceWithLifecycle, OpcUaNamespace, ServerNamespace

public interface ViewServices

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ViewServices.BrowseContext
static class	ViewServices.RegisterNodesContext
static class	ViewServices.UnregisterNodesContext

Method Summary

Modifier and Type	Method and Description
default void	browse(ViewServices.BrowseContext context, NodeId nodeId) Like browse(BrowseContext, ViewDescription, NodeId) but with a null/empty ViewDescription.
void	browse(ViewServices.BrowseContext context, ViewDescription view, NodeId nodeId) Get all References for which nodeId is the source.
void	getReferences(ViewServices.BrowseContext context, ViewDescription view, NodeId nodeId) References for which nodeId is the source are being collected from all AddressSpace instances.
default UInteger	getViewCount() Get the number of views, if any, managed by this ViewServices implementation.
default void	registerNodes(ViewServices.RegisterNodesContext context, List<NodeId> nodeIds) Register one or more NodeIds.
default void	unregisterNodes(ViewServices.UnregisterNodesContext context, List<NodeId> nodeIds) Unregister one or more previously registered NodeIds.

Method Detail

browse

default void browse(ViewServices.BrowseContext context,
                    NodeId nodeId)

Like browse(BrowseContext, ViewDescription, NodeId) but with a null/empty ViewDescription.

Parameters:

context - the ViewServices.BrowseContext.

nodeId - the NodeId to browse.

browse

void browse(ViewServices.BrowseContext context,
            ViewDescription view,
            NodeId nodeId)

Get all References for which nodeId is the source.

If a Node instance for nodeId does not exist then AsyncOperationContext.failure(StatusCode) should be invoked with StatusCodes.Bad_NodeIdUnknown.

Parameters:

context - the ViewServices.BrowseContext.

view - the ViewDescription.

nodeId - the NodeId to browse.

getReferences

void getReferences(ViewServices.BrowseContext context,
                   ViewDescription view,
                   NodeId nodeId)

References for which nodeId is the source are being collected from all AddressSpace instances. Return any References where nodeId is the source this AddressSpace may have to contribute.

The Node identified by nodeId may be managed by another AddressSpace.

Parameters:

context - the ViewServices.BrowseContext.

view - the ViewDescription.

nodeId - the NodeId to get references fo.

registerNodes

default void registerNodes(ViewServices.RegisterNodesContext context,
                           List<NodeId> nodeIds)

Register one or more NodeIds.

Parameters:

context - the ViewServices.RegisterNodesContext.

nodeIds - the NodeIds to register.

unregisterNodes

default void unregisterNodes(ViewServices.UnregisterNodesContext context,
                             List<NodeId> nodeIds)

Unregister one or more previously registered NodeIds.

Parameters:

context - the ViewServices.UnregisterNodesContext.

nodeIds - the NodeIds to unregister.

getViewCount

default UInteger getViewCount()

Get the number of views, if any, managed by this ViewServices implementation.

Returns:

the number of views, if any, managed by this ViewServices implementation.