@zeroc/ice
    Preparing search index...

    Class PermissionsVerifierPrx

    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.

    The Slice compiler generated this proxy class from Slice interface ::Glacier2::PermissionsVerifier.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    checkPermissions equals ice_adapterId ice_batchOneway ice_connectionCached ice_connectionId ice_context ice_encodingVersion ice_endpoints ice_endpointSelection ice_facet ice_fixed ice_flushBatchRequests ice_getAdapterId ice_getCachedConnection ice_getCommunicator ice_getConnection ice_getConnectionId ice_getContext ice_getEncodingVersion ice_getEndpoints ice_getEndpointSelection ice_getFacet ice_getIdentity ice_getInvocationTimeout ice_getLocator ice_getLocatorCacheTimeout ice_getRouter ice_id ice_identity ice_ids ice_invocationTimeout ice_isA ice_isBatchOneway ice_isConnectionCached ice_isFixed ice_isOneway ice_isTwoway ice_locator ice_locatorCacheTimeout ice_oneway ice_ping ice_router ice_toString ice_twoway checkedCast ice_staticId uncheckedCast

    Constructors

    • Constructs a new PermissionsVerifierPrx proxy.

      Parameters

      • communicator: Communicator

        The communicator for the new proxy.

      • proxyString: string

        The string representation of the proxy.

      Returns PermissionsVerifierPrx

      The new PermissionsVerifierPrx proxy.

      ParseException - Thrown if the proxyString is not a valid proxy string.

    Methods

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

      Parameters

      • userId: string

        The user ID.

      • password: string

        The user's password.

      • Optionalcontext: Map<string, string>

        The Context map to send with the invocation.

      Returns AsyncResult<[boolean, string]>

      An Ice.AsyncResult object representing the result of the invocation, 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.

    • Checks whether the specified object is equal to this object.

      Parameters

      Returns boolean

      true if the specified object is equal to this object, false otherwise.

    • Creates a proxy that is identical to this proxy, except for the adapter ID.

      Parameters

      • id: string

        The adapter ID for the new proxy.

      Returns this

      A proxy with the new adapter ID.

    • Creates a proxy that is identical to this proxy, but uses batch oneway invocations.

      Returns this

      A proxy that uses batch oneway invocations.

    • Creates a proxy that is identical to this proxy, except for connection caching.

      Parameters

      • cache: boolean

        true if the new proxy should cache connections, false otherwise.

      Returns this

      A proxy with the specified caching policy.

    • Creates a proxy that is identical to this proxy, except for its connection ID.

      Parameters

      • connectionId: string

        The connection ID for the new proxy. An empty string removes the connection ID.

      Returns this

      A proxy with the specified connection ID.

    • Creates a proxy that is identical to this proxy, except for the per-proxy context.

      Parameters

      • context: Map<string, string>

        The context for the new proxy.

      Returns this

      A proxy with the new per-proxy context.

    • Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.

      Parameters

      • version: EncodingVersion

        The encoding version to use to marshal request parameters.

      Returns this

      A proxy with the specified encoding version.

    • Creates a proxy that is identical to this proxy, except for the endpoints.

      Parameters

      • endpoints: Endpoint[]

        The endpoints for the new proxy.

      Returns this

      A proxy with the new endpoints.

    • Creates a proxy that is identical to this proxy, except for the facet.

      Parameters

      • facet: string

        The facet for the new proxy.

      Returns this

      A proxy with the new facet.

    • Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.

      Parameters

      • connection: Connection

        The fixed proxy connection.

      Returns this

      A fixed proxy bound to the given connection.

    • Flushes any pending batched requests for this proxy.

      Returns AsyncResult<void>

      An asynchronous result that is resolved when the pending batched requests for this proxy are flushed.

    • Gets the adapter ID for this proxy.

      Returns string

      The adapter ID. If the proxy does not have an adapter ID, the return value is the empty string.

    • Gets the cached Connection for this proxy. If the proxy does not yet have an established connection, it does not attempt to create a connection.

      Returns Connection

      The cached connection for this proxy, or null if the proxy does not have an established connection.

    • Gets the connection ID of this proxy.

      Returns AsyncResult<Connection>

      An asynchronous result that resolves to the connection used by this proxy.

      You can call this function to establish a connection or associate the proxy with an existing connection.

    • Gets the connection ID of this proxy.

      Returns string

      The connection ID.

    • Gets the per-proxy context for this proxy.

      Returns Map<string, string>

      The per-proxy context.

    • Gets the facet for this proxy.

      Returns string

      The facet for this proxy. If the proxy uses the default facet, the return value is the empty string.

    • Gets the invocation timeout of this proxy.

      Returns number

      The invocation timeout value.

    • Gets the locator cache timeout of this proxy.

      Returns number

      The locator cache timeout value.

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

      Parameters

      • Optionalcontext: Map<string, string>

        The request context.

      Returns AsyncResult<string>

      An asynchronous result that resolves to the Slice type ID of the most-derived interface.

    • Creates a proxy that is identical to this proxy, except for the identity.

      Parameters

      • id: Identity

        The identity for the new proxy.

      Returns this

      A proxy with the new identity.

    • Gets the Slice interfaces supported by this object as a list of Slice type IDs.

      Parameters

      • Optionalcontext: Map<string, string>

        The request context.

      Returns AsyncResult<string[]>

      An asynchronous result that resolves to an array of the Slice type IDs of the interfaces supported by this object, in alphabetical order

    • Creates a proxy that is identical to this proxy, except for the invocation timeout.

      Parameters

      • timeout: number

        The new invocation timeout (in milliseconds).

      Returns this

      A proxy with the new timeout.

    • Tests whether this object supports a specific Slice interface.

      Parameters

      • typeId: string

        The type ID of the Slice interface to test against.

      • Optionalcontext: Map<string, string>

        The request context.

      Returns AsyncResult<boolean>

      An asynchronous result that resolves to true if the target object implements the Slice interface specified by typeId or implements a derived interface, false otherwise.

    • Determines whether this proxy uses batch oneway invocations.

      Returns boolean

      true if this proxy uses batch oneway invocations, false otherwise.

    • Determines whether this proxy caches connections.

      Returns boolean

      true if this proxy caches connections, false otherwise.

    • Determines whether this proxy is a fixed proxy.

      Returns boolean

      true if this proxy is a fixed proxy, false otherwise.

    • Determines whether this proxy uses oneway invocations.

      Returns boolean

      true if this proxy uses oneway invocations, false otherwise.

    • Determines whether this proxy uses twoway invocations.

      Returns boolean

      true if this proxy uses twoway invocations, false otherwise.

    • Creates a proxy that is identical to this proxy, except for the locator.

      Parameters

      • locator: LocatorPrx

        The locator for the new proxy.

      Returns this

      A proxy with the specified locator.

    • Creates a proxy that is identical to this proxy, except for the locator cache timeout.

      Parameters

      • timeout: number

        The new locator cache timeout (in seconds).

      Returns this

      A proxy with the new timeout.

    • Creates a proxy that is identical to this proxy, but uses oneway invocations.

      Returns this

      A proxy that uses oneway invocations.

    • Tests whether the target object of this proxy can be reached.

      Parameters

      • Optionalcontext: Map<string, string>

        The request context.

      Returns AsyncResult<void>

      An asynchronous result that resolves when the ping operation completes.

    • Creates a proxy that is identical to this proxy, except for the router.

      Parameters

      Returns this

      A proxy with the specified router.

    • Creates a stringified version of this proxy.

      Returns string

      A stringified proxy.

    • Creates a proxy that is identical to this proxy, but uses twoway invocations.

      Returns this

      A proxy that uses twoway invocations.

    • Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.

      Parameters

      • prx: ObjectPrx

        The source proxy.

      • Optionalfacet: string

        An optional facet name.

      • Optionalcontext: Map<string, string>

        The request context.

      Returns AsyncResult<PermissionsVerifierPrx>

      A proxy with the requested type and facet, or null if the target object does not support the requested type.

    • Returns the Slice type ID associated with this type.

      Returns string

      The Slice type ID.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods