@zeroc/ice
    Preparing search index...

    Class PermissionsVerifierAbstract

    Represents an object that checks user permissions. The Glacier2 router and other services use a Glacier2.PermissionsVerifierPrx proxy when the user is authenticated using a user ID and password.

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    • Checks if a user is authorized to establish a session.

      Parameters

      • userId: string

        The user ID.

      • password: string

        The user's password.

      • current: Current

        The Current object for the dispatch.

      Returns [boolean, string] | PromiseLike<[boolean, string]>

      A promise like object representing the result of the dispatch, which resolves to an array with the following entries:

      • boolean : true if access is granted, false otherwise.
      • string : The reason why access was denied.

      Glacier2.PermissionDeniedException Thrown when the user's access is denied. This exception can be thrown instead of returning false with a reason set in the reason out parameter.

    • Dispatches an incoming request to one of the methods of this generated class, based on the operation name carried by the request.

      Parameters

      Returns OutgoingResponse | PromiseLike<OutgoingResponse>

      The outgoing response (when the selected method returns a value), or a promise with the outgoing response (when the selected method returns a promise).

      Ice marshals any exception thrown by this method into the response.

    • Returns the Slice type ID of the most-derived interface supported by this object.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns string | PromiseLike<string>

      The Slice type ID of the most-derived interface.

    • Returns the Slice type IDs of the interfaces supported by this object.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns string[] | PromiseLike<string[]>

      The Slice type IDs of the interfaces supported by this object, in alphabetical order.

    • Tests whether this object supports a specific Slice interface.

      Parameters

      • typeID: string

        The type ID of the Slice interface to test against.

      • current: Current

        The Current object for the invocation.

      Returns boolean | PromiseLike<boolean>

      True if this object has the interface specified by typeID or derives from the interface specified by typeID.

    • Tests whether this object can be reached.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns void | PromiseLike<void>

    • Obtains the Slice type ID of this type.

      Returns string

      The return value is always "::Glacier2::PermissionsVerifier".