@zeroc/ice
    Preparing search index...

    Class AdminSessionAbstract

    Represents an administrative session between an admin tool and an IceGrid registry.

    The Slice compiler generated this skeleton class from Slice interface ::IceGrid::AdminSession.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Methods

    • Destroys this session.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

    • 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.

    • Finishes updating the registry and releases the exclusive lock.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

      IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock.

    • Gets a proxy to the IceGrid admin object. The admin object returned by this operation can only be accessed by the session.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns AdminPrx | PromiseLike<AdminPrx>

      A promise like object representing the result of the dispatch, which resolves to:

      • IceGrid.AdminPrx | null : A proxy to the IceGrid admin object. This proxy is never null.
    • Gets a "template" proxy for admin callback objects. An Admin client uses this proxy to set the category of its callback objects, and the published endpoints of the object adapter hosting the admin callback objects.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns ObjectPrx | PromiseLike<ObjectPrx>

      A promise like object representing the result of the dispatch, which resolves to:

      • Ice.ObjectPrx | null : A template proxy. The returned proxy is null when the Admin session was established using Glacier2.
    • Gets the name of the registry replica hosting this session.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns string | PromiseLike<string>

      A promise like object representing the result of the dispatch, which resolves to:

      • string : The replica name of the registry.
    • 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>

    • Keeps the session alive.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

    • Opens a node stderr file for reading.

      Parameters

      • name: string

        The node name.

      • count: number

        Specifies where to start reading the file. If negative, the file is read from the beginning. Otherwise, the file is read from the last count lines.

      • current: Current

        The Current object for the dispatch.

      Returns FileIteratorPrx | PromiseLike<FileIteratorPrx>

      A promise like object representing the result of the dispatch, which resolves to:

      • IceGrid.FileIteratorPrx | null : An iterator to read the file. This proxy is never null.

      IceGrid.FileNotAvailableException Thrown when the file can't be read.

      IceGrid.NodeNotExistException Thrown when the node doesn't exist.

      IceGrid.NodeUnreachableException Thrown when the node is unreachable.

    • Opens a node stdout file for reading.

      Parameters

      • name: string

        The node name.

      • count: number

        Specifies where to start reading the file. If negative, the file is read from the beginning. Otherwise, the file is read from the last count lines.

      • current: Current

        The Current object for the dispatch.

      Returns FileIteratorPrx | PromiseLike<FileIteratorPrx>

      A promise like object representing the result of the dispatch, which resolves to:

      • IceGrid.FileIteratorPrx | null : An iterator to read the file. This proxy is never null.

      IceGrid.FileNotAvailableException Thrown when the file can't be read.

      IceGrid.NodeNotExistException Thrown when the node doesn't exist.

      IceGrid.NodeUnreachableException Thrown when the node is unreachable.

    • Opens a registry stderr file for reading.

      Parameters

      • name: string

        The registry name.

      • count: number

        Specifies where to start reading the file. If negative, the file is read from the beginning. Otherwise, the file is read from the last count lines.

      • current: Current

        The Current object for the dispatch.

      Returns FileIteratorPrx | PromiseLike<FileIteratorPrx>

      A promise like object representing the result of the dispatch, which resolves to:

      • IceGrid.FileIteratorPrx | null : An iterator to read the file. This proxy is never null.

      IceGrid.FileNotAvailableException Thrown when the file can't be read.

      IceGrid.RegistryNotExistException Thrown when the registry doesn't exist.

      IceGrid.RegistryUnreachableException Thrown when the registry is unreachable.

    • Opens a registry stdout file for reading.

      Parameters

      • name: string

        The registry name.

      • count: number

        Specifies where to start reading the file. If negative, the file is read from the beginning. Otherwise, the file is read from the last count lines.

      • current: Current

        The Current object for the dispatch.

      Returns FileIteratorPrx | PromiseLike<FileIteratorPrx>

      A promise like object representing the result of the dispatch, which resolves to:

      • IceGrid.FileIteratorPrx | null : An iterator to read the file. This proxy is never null.

      IceGrid.FileNotAvailableException Thrown when the file can't be read.

      IceGrid.RegistryNotExistException Thrown when the registry doesn't exist.

      IceGrid.RegistryUnreachableException Thrown when the registry is unreachable.

    • Opens a server log file for reading.

      Parameters

      • id: string

        The server ID.

      • path: string

        The path of the log file. A log file can be opened only if it's declared in the server or service deployment descriptor.

      • count: number

        Specifies where to start reading the file. If negative, the file is read from the beginning. Otherwise, the file is read from the last count lines.

      • current: Current

        The Current object for the dispatch.

      Returns FileIteratorPrx | PromiseLike<FileIteratorPrx>

      A promise like object representing the result of the dispatch, which resolves to:

      • IceGrid.FileIteratorPrx | null : An iterator to read the file. This proxy is never null.

      IceGrid.DeploymentException Thrown when the server couldn't be deployed on the node.

      IceGrid.FileNotAvailableException Thrown when the file can't be read.

      IceGrid.NodeUnreachableException Thrown when the node is unreachable.

      IceGrid.ServerNotExistException Thrown when the server doesn't exist.

    • Sets the observer identities that receive notifications when the state of the registry or nodes changes. This operation should be used by clients that are using a bidirectional connection to communicate with the session.

      Parameters

      • registryObs: Identity

        The registry observer identity.

      • nodeObs: Identity

        The node observer identity.

      • appObs: Identity

        The application observer.

      • adptObs: Identity

        The adapter observer.

      • objObs: Identity

        The object observer.

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

      IceGrid.ObserverAlreadyRegisteredException Thrown when an observer is already registered with this registry.

    • Acquires an exclusive lock to start updating the registry applications.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns number | PromiseLike<number>

      A promise like object representing the result of the dispatch, which resolves to:

      • number : The current serial.

      IceGrid.AccessDeniedException Thrown when the exclusive lock can't be acquired. This might happen if the lock is currently acquired by another session.

    • Obtains the Slice type ID of this type.

      Returns string

      The return value is always "::IceGrid::AdminSession".