The PubSubKeyPushTargetFolderType is formally defined Table 186.
Table 186– PubSubKeyPushTargetFolderType definition
|
Attribute |
Value |
||||
|
BrowseName |
PubSubKeyPushTargetFolderType |
||||
|
IsAbstract |
False |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
Subtype of FolderType defined in OPC 10000-5. |
|||||
|
Organizes |
Object |
<PushTargetFolderName> |
|
PubSubKeyPushTargetFolderType |
OptionalPlaceholder |
|
HasComponent |
Object |
<PushTargetName> |
|
PubSubKeyPushTargetType |
OptionalPlaceholder |
|
HasComponent |
Method |
AddPushTarget |
Defined in 8.7.2 |
Mandatory |
|
|
HasComponent |
Method |
RemovePushTarget |
Defined in 8.7.3 |
Mandatory |
|
|
HasComponent |
Method |
AddPushTargetFolder |
Defined in 8.7.4. |
Optional |
|
|
HasComponent |
Method |
RemovePushTargetFolder |
Defined in 8.7.5. |
Optional |
|
|
Conformance Units |
|||||
|
PubSub Model SKS Push |
|||||
Instances of the PubSubKeyPushTargetFolderType can contain PubSubKeyPushTarget Objectsor other instances of the PubSubKeyPushTargetFolderType. This can be used to build a tree of folderObjectsused to organize the configured PubSubKeyPushTargets.
The PubSubKeyPushTarget Objectsare added as components to the instance of the PubSubKeyPushTargetFolderType. A PubSubKeyPushTargets is referenced only from one folder. If the folder is deleted, all referenced PubSubKeyPushTargets are deleted with the folder.
This Methodis used to add a PubSubKeyPushTargetto a PubSubKeyPushTargetFolderor to return an existing Objectif the parameters match the configuration of an existing Object.
The Clientshall be authorized to modify the configuration for the SKSfunctionality and shall use at least a signed communication channel when invoking this Methodon the Server.
Signature
AddPushTarget(
[in]String ApplicationUri,
[in]String EndpointUrl,
[in]String SecurityPolicyUri,
[in]UserTokenPolicyUserTokenType,
[in] UInt16 RequestedKeyCount,
[in]Duration RetryInterval,
[out] NodeId PushTargetId
);
|
Argument |
Description |
|
ApplicationUri |
ApplicationUriof the Serverthat is the target of the key push. The ApplicationUriis used as name of the resulting PubSubKeyPushTargetobject. |
|
EndpointUrl |
URL of the Endpointof the Serverthat is the target of the key push |
|
SecurityPolicyUri |
Security policy the SKS shall use to establish a secure connection to the PushTarget |
|
UserTokenType |
The user token type used for the push. The default is Anonymoous. |
|
RequestedKeyCount |
The number of keys to push on each call |
|
RetryInterval |
Interval the SKSshall use to retry pushing keys after an error appeared |
|
PushTargetId |
The NodeIdof the added PubSubKeyPushTarget Object. |
Method Result Codes
|
ResultCode |
Description |
|
Bad_NodeIdExists |
A PushTargetwith the ApplicationUri already exists but the arguments do not match the existing object. |
|
Good_DataIgnored |
A Objectwith the configuration already exists and was returned without adding a new Object. |
|
Bad_InvalidArgument |
One of the input arguments is invalid. The InputArgumentResult provides further details. |
|
Bad_UserAccessDenied |
The Sessionuser is not allowed to configure the object. |
|
Bad_SecurityModeInsufficient |
The communication channel is not using signing. |
Table 187specifies the AddressSpacerepresentation for the AddPushTarget Method.
Table 187– AddPushTarget Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
AddPushTarget |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
OutputArguments |
Argument[] |
PropertyType |
Mandatory |
|
ConformanceUnits |
|||||
|
PubSub Model SKS Push |
|||||
This Methodis used to remove a PubSubKeyPushTargetfrom the PushTargetFolder.
The Clientshall be authorized to modify the configuration for the SKSfunctionality and shall use at least a signed communication channel when invoking this Methodon the Server.
Signature
RemovePushTarget(
[in]NodeIdPushTargetId
);
|
Argument |
Description |
|
PushTargetId |
NodeIdof the PushTargetType Object to remove from the Server |
Method Result Codes
|
ResultCode |
Description |
|
Bad_NodeIdUnknown |
The PushTargetId is unknown. |
|
Bad_NodeIdInvalid |
The PushTargetId is not a NodeIdof a PubSubKeyPushTarget Object. |
|
Bad_UserAccessDenied |
The Sessionuser is not allowed to delete the PushTargetType Object. |
|
Bad_SecurityModeInsufficient |
The communication channel is not using signing. |
Table 188specifies the AddressSpacerepresentation for the RemovePushTarget Method.
Table 188– RemovePushTarget Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
RemovePushTarget |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
Mandatory |
|
ConformanceUnits |
|||||
|
PubSub Model SKS Push |
|||||
This Methodis used to add a PubSubKeyPushTargetFolderType Objectto a PubSubKeyPushTargetFolderType Object.
The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.
Signature
AddPushTargetFolder(
[in]StringName,
[out]NodeIdPushTargetFolderNodeId
);
|
Argument |
Description |
|
Name |
Name of the Objectto create. |
|
PushTargetFolderNodeId |
NodeIdof the created PubSubKeyPushTargetFolderType Object. |
Method Result Codes
|
ResultCode |
Description |
|
Bad_BrowseNameDuplicated |
A folder Objectwith the name already exists. |
|
Bad_InvalidArgument |
The Serveris not able to apply the Name. The Namemay be too long or may contain invalid characters. |
|
Bad_UserAccessDenied |
The Sessionuser is not allowed to add a folder. |
Table 189specifies the AddressSpacerepresentation for the AddPushTargetFolder Method.
Table 189– AddPushTargetFolder Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
AddPushTargetFolder |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
OutputArguments |
Argument[] |
PropertyType |
Mandatory |
|
ConformanceUnits |
|||||
|
PubSub Model SKS Push |
|||||
This Methodis used to remove a PubSubKeyPushTargetFolderType Objectfrom the parent PubSubKeyPushTargetFolderType Object.
A successful removal of the PubSubKeyPushTargetFolderType Objectremovesrecursively all contained PubSubKeyPushTargetType Objectsand all containedPubSubKeyPushTargetFolderType Objects.
The Clientshall be authorized to modify the configuration for the PubSubfunctionality when invoking this Methodon the Server.
Signature
RemovePushTargetFolder(
[in]NodeIdPushTargetFolderNodeId
);
|
Argument |
Description |
|
PushTargetFolderNodeId |
NodeIdof the PubSubKeyPushTargetFolderType Objectto remove from the Server. |
Method Result Codes
|
ResultCode |
Description |
|
Bad_NodeIdUnknown |
The PushTargetFolderNodeId is unknown. |
|
Bad_UserAccessDenied |
The Sessionuser is not allowed to delete the folder. |
Table 190specifies the AddressSpacerepresentation for the RemovePushTargetFolder Method.
Table 190– RemovePushTargetFolder Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
RemovePushTargetFolder |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
Mandatory |
|
ConformanceUnits |
|||||
|
PubSub Model SKS Push |
|||||