Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Role

The Properties and Methods of the Role contain sensitive security related information and shall only be browse-able, writeable and callable by authorized administrators through an encrypted channel.

Hierarchy

  • UAObject
    • Role

Properties

Optional addApplication

addApplication: UAMethod

The AddApplication Method adds an Application Instance Certificate to the list of. If the Server does not enforce application restrictions or does not allow changes to the mapping rules for the Role the Method is not present.

Optional addEndpoint

addEndpoint: UAMethod

Optional addIdentity

addIdentity: UAMethod

The AddIdentity Method adds a rule used to map a UserIdentityToken to the Role. If the Server does not allow changes to the mapping rules, then the Method is not present. A Server should prevent certain rules from being added to particular Roles. For example, a Server should refuse to allow an ANONYMOUS_5 (see F.3.2) mapping rule to be added to Roles with administrator privileges.

Readonly addressSpace

addressSpace: AddressSpace

Optional applications

applications: UAVariableT<UAString, String>

The Applications Property specifies the Application Instance Certificates of Clients which shall be included or excluded from this Role. Each element in the array is an ApplicationUri from a Client Certificate which is trusted by the Server.

Optional applicationsExclude

applicationsExclude: UAVariableT<boolean, Boolean>

The ApplicationsExclude Property defines the Applications Property as an include list or exclude list. If this Property is not provided or has a value of FALSE then only Application Instance Certificates included in the Applications Property shall be included in this Role. All other Application Instance Certificates shall not be included in this Role. If this Property has a value of TRUE then all Application Instance Certificates included in the Applications Property shall be excluded from this Role. All other Application Instance Certificates shall be included in this Role.

Readonly browseName

browseName: QualifiedName

Readonly description

description: LocalizedText

Readonly displayName

displayName: LocalizedText[]

Optional endpoints

endpoints: UAVariable

The Endpoints Property specifies the Endpoints which shall be included or excluded from this Role. The value is an EndpointType array which contains one or more Endpoint descriptions. The EndpointType DataType is defined in 12.22.

Optional endpointsExclude

endpointsExclude: UAVariableT<boolean, Boolean>

The EndpointsExclude Property defines the Endpoints Property as an include list or exclude list. If this Property is not provided or has a value of FALSE then only Endpoints included in the Endpoints Property shall be included in this Role. All other Endpoints shall not be include this Role. If this Property has a value of TRUE then all Endpoints included in the Endpoints Property shall be excluded from this Role. All other Endpoints shall be included in this Role.

Readonly hasMethods

hasMethods: boolean

identities

identities: UAVariableT<IdentityMappingRuleType, ExtensionObject>

The Identities Property specifies the currently configured rules for mapping a UserIdentityToken to the Role. If this Property is an empty array, then the Role cannot be granted to any Session.

Optional Readonly modellingRule

modellingRule: ModellingRuleType

Readonly namespace

namespace: Namespace

Readonly namespaceIndex

namespaceIndex: number

Readonly namespaceUri

namespaceUri: string

Readonly nodeClass

nodeClass: Object

Readonly nodeId

nodeId: NodeId

Optional onFirstBrowseAction

onFirstBrowseAction: function

Type declaration

    • (this: BaseNode): Promise<void>
    • Parameters

      • this: BaseNode

      Returns Promise<void>

parent

parent: BaseNode | null

Optional Readonly parentNodeId

parentNodeId: NodeId

Optional removeApplication

removeApplication: UAMethod

The RemoveApplication Method removes an Application Instance Certificate from the list of applications. If the Server does not enforce application restrictions or does not allow changes to the mapping rules for the Role the Method is not present.

Optional removeEndpoint

removeEndpoint: UAMethod

Optional removeIdentity

removeIdentity: UAMethod

The RemoveIdentity Method removes a mapping rule used to map a UserIdentityToken to the Role. If the Server does not allow changes to the mapping rules, then the Method is not present

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Methods

addListener

  • addListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

addReference

allReferences

