com.prosysopc.ua.types.opcua.server
Class ServerTypeNode

java.lang.Object
  extended by com.prosysopc.ua.nodes.AbstractUaNode
      extended by com.prosysopc.ua.server.nodes.ServerNode
          extended by com.prosysopc.ua.server.nodes.BaseNode
              extended by com.prosysopc.ua.server.nodes.UaInstanceNode
                  extended by com.prosysopc.ua.server.nodes.UaObjectNode
                      extended by com.prosysopc.ua.server.nodes.AbstractGeneratedObjectNode
                          extended by com.prosysopc.ua.types.opcua.server.BaseObjectTypeNode
                              extended by com.prosysopc.ua.types.opcua.server.ServerTypeNodeBase
                                  extended by com.prosysopc.ua.types.opcua.server.ServerTypeNode
All Implemented Interfaces:
UaInstance, UaNode, UaObject, GeneratedNode, UaCallable, BaseInstanceType, BaseObjectType, ServerType

public class ServerTypeNode
extends ServerTypeNodeBase

Specifies the current status and capabilities of the server.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.prosysopc.ua.types.opcua.ServerType
ServerType.GetMonitoredItemsMethodOutputs
 
Field Summary
 
Fields inherited from class com.prosysopc.ua.server.nodes.BaseNode
NODE_VERSION_PROPERTY_NAME
 
Fields inherited from class com.prosysopc.ua.server.nodes.ServerNode
eventListeners, INITIALIZATION_TIME, nodeManager, supportedAttributesMap
 
Fields inherited from interface com.prosysopc.ua.types.opcua.ServerType
AUDITING, ESTIMATED_RETURN_TIME, GET_MONITORED_ITEMS, NAMESPACE_ARRAY, NAMESPACES, REQUEST_SERVER_STATE_CHANGE, RESEND_DATA, SERVER_ARRAY, SERVER_CAPABILITIES, SERVER_DIAGNOSTICS, SERVER_REDUNDANCY, SERVER_STATUS, SERVICE_LEVEL, SET_SUBSCRIPTION_DURABLE, VENDOR_SERVER_INFO
 
Constructor Summary
protected ServerTypeNode(NodeManagerUaNode nodeManager, org.opcfoundation.ua.builtintypes.NodeId nodeId, org.opcfoundation.ua.builtintypes.QualifiedName browseName, org.opcfoundation.ua.builtintypes.LocalizedText displayName)
           
 
Method Summary
 void afterCreate()
          This method is called after NodeBuilder has constructed the instance, it is called for every sub-node that also implement this interface
protected  ServerType.GetMonitoredItemsMethodOutputs onGetMonitoredItems(ServiceContext serviceContext, org.opcfoundation.ua.builtintypes.UnsignedInteger subscriptionId)
           
protected  void onRequestServerStateChange(ServiceContext serviceContext, org.opcfoundation.ua.core.ServerState state, org.opcfoundation.ua.builtintypes.DateTime estimatedReturnTime, org.opcfoundation.ua.builtintypes.UnsignedInteger secondsTillShutdown, org.opcfoundation.ua.builtintypes.LocalizedText reason, Boolean restart)
           
protected  void onResendData(ServiceContext serviceContext, org.opcfoundation.ua.builtintypes.UnsignedInteger subscriptionId)
           
protected  org.opcfoundation.ua.builtintypes.UnsignedInteger onSetSubscriptionDurable(ServiceContext serviceContext, org.opcfoundation.ua.builtintypes.UnsignedInteger subscriptionId, org.opcfoundation.ua.builtintypes.UnsignedInteger lifetimeInHours)
           
 void setServiceLevel(int serviceLevel)
          ServiceLevel describes the ability of the Server to provide its data to the client.
 void setServiceLevel(org.opcfoundation.ua.builtintypes.UnsignedByte serviceLevel)
          ServiceLevel describes the ability of the Server to provide its data to the client.
 void shutdown(long secondsTillShutdown, org.opcfoundation.ua.builtintypes.LocalizedText shutdownReason)
           
 void start()
          Set the ServerState to Running.
 void updateNamespaceArray()
          Update the value of the NameSpaceArray node equal to the current NamespaceTable.
 void updateServerArray()
          Update the serverArray variable in the address space from the nodeManagerTable.
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.ServerTypeNodeBase
callMethod, getAuditingNode, getEstimatedReturnTime, getEstimatedReturnTimeNode, getGetMonitoredItemsMethodImplementation, getGetMonitoredItemsNode, getMonitoredItems, getNamespaceArray, getNamespaceArrayNode, getNamespacesNode, getRequestServerStateChangeMethodImplementation, getRequestServerStateChangeNode, getResendDataMethodImplementation, getResendDataNode, getServerArray, getServerArrayNode, getServerCapabilitiesNode, getServerDiagnosticsNode, getServerRedundancyNode, getServerStatus, getServerStatusNode, getServerTypeNodeInitializer, getServiceLevel, getServiceLevelNode, getSetSubscriptionDurableMethodImplementation, getSetSubscriptionDurableNode, getVendorServerInfoNode, isAuditing, requestServerStateChange, resendData, setAuditing, setEstimatedReturnTime, setGetMonitoredItemsMethodImplementation, setNamespaceArray, setRequestServerStateChangeMethodImplementation, setResendDataMethodImplementation, setServerArray, setServerStatus, setServerTypeNodeInitializer, setSetSubscriptionDurableMethodImplementation, setSubscriptionDurable
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.BaseObjectTypeNode
isCacheMethodIds, setCacheMethodIds
 
Methods inherited from class com.prosysopc.ua.server.nodes.AbstractGeneratedObjectNode
afterCreateInitIfExists, afterCreateSetValueIfExists, callAfterCreateIfExists, getDefaultTypeDefinition, getQualifiedName, isComponentMatch
 
Methods inherited from class com.prosysopc.ua.server.nodes.UaObjectNode
addCallListener, callMethod, deleteIfNodeExists, getAttributes, getAttributes, getEventNotifier, getIcon, getNodeClass, initSupportedAttributes, readAttributeValue, removeCallListener, setAttributes, setEventNotifier, setIcon, toString, writeAttributeValue
 
Methods inherited from class com.prosysopc.ua.server.nodes.UaInstanceNode
addModellingRule, beforeAddReference, getTypeDefinition, getTypeDefinitionId, hasTypeDefinition, registerOverridePlainMethod, setTypeDefinition, setTypeDefinitionId, setTypeDefinitionId, supportsTypeDefinitionNode
 
Methods inherited from class com.prosysopc.ua.server.nodes.BaseNode
addPlainProperty, addPlainVariable, assertTypeSupport, assertTypeSupport, createNodeId, createNodeId, createReflectiveInstanceProperty, createReflectiveInstanceProperty, deleteReference, deleteReference, doAddProperty, getAttributes, getBrowseName, getComponent, getComponents, getDescription, getDescription, getDisplayName, getDisplayName, getMethod, getNodeVersion, getNodeVersionValue, getProperties, getProperty, getPropertyValue, getReferencesAsList, getStandardBrowseName, getStandardDisplayText, getUserWriteMask, getWriteMask, hasProperty, hasReference, hasUserWriteAccess, hasWriteAccess, incNodeVersion, initNodeVersion, isChildOfType, readAttribute, readAttribute, registerCallbackProperty, registerPlainInstanceProperty, registerPlainInstanceProperty, registerPlainProperty, registerPlainProperty, registerPlainVariable, registerPlainVariable, registerReflectiveInstanceProperty, registerReflectiveInstanceVariable, registerReflectiveProperty, registerReflectiveVariable, removeProperty, setAccessLevelRecursively, setAccessLevelRecursively, setAttribute, setBrowseName, setDescription, setDisplayName, setNodeVersionValue, setPropertyValue, setUserWriteMask, setWriteMask, writeAttribute
 
Methods inherited from class com.prosysopc.ua.server.nodes.ServerNode
addComponent, addDataChangeListener, addEventListener, addNewReference, addNewReference, addOrganizes, addProperties, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, afterAddReference, afterDeleteReference, dataChange, deleteReference, deleteReference, deleteReferences, doDeleteReference, equals, findPlaceholders, fireDataChange, fireEvent, fireEventInParents, getAddressSpace, getDefaultBrowseName, getNodeId, getNodeManager, getReference, getReferenceList, getReferences, getSupportedAttributes, getTargetNodes, hashCode, isAddNotifierReferencesToServerObject, isFalseOrNull, isMandatory, isMonitoredForEvents, isTrueOrNull, isType, referenceTypeInherits, removeComponent, removeDataChangeListener, removeEventListener, setAddNotifierReferencesToServerObject, setReferences, supportsAttribute, translateBrowsePathToNodeIds, validateHasEventSourceChain, validateHasEventSourceChain
 
Methods inherited from class com.prosysopc.ua.nodes.AbstractUaNode
getForwardReferences, getInverseReferences, getReferences, getReferences, referenceTypeInherits
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.prosysopc.ua.types.opcua.BaseInstanceType
getQualifiedName
 
Methods inherited from interface com.prosysopc.ua.nodes.UaObject
callMethod, getEventNotifier, getIcon, setEventNotifier, setIcon
 
Methods inherited from interface com.prosysopc.ua.nodes.UaInstance
getTypeDefinition, getTypeDefinitionId, setTypeDefinition, setTypeDefinitionId, setTypeDefinitionId
 
