com.prosysopc.ua.server

Interface PubSubConfigurator

public interface PubSubConfigurator

Helper interface for SDK internal use.

Method Summary

Modifier and Type	Method and Description
NodeId	onAddConnection(PublishSubscribeTypeNode publishSubscribeTypeNode, ServiceContext serviceContext, PubSubConnectionDataType configuration)
NodeId	onAddDataSetFolder(DataSetFolderTypeNode dataSetFolderTypeNode, ServiceContext serviceContext, String name)
NodeId	onAddDataSetReader(ReaderGroupTypeNode readerGroupTypeNode, ServiceContext serviceContext, DataSetReaderDataType configuration)
NodeId	onAddDataSetWriter(WriterGroupTypeNode writerGroupTypeNode, ServiceContext serviceContext, DataSetWriterDataType configuration)
NodeId	onAddExtensionField(ExtensionFieldsTypeNode extensionFieldsTypeNode, ServiceContext serviceContext, QualifiedName fieldName, Object fieldValue)
DataSetFolderType.AddPublishedDataItemsMethodOutputs	onAddPublishedDataItems(DataSetFolderTypeNode dataSetFolderTypeNode, ServiceContext serviceContext, String name, String[] fieldNameAliases, DataSetFieldFlags[] fieldFlags, PublishedVariableDataType[] variablesToAdd)
DataSetFolderType.AddPublishedDataItemsTemplateMethodOutputs	onAddPublishedDataItemsTemplate(DataSetFolderTypeNode dataSetFolderTypeNode, ServiceContext serviceContext, String name, DataSetMetaDataType dataSetMetaData, PublishedVariableDataType[] variablesToAdd)
DataSetFolderType.AddPublishedEventsMethodOutputs	onAddPublishedEvents(DataSetFolderTypeNode dataSetFolderTypeNode, ServiceContext serviceContext, String name, NodeId eventNotifier, String[] fieldNameAliases, DataSetFieldFlags[] fieldFlags, SimpleAttributeOperand[] selectedFields, ContentFilter filter)
NodeId	onAddPublishedEventsTemplate(DataSetFolderTypeNode dataSetFolderTypeNode, ServiceContext serviceContext, String name, DataSetMetaDataType dataSetMetaData, NodeId eventNotifier, SimpleAttributeOperand[] selectedFields, ContentFilter filter)
NodeId	onAddReaderGroup(PubSubConnectionTypeNode pubSubConnectionTypeNode, ServiceContext serviceContext, ReaderGroupDataType configuration)
StatusCode[]	onAddTargetVariables(TargetVariablesTypeNode targetVariablesTypeNode, ServiceContext serviceContext, ConfigurationVersionDataType configurationVersion, FieldTargetDataType[] targetVariablesToAdd)
PublishedDataItemsType.AddVariablesMethodOutputs	onAddVariables(PublishedDataItemsTypeNode publishedDataItemsTypeNode, ServiceContext serviceContext, ConfigurationVersionDataType configurationVersion, String[] fieldNameAliases, Boolean[] promotedFields, PublishedVariableDataType[] variablesToAdd)
NodeId	onAddWriterGroup(PubSubConnectionTypeNode pubSubConnectionTypeNode, ServiceContext serviceContext, WriterGroupDataType configuration)
NodeId	onCreateDataSetMirror(DataSetReaderTypeNode dataSetReaderTypeNode, ServiceContext serviceContext, String parentNodeName, RolePermissionType[] rolePermissions)
StatusCode[]	onCreateTargetVariables(DataSetReaderTypeNode dataSetReaderTypeNode, ServiceContext serviceContext, ConfigurationVersionDataType configurationVersion, FieldTargetDataType[] targetVariablesToAdd)
void	onDisable(PubSubStatusTypeNode pubSubStatusTypeNode, ServiceContext serviceContext)
void	onEnable(PubSubStatusTypeNode pubSubStatusTypeNode, ServiceContext serviceContext)
NodeId	onGetSecurityGroup(PubSubKeyServiceTypeNode pubSubKeyServiceTypeNode, ServiceContext serviceContext, String securityGroupId)
PubSubKeyServiceType.GetSecurityKeysMethodOutputs	onGetSecurityKeys(PubSubKeyServiceTypeNode pubSubKeyServiceTypeNode, ServiceContext serviceContext, String securityGroupId, UnsignedInteger startingTokenId, UnsignedInteger requestedKeyCount)
ConfigurationVersionDataType	onModifyFieldSelection(PublishedEventsTypeNode publishedEventsTypeNode, ServiceContext serviceContext, ConfigurationVersionDataType configurationVersion, String[] fieldNameAliases, Boolean[] promotedFields, SimpleAttributeOperand[] selectedFields)
void	onRemoveConnection(PublishSubscribeTypeNode publishSubscribeTypeNode, ServiceContext serviceContext, NodeId connectionId)
void	onRemoveDataSetFolder(DataSetFolderTypeNode dataSetFolderTypeNode, ServiceContext serviceContext, NodeId dataSetFolderNodeId)
void	onRemoveDataSetReader(ReaderGroupTypeNode readerGroupTypeNode, ServiceContext serviceContext, NodeId dataSetReaderNodeId)
void	onRemoveDataSetWriter(WriterGroupTypeNode writerGroupTypeNode, ServiceContext serviceContext, NodeId dataSetWriterNodeId)
void	onRemoveExtensionField(ExtensionFieldsTypeNode extensionFieldsTypeNode, ServiceContext serviceContext, NodeId fieldId)
void	onRemoveGroup(PubSubConnectionTypeNode pubSubConnectionTypeNode, ServiceContext serviceContext, NodeId groupId)
void	onRemovePublishedDataSet(DataSetFolderTypeNode dataSetFolderTypeNode, ServiceContext serviceContext, NodeId dataSetNodeId)
StatusCode[]	onRemoveTargetVariables(TargetVariablesTypeNode targetVariablesTypeNode, ServiceContext serviceContext, ConfigurationVersionDataType configurationVersion, UnsignedInteger[] targetsToRemove)
PublishedDataItemsType.RemoveVariablesMethodOutputs	onRemoveVariables(PublishedDataItemsTypeNode publishedDataItemsTypeNode, ServiceContext serviceContext, ConfigurationVersionDataType configurationVersion, UnsignedInteger[] variablesToRemove)
void	onReset(PubSubDiagnosticsTypeNode pubSubDiagnosticsTypeNode, ServiceContext serviceContext)
void	onSetSecurityKeys(PublishSubscribeTypeNode publishSubscribeTypeNode, ServiceContext serviceContext, String securityGroupId, String securityPolicyUri, UnsignedInteger currentTokenId, ByteString currentKey, ByteString[] futureKeys, Double timeToNextKey, Double keyLifetime)

Method Detail

onAddConnection

NodeId onAddConnection(PublishSubscribeTypeNode publishSubscribeTypeNode,
                       ServiceContext serviceContext,
                       PubSubConnectionDataType configuration)
                throws StatusException

Throws:

StatusException

onAddDataSetFolder

NodeId onAddDataSetFolder(DataSetFolderTypeNode dataSetFolderTypeNode,
                          ServiceContext serviceContext,
                          String name)
                   throws StatusException

Throws:

StatusException

onAddDataSetReader

NodeId onAddDataSetReader(ReaderGroupTypeNode readerGroupTypeNode,
                          ServiceContext serviceContext,
                          DataSetReaderDataType configuration)
                   throws StatusException

Throws:

StatusException

onAddDataSetWriter

NodeId onAddDataSetWriter(WriterGroupTypeNode writerGroupTypeNode,
                          ServiceContext serviceContext,
                          DataSetWriterDataType configuration)
                   throws StatusException

Throws:

StatusException

onAddExtensionField

NodeId onAddExtensionField(ExtensionFieldsTypeNode extensionFieldsTypeNode,
                           ServiceContext serviceContext,
                           QualifiedName fieldName,
                           Object fieldValue)
                    throws StatusException

Throws:

StatusException

onAddPublishedDataItems

DataSetFolderType.AddPublishedDataItemsMethodOutputs onAddPublishedDataItems(DataSetFolderTypeNode dataSetFolderTypeNode,
                                                                             ServiceContext serviceContext,
                                                                             String name,
                                                                             String[] fieldNameAliases,
                                                                             DataSetFieldFlags[] fieldFlags,
                                                                             PublishedVariableDataType[] variablesToAdd)
                                                                      throws StatusException

