Module com.zeroc.icegrid
Package com.zeroc.IceGrid

Interface AdminSessionPrx

All Superinterfaces:
ObjectPrx, SessionPrx
public interface AdminSessionPrx extends SessionPrx
Represents an administrative session between an admin tool and an IceGrid registry.
See Also:

  • Method Details

    • keepAlive

      default void keepAlive()
      Keeps the session alive.

    • keepAlive

      default void keepAlive(Map<String,String> context)
      Keeps the session alive.
      Parameters:
      context - The Context map to send with the invocation.

    • keepAliveAsync

      default CompletableFuture<Void> keepAliveAsync()
      Keeps the session alive.
      Returns:
      A future that will be completed when the invocation completes.

    • keepAliveAsync

      default CompletableFuture<Void> keepAliveAsync(Map<String,String> context)
      Keeps the session alive.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • getAdmin

      default AdminPrx getAdmin()
      Gets a proxy to the IceGrid admin object. The admin object returned by this operation can only be accessed by the session.
      Returns:
      A proxy to the IceGrid admin object. This proxy is never null.

    • getAdmin

      default AdminPrx getAdmin(Map<String,String> context)
      Gets a proxy to the IceGrid admin object. The admin object returned by this operation can only be accessed by the session.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the IceGrid admin object. This proxy is never null.

    • getAdminAsync

      default CompletableFuture<AdminPrx> getAdminAsync()
      Gets a proxy to the IceGrid admin object. The admin object returned by this operation can only be accessed by the session.
      Returns:
      A proxy to the IceGrid admin object. This proxy is never null.

    • getAdminAsync

      default CompletableFuture<AdminPrx> getAdminAsync(Map<String,String> context)
      Gets a proxy to the IceGrid admin object. The admin object returned by this operation can only be accessed by the session.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the IceGrid admin object. This proxy is never null.

    • getAdminCallbackTemplate

      default ObjectPrx getAdminCallbackTemplate()
      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.
      Returns:
      A template proxy. The returned proxy is null when the Admin session was established using Glacier2.

    • getAdminCallbackTemplate

      default ObjectPrx getAdminCallbackTemplate(Map<String,String> context)
      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:
      context - The Context map to send with the invocation.
      Returns:
      A template proxy. The returned proxy is null when the Admin session was established using Glacier2.

    • getAdminCallbackTemplateAsync

      default CompletableFuture<ObjectPrx> getAdminCallbackTemplateAsync()
      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.
      Returns:
      A template proxy. The returned proxy is null when the Admin session was established using Glacier2.

    • getAdminCallbackTemplateAsync

      default CompletableFuture<ObjectPrx> getAdminCallbackTemplateAsync(Map<String,String> context)
      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:
      context - The Context map to send with the invocation.
      Returns:
      A template proxy. The returned proxy is null when the Admin session was established using Glacier2.

    • setObservers

      default void setObservers(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs) throws ObserverAlreadyRegisteredException
      Sets the observer proxies that receive notifications when the state of the registry or nodes changes.
      Parameters:
      registryObs - The registry observer.
      nodeObs - The node observer.
      appObs - The application observer.
      adptObs - The adapter observer.
      objObs - The object observer.
      Throws:
      ObserverAlreadyRegisteredException - Thrown when an observer is already registered with this registry.

    • setObservers

      default void setObservers(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs, Map<String,String> context) throws ObserverAlreadyRegisteredException
      Sets the observer proxies that receive notifications when the state of the registry or nodes changes.
      Parameters:
      registryObs - The registry observer.
      nodeObs - The node observer.
      appObs - The application observer.
      adptObs - The adapter observer.
      objObs - The object observer.
      context - The Context map to send with the invocation.
      Throws:
      ObserverAlreadyRegisteredException - Thrown when an observer is already registered with this registry.

    • setObserversAsync

      default CompletableFuture<Void> setObserversAsync(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs)
      Sets the observer proxies that receive notifications when the state of the registry or nodes changes.
      Parameters:
      registryObs - The registry observer.
      nodeObs - The node observer.
      appObs - The application observer.
      adptObs - The adapter observer.
      objObs - The object observer.
      Returns:
      A future that will be completed when the invocation completes.

    • setObserversAsync

      default CompletableFuture<Void> setObserversAsync(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs, Map<String,String> context)
      Sets the observer proxies that receive notifications when the state of the registry or nodes changes.
      Parameters:
      registryObs - The registry observer.
      nodeObs - The node observer.
      appObs - The application observer.
      adptObs - The adapter observer.
      objObs - The object observer.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • setObserversByIdentity

      default void setObserversByIdentity(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs) throws ObserverAlreadyRegisteredException
      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 - The registry observer identity.
      nodeObs - The node observer identity.
      appObs - The application observer.
      adptObs - The adapter observer.
      objObs - The object observer.
      Throws:
      ObserverAlreadyRegisteredException - Thrown when an observer is already registered with this registry.

    • setObserversByIdentity

      default void setObserversByIdentity(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs, Map<String,String> context) throws ObserverAlreadyRegisteredException
      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 - The registry observer identity.
      nodeObs - The node observer identity.
      appObs - The application observer.
      adptObs - The adapter observer.
      objObs - The object observer.
      context - The Context map to send with the invocation.
      Throws:
      ObserverAlreadyRegisteredException - Thrown when an observer is already registered with this registry.

    • setObserversByIdentityAsync

      default CompletableFuture<Void> setObserversByIdentityAsync(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs)
      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 - The registry observer identity.
      nodeObs - The node observer identity.
      appObs - The application observer.
      adptObs - The adapter observer.
      objObs - The object observer.
      Returns:
      A future that will be completed when the invocation completes.

    • setObserversByIdentityAsync

      default CompletableFuture<Void> setObserversByIdentityAsync(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs, Map<String,String> context)
      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 - The registry observer identity.
      nodeObs - The node observer identity.
      appObs - The application observer.
      adptObs - The adapter observer.
      objObs - The object observer.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • startUpdate

      default int startUpdate() throws AccessDeniedException
      Acquires an exclusive lock to start updating the registry applications.
      Returns:
      The current serial.
      Throws:
      AccessDeniedException - Thrown when the exclusive lock can't be acquired. This might happen if the lock is currently acquired by another session.

    • startUpdate

      default int startUpdate(Map<String,String> context) throws AccessDeniedException
      Acquires an exclusive lock to start updating the registry applications.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The current serial.
      Throws:
      AccessDeniedException - Thrown when the exclusive lock can't be acquired. This might happen if the lock is currently acquired by another session.

    • startUpdateAsync

      default CompletableFuture<Integer> startUpdateAsync()
      Acquires an exclusive lock to start updating the registry applications.
      Returns:
      The current serial.

    • startUpdateAsync

      default CompletableFuture<Integer> startUpdateAsync(Map<String,String> context)
      Acquires an exclusive lock to start updating the registry applications.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The current serial.

    • finishUpdate

      default void finishUpdate() throws AccessDeniedException
      Finishes updating the registry and releases the exclusive lock.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock.

    • finishUpdate

      default void finishUpdate(Map<String,String> context) throws AccessDeniedException
      Finishes updating the registry and releases the exclusive lock.
      Parameters:
      context - The Context map to send with the invocation.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock.

    • finishUpdateAsync

      default CompletableFuture<Void> finishUpdateAsync()
      Finishes updating the registry and releases the exclusive lock.
      Returns:
      A future that will be completed when the invocation completes.

    • finishUpdateAsync

      default CompletableFuture<Void> finishUpdateAsync(Map<String,String> context)
      Finishes updating the registry and releases the exclusive lock.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • getReplicaName

      default String getReplicaName()
      Gets the name of the registry replica hosting this session.
      Returns:
      The replica name of the registry.

    • getReplicaName

      default String getReplicaName(Map<String,String> context)
      Gets the name of the registry replica hosting this session.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The replica name of the registry.

    • getReplicaNameAsync

      default CompletableFuture<String> getReplicaNameAsync()
      Gets the name of the registry replica hosting this session.
      Returns:
      The replica name of the registry.

    • getReplicaNameAsync

      default CompletableFuture<String> getReplicaNameAsync(Map<String,String> context)
      Gets the name of the registry replica hosting this session.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The replica name of the registry.

    • openServerLog

      default FileIteratorPrx openServerLog(String id, String path, int count) throws FileNotAvailableException, ServerNotExistException, NodeUnreachableException, DeploymentException
      Opens a server log file for reading.
      Parameters:
      id - The server ID.
      path - 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 - 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.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      DeploymentException - Thrown when the server couldn't be deployed on the node.
      FileNotAvailableException - Thrown when the file can't be read.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • openServerLog

      default FileIteratorPrx openServerLog(String id, String path, int count, Map<String,String> context) throws FileNotAvailableException, ServerNotExistException, NodeUnreachableException, DeploymentException
      Opens a server log file for reading.
      Parameters:
      id - The server ID.
      path - 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 - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      DeploymentException - Thrown when the server couldn't be deployed on the node.
      FileNotAvailableException - Thrown when the file can't be read.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • openServerLogAsync

      default CompletableFuture<FileIteratorPrx> openServerLogAsync(String id, String path, int count)
      Opens a server log file for reading.
      Parameters:
      id - The server ID.
      path - 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 - 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.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openServerLogAsync

      default CompletableFuture<FileIteratorPrx> openServerLogAsync(String id, String path, int count, Map<String,String> context)
      Opens a server log file for reading.
      Parameters:
      id - The server ID.
      path - 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 - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openServerStdErr

      default FileIteratorPrx openServerStdErr(String id, int count) throws FileNotAvailableException, ServerNotExistException, NodeUnreachableException, DeploymentException
      Opens a server stderr file for reading.
      Parameters:
      id - The server ID.
      count - 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.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      DeploymentException - Thrown when the server couldn't be deployed on the node.
      FileNotAvailableException - Thrown when the file can't be read.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • openServerStdErr

      default FileIteratorPrx openServerStdErr(String id, int count, Map<String,String> context) throws FileNotAvailableException, ServerNotExistException, NodeUnreachableException, DeploymentException
      Opens a server stderr file for reading.
      Parameters:
      id - The server ID.
      count - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      DeploymentException - Thrown when the server couldn't be deployed on the node.
      FileNotAvailableException - Thrown when the file can't be read.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • openServerStdErrAsync

      default CompletableFuture<FileIteratorPrx> openServerStdErrAsync(String id, int count)
      Opens a server stderr file for reading.
      Parameters:
      id - The server ID.
      count - 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.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openServerStdErrAsync

      default CompletableFuture<FileIteratorPrx> openServerStdErrAsync(String id, int count, Map<String,String> context)
      Opens a server stderr file for reading.
      Parameters:
      id - The server ID.
      count - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openServerStdOut

      default FileIteratorPrx openServerStdOut(String id, int count) throws FileNotAvailableException, ServerNotExistException, NodeUnreachableException, DeploymentException
      Opens a server stdout file for reading.
      Parameters:
      id - The server id.
      count - 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.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      DeploymentException - Thrown when the server couldn't be deployed on the node.
      FileNotAvailableException - Thrown when the file can't be read.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • openServerStdOut

      default FileIteratorPrx openServerStdOut(String id, int count, Map<String,String> context) throws FileNotAvailableException, ServerNotExistException, NodeUnreachableException, DeploymentException
      Opens a server stdout file for reading.
      Parameters:
      id - The server id.
      count - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      DeploymentException - Thrown when the server couldn't be deployed on the node.
      FileNotAvailableException - Thrown when the file can't be read.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • openServerStdOutAsync

      default CompletableFuture<FileIteratorPrx> openServerStdOutAsync(String id, int count)
      Opens a server stdout file for reading.
      Parameters:
      id - The server id.
      count - 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.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openServerStdOutAsync

      default CompletableFuture<FileIteratorPrx> openServerStdOutAsync(String id, int count, Map<String,String> context)
      Opens a server stdout file for reading.
      Parameters:
      id - The server id.
      count - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openNodeStdErr

      default FileIteratorPrx openNodeStdErr(String name, int count) throws FileNotAvailableException, NodeNotExistException, NodeUnreachableException
      Opens a node stderr file for reading.
      Parameters:
      name - The node name.
      count - 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.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      FileNotAvailableException - Thrown when the file can't be read.
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • openNodeStdErr

      default FileIteratorPrx openNodeStdErr(String name, int count, Map<String,String> context) throws FileNotAvailableException, NodeNotExistException, NodeUnreachableException
      Opens a node stderr file for reading.
      Parameters:
      name - The node name.
      count - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      FileNotAvailableException - Thrown when the file can't be read.
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • openNodeStdErrAsync

      default CompletableFuture<FileIteratorPrx> openNodeStdErrAsync(String name, int count)
      Opens a node stderr file for reading.
      Parameters:
      name - The node name.
      count - 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.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openNodeStdErrAsync

      default CompletableFuture<FileIteratorPrx> openNodeStdErrAsync(String name, int count, Map<String,String> context)
      Opens a node stderr file for reading.
      Parameters:
      name - The node name.
      count - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openNodeStdOut

      default FileIteratorPrx openNodeStdOut(String name, int count) throws FileNotAvailableException, NodeNotExistException, NodeUnreachableException
      Opens a node stdout file for reading.
      Parameters:
      name - The node name.
      count - 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.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      FileNotAvailableException - Thrown when the file can't be read.
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • openNodeStdOut

      default FileIteratorPrx openNodeStdOut(String name, int count, Map<String,String> context) throws FileNotAvailableException, NodeNotExistException, NodeUnreachableException
      Opens a node stdout file for reading.
      Parameters:
      name - The node name.
      count - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      FileNotAvailableException - Thrown when the file can't be read.
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • openNodeStdOutAsync

      default CompletableFuture<FileIteratorPrx> openNodeStdOutAsync(String name, int count)
      Opens a node stdout file for reading.
      Parameters:
      name - The node name.
      count - 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.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openNodeStdOutAsync

      default CompletableFuture<FileIteratorPrx> openNodeStdOutAsync(String name, int count, Map<String,String> context)
      Opens a node stdout file for reading.
      Parameters:
      name - The node name.
      count - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openRegistryStdErr

      default FileIteratorPrx openRegistryStdErr(String name, int count) throws FileNotAvailableException, RegistryNotExistException, RegistryUnreachableException
      Opens a registry stderr file for reading.
      Parameters:
      name - The registry name.
      count - 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.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      FileNotAvailableException - Thrown when the file can't be read.
      RegistryNotExistException - Thrown when the registry doesn't exist.
      RegistryUnreachableException - Thrown when the registry is unreachable.

    • openRegistryStdErr

      default FileIteratorPrx openRegistryStdErr(String name, int count, Map<String,String> context) throws FileNotAvailableException, RegistryNotExistException, RegistryUnreachableException
      Opens a registry stderr file for reading.
      Parameters:
      name - The registry name.
      count - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      FileNotAvailableException - Thrown when the file can't be read.
      RegistryNotExistException - Thrown when the registry doesn't exist.
      RegistryUnreachableException - Thrown when the registry is unreachable.

    • openRegistryStdErrAsync

      default CompletableFuture<FileIteratorPrx> openRegistryStdErrAsync(String name, int count)
      Opens a registry stderr file for reading.
      Parameters:
      name - The registry name.
      count - 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.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openRegistryStdErrAsync

      default CompletableFuture<FileIteratorPrx> openRegistryStdErrAsync(String name, int count, Map<String,String> context)
      Opens a registry stderr file for reading.
      Parameters:
      name - The registry name.
      count - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openRegistryStdOut

      default FileIteratorPrx openRegistryStdOut(String name, int count) throws FileNotAvailableException, RegistryNotExistException, RegistryUnreachableException
      Opens a registry stdout file for reading.
      Parameters:
      name - The registry name.
      count - 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.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      FileNotAvailableException - Thrown when the file can't be read.
      RegistryNotExistException - Thrown when the registry doesn't exist.
      RegistryUnreachableException - Thrown when the registry is unreachable.

    • openRegistryStdOut

      default FileIteratorPrx openRegistryStdOut(String name, int count, Map<String,String> context) throws FileNotAvailableException, RegistryNotExistException, RegistryUnreachableException
      Opens a registry stdout file for reading.
      Parameters:
      name - The registry name.
      count - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.
      Throws:
      FileNotAvailableException - Thrown when the file can't be read.
      RegistryNotExistException - Thrown when the registry doesn't exist.
      RegistryUnreachableException - Thrown when the registry is unreachable.

    • openRegistryStdOutAsync

      default CompletableFuture<FileIteratorPrx> openRegistryStdOutAsync(String name, int count)
      Opens a registry stdout file for reading.
      Parameters:
      name - The registry name.
      count - 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.
      Returns:
      An iterator to read the file. This proxy is never null.

    • openRegistryStdOutAsync

      default CompletableFuture<FileIteratorPrx> openRegistryStdOutAsync(String name, int count, Map<String,String> context)
      Opens a registry stdout file for reading.
      Parameters:
      name - The registry name.
      count - 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.
      context - The Context map to send with the invocation.
      Returns:
      An iterator to read the file. This proxy is never null.

    • createProxy

      static AdminSessionPrx createProxy(Communicator communicator, String proxyString)
      Creates a new proxy that implements AdminSessionPrx.
      Parameters:
      communicator - The communicator of the new proxy.
      proxyString - The string representation of the proxy.
      Returns:
      The new proxy.

    • checkedCast

      static AdminSessionPrx checkedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source proxy.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static AdminSessionPrx checkedCast(ObjectPrx obj, Map<String,String> context)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source proxy.
      context - The Context map to send with the invocation.
      Returns:
      A new proxy for this type, or null if the object does not support this type.

    • checkedCast

      static AdminSessionPrx checkedCast(ObjectPrx obj, String facet)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source proxy.
      facet - The name of the desired facet.
      Returns:
      A new proxy for this type, or null if the facet does not support this type.

    • checkedCast

      static AdminSessionPrx checkedCast(ObjectPrx obj, String facet, Map<String,String> context)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source proxy.
      facet - The name of the desired facet.
      context - The Context map to send with the invocation.
      Returns:
      A new proxy for this type, or null if the object does not support this type.

    • uncheckedCast

      static AdminSessionPrx uncheckedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A new proxy for this type.

    • uncheckedCast

      static AdminSessionPrx uncheckedCast(ObjectPrx obj, String facet)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      Returns:
      A new proxy for this type.

    • ice_context

      AdminSessionPrx ice_context(Map<String,String> newContext)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the per-proxy context.
      Specified by:
      ice_context in interface ObjectPrx
      Specified by:
      ice_context in interface SessionPrx
      Parameters:
      newContext - The context for the new proxy.
      Returns:
      A proxy with the new per-proxy context.

    • ice_adapterId

      AdminSessionPrx ice_adapterId(String newAdapterId)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the adapter ID.
      Specified by:
      ice_adapterId in interface ObjectPrx
      Specified by:
      ice_adapterId in interface SessionPrx
      Parameters:
      newAdapterId - The adapter ID for the new proxy.
      Returns:
      A proxy with the new adapter ID.

    • ice_endpoints

      AdminSessionPrx ice_endpoints(Endpoint[] newEndpoints)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the endpoints.
      Specified by:
      ice_endpoints in interface ObjectPrx
      Specified by:
      ice_endpoints in interface SessionPrx
      Parameters:
      newEndpoints - The endpoints for the new proxy.
      Returns:
      A proxy with the new endpoints.

    • ice_locatorCacheTimeout

      AdminSessionPrx ice_locatorCacheTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the locator cache timeout.
      Specified by:
      ice_locatorCacheTimeout in interface ObjectPrx
      Specified by:
      ice_locatorCacheTimeout in interface SessionPrx
      Parameters:
      newTimeout - The new locator cache timeout (in seconds).
      Returns:
      A proxy with the new timeout.
      See Also:

    • ice_invocationTimeout

      AdminSessionPrx ice_invocationTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the invocation timeout.
      Specified by:
      ice_invocationTimeout in interface ObjectPrx
      Specified by:
      ice_invocationTimeout in interface SessionPrx
      Parameters:
      newTimeout - The new invocation timeout (in milliseconds).
      Returns:
      The proxy with the new timeout.

    • ice_invocationTimeout

      AdminSessionPrx ice_invocationTimeout(Duration newTimeout)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the invocation timeout.
      Specified by:
      ice_invocationTimeout in interface ObjectPrx
      Specified by:
      ice_invocationTimeout in interface SessionPrx
      Parameters:
      newTimeout - The new invocation timeout.
      Returns:
      The proxy with the new timeout.

    • ice_connectionCached

      AdminSessionPrx ice_connectionCached(boolean newCache)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for connection caching.
      Specified by:
      ice_connectionCached in interface ObjectPrx
      Specified by:
      ice_connectionCached in interface SessionPrx
      Parameters:
      newCache - true if the new proxy should cache connections; false otherwise.
      Returns:
      The proxy with the specified caching policy.

    • ice_endpointSelection

      AdminSessionPrx ice_endpointSelection(EndpointSelectionType newType)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the endpoint selection policy.
      Specified by:
      ice_endpointSelection in interface ObjectPrx
      Specified by:
      ice_endpointSelection in interface SessionPrx
      Parameters:
      newType - The new endpoint selection policy.
      Returns:
      The proxy with the specified endpoint selection policy.
      See Also:

    • ice_encodingVersion

      AdminSessionPrx ice_encodingVersion(EncodingVersion e)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
      Specified by:
      ice_encodingVersion in interface ObjectPrx
      Specified by:
      ice_encodingVersion in interface SessionPrx
      Parameters:
      e - The encoding version to use to marshal request parameters.
      Returns:
      The proxy with the specified encoding version.

    • ice_router

      AdminSessionPrx ice_router(RouterPrx router)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the router.
      Specified by:
      ice_router in interface ObjectPrx
      Specified by:
      ice_router in interface SessionPrx
      Parameters:
      router - The router for the new proxy.
      Returns:
      The proxy with the specified router.

    • ice_locator

      AdminSessionPrx ice_locator(LocatorPrx locator)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the locator.
      Specified by:
      ice_locator in interface ObjectPrx
      Specified by:
      ice_locator in interface SessionPrx
      Parameters:
      locator - The locator for the new proxy.
      Returns:
      The proxy with the specified locator.

    • ice_collocationOptimized

      AdminSessionPrx ice_collocationOptimized(boolean b)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for collocation optimization.
      Specified by:
      ice_collocationOptimized in interface ObjectPrx
      Specified by:
      ice_collocationOptimized in interface SessionPrx
      Parameters:
      b - true if the new proxy enables collocation optimization; false otherwise.
      Returns:
      The proxy with the specified collocation optimization.

    • ice_twoway

      AdminSessionPrx ice_twoway()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses twoway invocations.
      Specified by:
      ice_twoway in interface ObjectPrx
      Specified by:
      ice_twoway in interface SessionPrx
      Returns:
      A proxy that uses twoway invocations.

    • ice_oneway

      AdminSessionPrx ice_oneway()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses oneway invocations.
      Specified by:
      ice_oneway in interface ObjectPrx
      Specified by:
      ice_oneway in interface SessionPrx
      Returns:
      A proxy that uses oneway invocations.

    • ice_batchOneway

      AdminSessionPrx ice_batchOneway()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses batch oneway invocations.
      Specified by:
      ice_batchOneway in interface ObjectPrx
      Specified by:
      ice_batchOneway in interface SessionPrx
      Returns:
      A proxy that uses batch oneway invocations.

    • ice_datagram

      AdminSessionPrx ice_datagram()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses datagram invocations.
      Specified by:
      ice_datagram in interface ObjectPrx
      Specified by:
      ice_datagram in interface SessionPrx
      Returns:
      A proxy that uses datagram invocations.

    • ice_batchDatagram

      AdminSessionPrx ice_batchDatagram()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses batch datagram invocations.
      Specified by:
      ice_batchDatagram in interface ObjectPrx
      Specified by:
      ice_batchDatagram in interface SessionPrx
      Returns:
      A proxy that uses batch datagram invocations.

    • ice_compress

      AdminSessionPrx ice_compress(boolean co)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
      Specified by:
      ice_compress in interface ObjectPrx
      Specified by:
      ice_compress in interface SessionPrx
      Parameters:
      co - true enables compression for the new proxy; false disables compression.
      Returns:
      A proxy with the specified compression setting.

    • ice_connectionId

      AdminSessionPrx ice_connectionId(String connectionId)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for its connection ID.
      Specified by:
      ice_connectionId in interface ObjectPrx
      Specified by:
      ice_connectionId in interface SessionPrx
      Parameters:
      connectionId - The connection ID for the new proxy. An empty string removes the connection ID.
      Returns:
      A proxy with the specified connection ID.

    • ice_fixed

      AdminSessionPrx ice_fixed(Connection connection)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
      Specified by:
      ice_fixed in interface ObjectPrx
      Specified by:
      ice_fixed in interface SessionPrx
      Parameters:
      connection - The fixed proxy connection.
      Returns:
      A fixed proxy bound to the given connection.

    • ice_staticId

      static String ice_staticId()
      Gets the type ID of the associated Slice interface.
      Returns:
      the string "::IceGrid::AdminSession"