Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UAServerConfiguration

If a Server supports Push Certificate Management it is required to support an information model as part of its address space. It shall support the ServerConfiguration Object shown here. This Object shall only be visible and accessible to administrators and/or the GDS.

Hierarchy

  • UAObject
  • UAObject
  • UAObject
    • UAServerConfiguration

Properties

Readonly addressSpace

addressSpace: AddressSpace

Optional applyChanges

applyChanges: UAMethod

The ApplyChanges Method is used to apply any security related changes if the Server sets the applyChangesRequired flag when another Method is called. Servers should minimize the impact of applying the new configuration, however, it could require that all existing Sessions be closed and re-opened by the Clients.

authorizationServices

authorizationServices: UAAuthorizationServicesFolder

Readonly browseName

browseName: QualifiedName

certificateGroups

certificateGroups: UACertificateGroupFolder

( OPCUA Specification part#12 GDS) The CertificateGroups Object organizes the Certificate Groups supported by the Server. Servers shall support the DefaultApplicationGroup and may support the DefaultHttpsGroup or the DefaultUserTokenGroup. Servers may support additional Certificate Groups depending on their requirements. For example, a Server with two network interfaces should have a different Trust List for each interface. The second Trust List would be represented as a new CertificateGroupType Object organized by CertificateGroups Folder.

createSigningRequest

createSigningRequest: UAMethod

The CreateSigningRequest Method asks the Server to create a PKCS #10 encoded Certificate Request that is signed with the Server’s private key.

Readonly description

description: LocalizedText

Readonly displayName

displayName: LocalizedText[]

getRejectedList

getRejectedList: UAMethod

The GetRejectedList Method returns the list of Certificates which have been rejected by the Server. It can be used to track activity or allow administrators to move a rejected Certificate into the Trust List

Readonly hasMethods

hasMethods: boolean

keyCredentialConfiguration

keyCredentialConfiguration: UAKeyCredentialConfigurationFolder

maxTrustListSize

maxTrustListSize: UAVariableT<UInt32, UInt32>

The MaxTrustListSize is the maximum size of the Trust List in bytes. 0 means no limit. The default is 65 535 bytes.

Optional Readonly modellingRule

modellingRule: ModellingRuleType

multicastDnsEnabled

multicastDnsEnabled: UAVariableT<UABoolean, Boolean>

If MulticastDnsEnabled is TRUE then the Server announces itself using multicast DNS. It can be changed by writing to the Variable.

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

serverCapabilities

serverCapabilities: UAVariableT<UAString[], String>

The ServerCapabilities Property specifies the capabilities from Annex D which the Server supports. The value is the same as the value reported to the LocalDiscoveryServer when the Server calls the RegisterServer2 Service

supportedPrivateKeyFormats

supportedPrivateKeyFormats: UAVariableT<UAString[], String>

The SupportedPrivateKeyFormats specifies the PrivateKey formats supported by the Server. Possible values include “PEM” (see RFC 5958) or “PFX” (see PKCS #12). The array is empty if the Server does not allow external Clients to update the PrivateKey

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

updateCertificate

updateCertificate: UAMethod

The UpdateCertificate Method is used to update a Certificate.

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

eventNames

  • eventNames(): Array<string | symbol>

findReference

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

findReferences

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

findReferencesAsObject

  • findReferencesAsObject(strReference: string, isForward: boolean): 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[]

getChildByName

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

getComponentByName

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

getComponents

  • getComponents(): BaseNode[]

getEventSourceOfs

  • getEventSourceOfs(): BaseNode[]

getEventSources

  • getEventSources(): BaseNode[]

getFolderElementByName

  • getFolderElementByName(browseName: string, namespaceIndex?: number): 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[]

getProperties

  • getProperties(): BaseNode[]

getPropertyByName

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

install_extra_properties

  • install_extra_properties(): void

listenerCount

  • listenerCount(event: string | symbol): number

listeners

  • listeners(event: string | symbol): 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

prependListener

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

prependOnceListener

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

propagate_back_references

  • propagate_back_references(): void

raiseEvent

rawListeners

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

readAttribute

removeAllListeners

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

removeListener

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

removeReference

setMaxListeners

  • setMaxListeners(n: number): this

writeAttribute

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

Generated using TypeDoc