Throws:

StatusException

onAddPublishedDataItemsTemplate

DataSetFolderType.AddPublishedDataItemsTemplateMethodOutputs onAddPublishedDataItemsTemplate(DataSetFolderTypeNode dataSetFolderTypeNode,
                                                                                             ServiceContext serviceContext,
                                                                                             String name,
                                                                                             DataSetMetaDataType dataSetMetaData,
                                                                                             PublishedVariableDataType[] variablesToAdd)
                                                                                      throws StatusException

Throws:

StatusException

onAddPublishedEvents

DataSetFolderType.AddPublishedEventsMethodOutputs onAddPublishedEvents(DataSetFolderTypeNode dataSetFolderTypeNode,
                                                                       ServiceContext serviceContext,
                                                                       String name,
                                                                       NodeId eventNotifier,
                                                                       String[] fieldNameAliases,
                                                                       DataSetFieldFlags[] fieldFlags,
                                                                       SimpleAttributeOperand[] selectedFields,
                                                                       ContentFilter filter)
                                                                throws StatusException

Throws:

StatusException

onAddPublishedEventsTemplate

NodeId onAddPublishedEventsTemplate(DataSetFolderTypeNode dataSetFolderTypeNode,
                                    ServiceContext serviceContext,
                                    String name,
                                    DataSetMetaDataType dataSetMetaData,
                                    NodeId eventNotifier,
                                    SimpleAttributeOperand[] selectedFields,
                                    ContentFilter filter)
                             throws StatusException

Throws:

StatusException

onAddReaderGroup

NodeId onAddReaderGroup(PubSubConnectionTypeNode pubSubConnectionTypeNode,
                        ServiceContext serviceContext,
                        ReaderGroupDataType configuration)
                 throws StatusException

Throws:

StatusException

onAddTargetVariables

StatusCode[] onAddTargetVariables(TargetVariablesTypeNode targetVariablesTypeNode,
                                  ServiceContext serviceContext,
                                  ConfigurationVersionDataType configurationVersion,
                                  FieldTargetDataType[] targetVariablesToAdd)
                           throws StatusException

Throws:

StatusException

onAddVariables

PublishedDataItemsType.AddVariablesMethodOutputs onAddVariables(PublishedDataItemsTypeNode publishedDataItemsTypeNode,
                                                                ServiceContext serviceContext,
                                                                ConfigurationVersionDataType configurationVersion,
                                                                String[] fieldNameAliases,
                                                                Boolean[] promotedFields,
                                                                PublishedVariableDataType[] variablesToAdd)
                                                         throws StatusException

Throws:

StatusException

onAddWriterGroup

NodeId onAddWriterGroup(PubSubConnectionTypeNode pubSubConnectionTypeNode,
                        ServiceContext serviceContext,
                        WriterGroupDataType configuration)
                 throws StatusException

Throws:

StatusException

onCreateDataSetMirror

NodeId onCreateDataSetMirror(DataSetReaderTypeNode dataSetReaderTypeNode,
                             ServiceContext serviceContext,
                             String parentNodeName,
                             RolePermissionType[] rolePermissions)
                      throws StatusException

Throws:

StatusException

onCreateTargetVariables

StatusCode[] onCreateTargetVariables(DataSetReaderTypeNode dataSetReaderTypeNode,
                                     ServiceContext serviceContext,
                                     ConfigurationVersionDataType configurationVersion,
                                     FieldTargetDataType[] targetVariablesToAdd)
                              throws StatusException

Throws:

StatusException

onDisable

void onDisable(PubSubStatusTypeNode pubSubStatusTypeNode,
               ServiceContext serviceContext)
        throws StatusException

Throws:

StatusException

onEnable

void onEnable(PubSubStatusTypeNode pubSubStatusTypeNode,
              ServiceContext serviceContext)
       throws StatusException

Throws:

StatusException

onGetSecurityGroup