browseNode

  • browseNode(browseDescription: BrowseDescriptionOptions, session?: SessionContext): ReferenceDescription[]
  • browse the node to extract information requested in browseDescription

    method

    browseNode

    Parameters

    • browseDescription: BrowseDescriptionOptions
    • Optional session: SessionContext

    Returns ReferenceDescription[]

clone

  • clone(options: any, optionalFilter?: any, extraInfo?: any): UAObject
  • Parameters

    • options: any
    • Optional optionalFilter: any
    • Optional extraInfo: any

    Returns UAObject

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

findReference

  • findReference(strReference: string, isForward?: boolean): UAReference | null
  • Parameters

    • strReference: string
    • Optional isForward: boolean

    Returns UAReference | null

findReferences

  • findReferences(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): UAReference[]
  • Parameters

    • referenceType: string | NodeId | UAReferenceType
    • Optional isForward: boolean

    Returns UAReference[]

findReferencesAsObject

  • findReferencesAsObject(strReference: string, isForward: boolean): BaseNode[]
  • Parameters

    • strReference: string
    • isForward: boolean

    Returns BaseNode[]

findReferencesEx

findReferencesExAsObject

  • findReferencesExAsObject(strReference: string, browseDirection?: BrowseDirection): BaseNode[]

fullName

  • fullName(): string
  • return a complete name of this object by pre-pending name of its parent(s) to its own name

    Returns string

getAggregates

  • getAggregates(): BaseNode[]
  • Returns BaseNode[]

getChildByName

  • getChildByName(browseName: string | QualifiedName): BaseNode | null
  • Parameters

    • browseName: string | QualifiedName

    Returns BaseNode | null

getComponentByName

  • getComponentByName(componentName: QualifiedNameLike, namespaceIndex?: number): UAObject | UAVariable | null

getComponents

  • getComponents(): BaseNode[]
  • Returns BaseNode[]

getEventSourceOfs

  • getEventSourceOfs(): BaseNode[]
  • return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

    Returns BaseNode[]

getEventSources

  • getEventSources(): BaseNode[]
  • return a array with the event source of this object. self = HasEventSource => nodes

    Returns BaseNode[]

getFolderElementByName

  • getFolderElementByName(browseName: string, namespaceIndex?: number): BaseNode | null
  • Parameters

    • browseName: string
    • Optional namespaceIndex: number

    Returns BaseNode | null

getMaxListeners

  • getMaxListeners(): number

getMethodById

  • getMethodById(nodeId: NodeId): UAMethod | null
  • Parameters

    • nodeId: NodeId

    Returns UAMethod | null

getMethodByName

  • getMethodByName(methodName: string): UAMethod | null
  • Parameters

    • methodName: string

    Returns UAMethod | null

getMethods

  • getMethods(): UAMethod[]
  • Returns UAMethod[]

getNotifiers

  • getNotifiers(): BaseNode[]
  • Returns BaseNode[]

getProperties

  • getProperties(): BaseNode[]
  • Returns BaseNode[]

getPropertyByName

  • getPropertyByName(browseName: string, namespaceIndex?: number): UAVariable | null
  • Parameters

    • browseName: string
    • Optional namespaceIndex: number

    Returns UAVariable | null

install_extra_properties

  • install_extra_properties(): void

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(eventName: "event", eventHandler: function): this
  • Parameters

    • eventName: "event"
    • eventHandler: function

    Returns this

once

  • once(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

propagate_back_references

  • propagate_back_references(): void
  • this methods propagates the forward references to the pointed node by inserting backward references to the counter part node

    Returns void

raiseEvent

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

readAttribute

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

removeReference

setMaxListeners

  • setMaxListeners(n: number): this

writeAttribute

  • writeAttribute(context: SessionContext, writeValue: any, callback: function): void
  • Parameters

    • context: SessionContext
    • writeValue: any
    • callback: function
        • (err: Error | null, statusCode?: StatusCode): void
        • Parameters

          • err: Error | null
          • Optional statusCode: StatusCode

          Returns void

    Returns void

Generated using TypeDoc