Methods inherited from interface com.prosysopc.ua.nodes.UaNode
addComponent, addProperty, addReference, addReference, addReference, deleteReference, deleteReference, deleteReference, deleteReference, getAddressSpace, getAttributes, getBrowseName, getComponent, getComponents, getDescription, getDisplayName, getForwardReferences, getInverseReferences, getMethod, getNodeClass, getNodeId, getNodeVersion, getProperties, getProperty, getReference, getReferences, getReferences, getSupportedAttributes, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setReferences, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute
 

Constructor Detail

ServerTypeNode

protected ServerTypeNode(NodeManagerUaNode nodeManager,
                         org.opcfoundation.ua.builtintypes.NodeId nodeId,
                         org.opcfoundation.ua.builtintypes.QualifiedName browseName,
                         org.opcfoundation.ua.builtintypes.LocalizedText displayName)
Method Detail

afterCreate

public void afterCreate()
Description copied from interface: GeneratedNode
This method is called after NodeBuilder has constructed the instance, it is called for every sub-node that also implement this interface

Specified by:
afterCreate in interface GeneratedNode
Overrides:
afterCreate in class ServerTypeNodeBase

setServiceLevel

public void setServiceLevel(int serviceLevel)
ServiceLevel describes the ability of the Server to provide its data to the client. The value range is from 0 to 255, where 0 indicates the worst and 255 indicates the best. The concrete values are vendor-specific. The intent is to provide the clients an indication of availability among redundant Servers.

Overrides:
setServiceLevel in class ServerTypeNodeBase
Parameters:
serviceLevel - the serviceLevel to set - the value is converted to UnsignedByte so it must be in range of 0 to 255

setServiceLevel

public void setServiceLevel(org.opcfoundation.ua.builtintypes.UnsignedByte serviceLevel)
ServiceLevel describes the ability of the Server to provide its data to the client. The value range is from 0 to 255, where 0 indicates the worst and 255 indicates the best. The concrete values are vendor-specific. The intent is to provide the clients an indication of availability among redundant Servers.

Specified by:
setServiceLevel in interface ServerType
Overrides:
setServiceLevel in class ServerTypeNodeBase
Parameters:
serviceLevel - the serviceLevel to set

shutdown

public void shutdown(long secondsTillShutdown,
                     org.opcfoundation.ua.builtintypes.LocalizedText shutdownReason)
Parameters:
secondsTillShutdown -
shutdownReason -

start

public void start()
Set the ServerState to Running.


updateNamespaceArray

public void updateNamespaceArray()
Update the value of the NameSpaceArray node equal to the current NamespaceTable.

The method is called automatically when the server starts.


updateServerArray

public void updateServerArray()
Update the serverArray variable in the address space from the nodeManagerTable.

The method is called automatically when the server starts.

Note: You will only need to call this method, if you update the ServerTable of the server's NodeManagerTable while the server is running, which you normally should not do.


onGetMonitoredItems

protected ServerType.GetMonitoredItemsMethodOutputs onGetMonitoredItems(ServiceContext serviceContext,
                                                                        org.opcfoundation.ua.builtintypes.UnsignedInteger subscriptionId)
                                                                 throws StatusException
Specified by:
onGetMonitoredItems in class ServerTypeNodeBase
Throws:
StatusException

onRequestServerStateChange

protected void onRequestServerStateChange(ServiceContext serviceContext,
                                          org.opcfoundation.ua.core.ServerState state,
                                          org.opcfoundation.ua.builtintypes.DateTime estimatedReturnTime,
                                          org.opcfoundation.ua.builtintypes.UnsignedInteger secondsTillShutdown,
                                          org.opcfoundation.ua.builtintypes.LocalizedText reason,
                                          Boolean restart)
                                   throws StatusException
Specified by:
onRequestServerStateChange in class ServerTypeNodeBase
Throws:
StatusException

onResendData

protected void onResendData(ServiceContext serviceContext,
                            org.opcfoundation.ua.builtintypes.UnsignedInteger subscriptionId)
                     throws StatusException
Specified by:
onResendData in class ServerTypeNodeBase
Throws:
StatusException

onSetSubscriptionDurable

protected org.opcfoundation.ua.builtintypes.UnsignedInteger onSetSubscriptionDurable(ServiceContext serviceContext,
                                                                                     org.opcfoundation.ua.builtintypes.UnsignedInteger subscriptionId,
                                                                                     org.opcfoundation.ua.builtintypes.UnsignedInteger lifetimeInHours)
                                                                              throws StatusException
Specified by:
onSetSubscriptionDurable in class ServerTypeNodeBase
Throws:
StatusException


Copyright © 2018. All rights reserved.