NodeId onGetSecurityGroup(PubSubKeyServiceTypeNode pubSubKeyServiceTypeNode,
                          ServiceContext serviceContext,
                          String securityGroupId)
                   throws StatusException

Throws:

StatusException

onGetSecurityKeys

PubSubKeyServiceType.GetSecurityKeysMethodOutputs onGetSecurityKeys(PubSubKeyServiceTypeNode pubSubKeyServiceTypeNode,
                                                                    ServiceContext serviceContext,
                                                                    String securityGroupId,
                                                                    UnsignedInteger startingTokenId,
                                                                    UnsignedInteger requestedKeyCount)
                                                             throws StatusException

Throws:

StatusException

onModifyFieldSelection

ConfigurationVersionDataType onModifyFieldSelection(PublishedEventsTypeNode publishedEventsTypeNode,
                                                    ServiceContext serviceContext,
                                                    ConfigurationVersionDataType configurationVersion,
                                                    String[] fieldNameAliases,
                                                    Boolean[] promotedFields,
                                                    SimpleAttributeOperand[] selectedFields)
                                             throws StatusException

Throws:

StatusException

onRemoveConnection

void onRemoveConnection(PublishSubscribeTypeNode publishSubscribeTypeNode,
                        ServiceContext serviceContext,
                        NodeId connectionId)
                 throws StatusException

Throws:

StatusException

onRemoveDataSetFolder

void onRemoveDataSetFolder(DataSetFolderTypeNode dataSetFolderTypeNode,
                           ServiceContext serviceContext,
                           NodeId dataSetFolderNodeId)
                    throws StatusException

Throws:

StatusException

onRemoveDataSetReader

void onRemoveDataSetReader(ReaderGroupTypeNode readerGroupTypeNode,
                           ServiceContext serviceContext,
                           NodeId dataSetReaderNodeId)
                    throws StatusException

Throws:

StatusException

onRemoveDataSetWriter

void onRemoveDataSetWriter(WriterGroupTypeNode writerGroupTypeNode,
                           ServiceContext serviceContext,
                           NodeId dataSetWriterNodeId)
                    throws StatusException

Throws:

StatusException

onRemoveExtensionField

void onRemoveExtensionField(ExtensionFieldsTypeNode extensionFieldsTypeNode,
                            ServiceContext serviceContext,
                            NodeId fieldId)
                     throws StatusException

Throws:

StatusException

onRemoveGroup

void onRemoveGroup(PubSubConnectionTypeNode pubSubConnectionTypeNode,
                   ServiceContext serviceContext,
                   NodeId groupId)
            throws StatusException

Throws:

StatusException

onRemovePublishedDataSet

void onRemovePublishedDataSet(DataSetFolderTypeNode dataSetFolderTypeNode,
                              ServiceContext serviceContext,
                              NodeId dataSetNodeId)
                       throws StatusException

Throws:

StatusException

onRemoveTargetVariables

StatusCode[] onRemoveTargetVariables(TargetVariablesTypeNode targetVariablesTypeNode,
                                     ServiceContext serviceContext,
                                     ConfigurationVersionDataType configurationVersion,
                                     UnsignedInteger[] targetsToRemove)
                              throws StatusException

Throws:

StatusException

onRemoveVariables

PublishedDataItemsType.RemoveVariablesMethodOutputs onRemoveVariables(PublishedDataItemsTypeNode publishedDataItemsTypeNode,
                                                                      ServiceContext serviceContext,
                                                                      ConfigurationVersionDataType configurationVersion,
                                                                      UnsignedInteger[] variablesToRemove)
                                                               throws StatusException

Throws:

StatusException

onReset

void onReset(PubSubDiagnosticsTypeNode pubSubDiagnosticsTypeNode,
             ServiceContext serviceContext)
      throws StatusException

Throws:

StatusException

onSetSecurityKeys

void onSetSecurityKeys(PublishSubscribeTypeNode publishSubscribeTypeNode,
                       ServiceContext serviceContext,
                       String securityGroupId,
                       String securityPolicyUri,
                       UnsignedInteger currentTokenId,
                       ByteString currentKey,
                       ByteString[] futureKeys,
                       Double timeToNextKey,
                       Double keyLifetime)
                throws StatusException

Throws:

StatusException