Class SessionContext

Implements

ISessionContext

Constructors

constructor

new SessionContext(options?: SessionContextOptions): SessionContext
Parameters
- Optionaloptions: SessionContextOptions
Returns SessionContext
- Defined in packages/node-opcua-address-space/source/session_context.ts:243

Properties

continuationPoints

continuationPoints: Buffer<ArrayBufferLike>[] = []

`Optional`currentTime

currentTime?: PreciseClock

Server timestamp at the time the request was received.

object

object: UAObjectType | UAObject<UAObjectEvents> | undefined

The object on which the current operation is being performed.

`Optional` `Readonly`server

server?: IServerBase

`Optional` `Readonly`session

session?: ISessionBase

The underlying OPC UA session, if available.

`Static`defaultContext

defaultContext: SessionContext = ...

Accessors

clientApplicationUri

get clientApplicationUri(): string | null
The application URI extracted from the client certificate's SubjectAltName, or null if no certificate is available.

Returns string | null
Implementation of ISessionContext.clientApplicationUri
- Defined in packages/node-opcua-address-space/source/session_context.ts:264

clientCertificate

get clientCertificate(): DER | null
The client's application-instance certificate, or null if no secure channel is available.

Returns DER | null
Implementation of ISessionContext.clientCertificate
- Defined in packages/node-opcua-address-space/source/session_context.ts:255

endpointUrl

get endpointUrl(): string | null
The URL of the Endpoint the Session was created on, or null if unknown.

Returns string | null
Implementation of ISessionContext.endpointUrl
- Defined in packages/node-opcua-address-space/source/session_context.ts:279

Methods

checkPermission

checkPermission(node: BaseNode, requestedPermission: PermissionType): boolean
Check whether the current user has the given permission on a node.
Parameters
- node: BaseNode
- requestedPermission: PermissionType
Returns boolean
Implementation of ISessionContext.checkPermission
- Defined in packages/node-opcua-address-space/source/session_context.ts:456

currentUserHasRole

currentUserHasRole(role: NodeIdLike): boolean
Returns true if the current user has the given role.
Parameters
- role: NodeIdLike
Returns boolean
Implementation of ISessionContext.currentUserHasRole
- Defined in packages/node-opcua-address-space/source/session_context.ts:461

getAccessRestrictions

getAccessRestrictions(node: BaseNode): AccessRestrictionsFlag
Parameters
- node: BaseNode
Returns AccessRestrictionsFlag
- Defined in packages/node-opcua-address-space/source/session_context.ts:403

getApplicableRolePermissions

getApplicableRolePermissions(node: BaseNode): RolePermissionType[] | null
Parameters
- node: BaseNode
Returns RolePermissionType[] | null
- Defined in packages/node-opcua-address-space/source/session_context.ts:382

getCurrentUserRoles

getCurrentUserRoles(): NodeId[]
getCurrentUserRoles

guest => anonymous user (unauthenticated) default => default authenticated user

Returns NodeId[]
Implementation of ISessionContext.getCurrentUserRoles
- Defined in packages/node-opcua-address-space/source/session_context.ts:319

getPermissions

getPermissions(node: BaseNode): PermissionFlag
Parameters
- node: BaseNode
Returns PermissionFlag
- Defined in packages/node-opcua-address-space/source/session_context.ts:390

getUserName

getUserName(): string
Returns the user name of the current user.

Returns string
Implementation of ISessionContext.getUserName
- Defined in packages/node-opcua-address-space/source/session_context.ts:302

isAccessRestricted

isAccessRestricted(node: BaseNode): boolean
Parameters
- node: BaseNode
Returns boolean
true if the context is access restricted
Implementation of ISessionContext.isAccessRestricted
- Defined in packages/node-opcua-address-space/source/session_context.ts:428

isBrowseAccessRestricted

isBrowseAccessRestricted(node: BaseNode): boolean
Parameters
- node: BaseNode
Returns boolean
true if the browse is denied (access is restricted)
Implementation of ISessionContext.isBrowseAccessRestricted
- Defined in packages/node-opcua-address-space/source/session_context.ts:417

toJSON

toJSON(): Record<string, string | null>
Returns a JSON representation of the context

Returns Record<string, string | null>
Implementation of ISessionContext.toJSON
- Defined in packages/node-opcua-address-space/source/session_context.ts:283

toString

toString(): string
Returns a string representation of the context

Returns string
Implementation of ISessionContext.toString
- Defined in packages/node-opcua-address-space/source/session_context.ts:291

Class SessionContext

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SessionContext

Properties

continuationPoints

OptionalcurrentTime

object

Optional Readonlyserver

Optional Readonlysession

StaticdefaultContext

Accessors

clientApplicationUri

Returns string | null

clientCertificate

Returns DER | null

endpointUrl

Returns string | null

Methods

checkPermission

Parameters

Returns boolean

currentUserHasRole

Parameters

Returns boolean

getAccessRestrictions

Parameters

Returns AccessRestrictionsFlag

getApplicableRolePermissions

Parameters

Returns RolePermissionType[] | null

getCurrentUserRoles

Returns NodeId[]

getPermissions

Parameters

Returns PermissionFlag

getUserName

Returns string

isAccessRestricted

Parameters

Returns boolean

isBrowseAccessRestricted

Parameters

Returns boolean

toJSON

Returns Record<string, string | null>

toString

Returns string

Settings

On This Page

`Optional`currentTime

`Optional` `Readonly`server

`Optional` `Readonly`session

`Static`defaultContext