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

Class ManagedAddressSpaceFragmentWithLifecycle

java.lang.Object

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

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

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

All Implemented Interfaces:

AddressSpace, AddressSpaceFragment, AttributeHistoryServices, AttributeServices, MethodServices, MonitoredItemServices, NodeManagementServices, ViewServices, Lifecycle

public abstract class ManagedAddressSpaceFragmentWithLifecycle
extends ManagedAddressSpaceFragment
implements Lifecycle

A ManagedAddressSpace fragment that has a Lifecycle associated with it.

This fragment will be registered with the provided composite and its UaNodeManager will be registered with the server on startup and unregistered on shutdown.

Subclasses can register additional startup/shutdown tasks with the LifecycleManager obtained from getLifecycleManager().

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.server.api.services.AttributeServices

AttributeServices.ReadContext, AttributeServices.WriteContext

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.server.api.services.AttributeHistoryServices

AttributeHistoryServices.HistoryReadContext, AttributeHistoryServices.HistoryUpdateContext

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.server.api.services.MethodServices

MethodServices.CallContext

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.server.api.services.NodeManagementServices

NodeManagementServices.AddNodesContext, NodeManagementServices.AddReferencesContext, NodeManagementServices.DeleteNodesContext, NodeManagementServices.DeleteReferencesContext

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.server.api.services.ViewServices

ViewServices.BrowseContext, ViewServices.RegisterNodesContext, ViewServices.UnregisterNodesContext

Constructor Summary

Constructors

Constructor and Description
ManagedAddressSpaceFragmentWithLifecycle(OpcUaServer server) Create a managed fragment using the server's AddressSpaceManager as the composite.
ManagedAddressSpaceFragmentWithLifecycle(OpcUaServer server, AddressSpaceComposite composite) Create a managed fragment using composite.
ManagedAddressSpaceFragmentWithLifecycle(OpcUaServer server, UaNodeManager nodeManager) Create a managed fragment using the server's AddressSpaceManager as the composite.
ManagedAddressSpaceFragmentWithLifecycle(OpcUaServer server, UaNodeManager nodeManager, AddressSpaceComposite composite) Create a managed fragment using composite.

Method Summary

Modifier and Type	Method and Description
AddressSpaceComposite	getComposite() Get the AddressSpaceComposite this fragment registers with.
protected LifecycleManager	getLifecycleManager() Get the LifecycleManager for this ManagedAddressSpaceFragmentWithLifecycle.
protected void	registerNodeManager(UaNodeManager nodeManager) Register this AddressSpace's UaNodeManager with its managing entity.
protected void	registerWithComposite(AddressSpaceComposite composite) Register this AddressSpaceFragment with composite.
void	shutdown() Execute shutdown logic, if there is any.
void	startup() Execute startup logic, if there is any.
protected void	unregisterNodeManager(UaNodeManager nodeManager) Unregister this AddressSpace's UaNodeManager with its managing entity.

Methods inherited from class org.eclipse.milo.opcua.sdk.server.api.ManagedAddressSpace

browse, call, createNodeFactory, getInvocationHandler, getNodeContext, getNodeFactory, getNodeManager, getReferences, getServer, read, registerNodes, unregisterNodes, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.milo.opcua.sdk.server.api.AddressSpaceFragment

getFilter

Methods inherited from interface org.eclipse.milo.opcua.sdk.server.api.services.AttributeServices

read, write

Methods inherited from interface org.eclipse.milo.opcua.sdk.server.api.services.AttributeHistoryServices

historyRead, historyUpdate

Methods inherited from interface org.eclipse.milo.opcua.sdk.server.api.services.MethodServices

call

Methods inherited from interface org.eclipse.milo.opcua.sdk.server.api.services.MonitoredItemServices

onCreateDataItem, onCreateEventItem, onDataItemsCreated, onDataItemsDeleted, onDataItemsModified, onEventItemsCreated, onEventItemsDeleted, onEventItemsModified, onModifyDataItem, onModifyEventItem, onMonitoringModeChanged

Methods inherited from interface org.eclipse.milo.opcua.sdk.server.api.services.NodeManagementServices

addNodes, addReferences, deleteNodes, deleteReferences

Methods inherited from interface org.eclipse.milo.opcua.sdk.server.api.services.ViewServices

browse, browse, getReferences, getViewCount, registerNodes, unregisterNodes

Constructor Detail

ManagedAddressSpaceFragmentWithLifecycle

public ManagedAddressSpaceFragmentWithLifecycle(OpcUaServer server)

Create a managed fragment using the server's AddressSpaceManager as the composite.

Parameters:

server - the OpcUaServer instance.

ManagedAddressSpaceFragmentWithLifecycle

public ManagedAddressSpaceFragmentWithLifecycle(OpcUaServer server,
                                                AddressSpaceComposite composite)

Create a managed fragment using composite.

Parameters:

server - the OpcUaServer instance.

composite - the AddressSpaceComposite this fragment is part of.

ManagedAddressSpaceFragmentWithLifecycle

public ManagedAddressSpaceFragmentWithLifecycle(OpcUaServer server,
                                                UaNodeManager nodeManager)

Create a managed fragment using the server's AddressSpaceManager as the composite.

Parameters:

server - the OpcUaServer instance.

nodeManager - the UaNodeManager to manage nodes with.

ManagedAddressSpaceFragmentWithLifecycle

public ManagedAddressSpaceFragmentWithLifecycle(OpcUaServer server,
                                                UaNodeManager nodeManager,
                                                AddressSpaceComposite composite)

Create a managed fragment using composite.

Parameters:

server - the OpcUaServer instance.

nodeManager - the UaNodeManager to manage nodes with.

composite - the AddressSpaceComposite this fragment is part of.

Method Detail

startup

public final void startup()

Description copied from interface: Lifecycle

Execute startup logic, if there is any.

Specified by:

startup in interface Lifecycle

shutdown

public final void shutdown()

Description copied from interface: Lifecycle

Execute shutdown logic, if there is any.

Specified by:

shutdown in interface Lifecycle

getComposite

public AddressSpaceComposite getComposite()

Get the AddressSpaceComposite this fragment registers with.

Returns:

the AddressSpaceComposite this fragment registers with.

getLifecycleManager

protected LifecycleManager getLifecycleManager()

Get the LifecycleManager for this ManagedAddressSpaceFragmentWithLifecycle.

Returns:

the LifecycleManager for this ManagedAddressSpaceFragmentWithLifecycle.

registerWithComposite

protected void registerWithComposite(AddressSpaceComposite composite)

Register this AddressSpaceFragment with composite.

Can be overridden if e.g. this fragment should use AddressSpaceComposite.registerFirst(AddressSpaceFragment) instead of AddressSpaceComposite.register(AddressSpaceFragment).

Parameters:

composite - the AddressSpaceComposite to register with.

registerNodeManager

protected void registerNodeManager(UaNodeManager nodeManager)

Register this AddressSpace's UaNodeManager with its managing entity.

The default implementation registers it with the server's AddressSpaceManager.

Parameters:

nodeManager - the UaNodeManager to register.

unregisterNodeManager

protected void unregisterNodeManager(UaNodeManager nodeManager)

Unregister this AddressSpace's UaNodeManager with its managing entity.

The default implementation unregisters it with the server's AddressSpaceManager.

Parameters:

nodeManager - the UaNodeManager to unregister.