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

Interface AdminPrx

All Superinterfaces:
ObjectPrx
public interface AdminPrx extends ObjectPrx
Provides administrative access to an IceGrid deployment.

  • Method Details

    • addApplication

      default void addApplication(ApplicationDescriptor descriptor) throws AccessDeniedException, DeploymentException
      Adds an application to IceGrid.
      Parameters:
      descriptor - The application descriptor.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      DeploymentException - Thrown when the application deployment failed.

    • addApplication

      default void addApplication(ApplicationDescriptor descriptor, Map<String,String> context) throws AccessDeniedException, DeploymentException
      Adds an application to IceGrid.
      Parameters:
      descriptor - The application descriptor.
      context - The Context map to send with the invocation.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      DeploymentException - Thrown when the application deployment failed.

    • addApplicationAsync

      default CompletableFuture<Void> addApplicationAsync(ApplicationDescriptor descriptor)
      Adds an application to IceGrid.
      Parameters:
      descriptor - The application descriptor.
      Returns:
      A future that will be completed when the invocation completes.

    • addApplicationAsync

      default CompletableFuture<Void> addApplicationAsync(ApplicationDescriptor descriptor, Map<String,String> context)
      Adds an application to IceGrid.
      Parameters:
      descriptor - The application descriptor.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • syncApplication

      default void syncApplication(ApplicationDescriptor descriptor) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
      Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor.
      Parameters:
      descriptor - The new application descriptor.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      ApplicationNotExistException - Thrown when the application doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • syncApplication

      default void syncApplication(ApplicationDescriptor descriptor, Map<String,String> context) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
      Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor.
      Parameters:
      descriptor - The new application descriptor.
      context - The Context map to send with the invocation.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      ApplicationNotExistException - Thrown when the application doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • syncApplicationAsync

      default CompletableFuture<Void> syncApplicationAsync(ApplicationDescriptor descriptor)
      Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor.
      Parameters:
      descriptor - The new application descriptor.
      Returns:
      A future that will be completed when the invocation completes.

    • syncApplicationAsync

      default CompletableFuture<Void> syncApplicationAsync(ApplicationDescriptor descriptor, Map<String,String> context)
      Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor.
      Parameters:
      descriptor - The new application descriptor.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • updateApplication

      default void updateApplication(ApplicationUpdateDescriptor descriptor) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
      Updates a deployed application.
      Parameters:
      descriptor - The update descriptor.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      ApplicationNotExistException - Thrown when the application doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • updateApplication

      default void updateApplication(ApplicationUpdateDescriptor descriptor, Map<String,String> context) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
      Updates a deployed application.
      Parameters:
      descriptor - The update descriptor.
      context - The Context map to send with the invocation.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      ApplicationNotExistException - Thrown when the application doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • updateApplicationAsync

      default CompletableFuture<Void> updateApplicationAsync(ApplicationUpdateDescriptor descriptor)
      Updates a deployed application.
      Parameters:
      descriptor - The update descriptor.
      Returns:
      A future that will be completed when the invocation completes.

    • updateApplicationAsync

      default CompletableFuture<Void> updateApplicationAsync(ApplicationUpdateDescriptor descriptor, Map<String,String> context)
      Updates a deployed application.
      Parameters:
      descriptor - The update descriptor.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • syncApplicationWithoutRestart

      default void syncApplicationWithoutRestart(ApplicationDescriptor descriptor) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
      Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor only if no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.
      Parameters:
      descriptor - The application descriptor.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      ApplicationNotExistException - Thrown when the application doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • syncApplicationWithoutRestart

      default void syncApplicationWithoutRestart(ApplicationDescriptor descriptor, Map<String,String> context) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
      Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor only if no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.
      Parameters:
      descriptor - The application descriptor.
      context - The Context map to send with the invocation.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      ApplicationNotExistException - Thrown when the application doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • syncApplicationWithoutRestartAsync

      default CompletableFuture<Void> syncApplicationWithoutRestartAsync(ApplicationDescriptor descriptor)
      Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor only if no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.
      Parameters:
      descriptor - The application descriptor.
      Returns:
      A future that will be completed when the invocation completes.

    • syncApplicationWithoutRestartAsync

      default CompletableFuture<Void> syncApplicationWithoutRestartAsync(ApplicationDescriptor descriptor, Map<String,String> context)
      Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor only if no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.
      Parameters:
      descriptor - The application descriptor.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • updateApplicationWithoutRestart

      default void updateApplicationWithoutRestart(ApplicationUpdateDescriptor descriptor) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
      Updates a deployed application. This operation succeeds only when no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.
      Parameters:
      descriptor - The update descriptor.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      ApplicationNotExistException - Thrown when the application doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • updateApplicationWithoutRestart

      default void updateApplicationWithoutRestart(ApplicationUpdateDescriptor descriptor, Map<String,String> context) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
      Updates a deployed application. This operation succeeds only when no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.
      Parameters:
      descriptor - The update descriptor.
      context - The Context map to send with the invocation.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      ApplicationNotExistException - Thrown when the application doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • updateApplicationWithoutRestartAsync

      default CompletableFuture<Void> updateApplicationWithoutRestartAsync(ApplicationUpdateDescriptor descriptor)
      Updates a deployed application. This operation succeeds only when no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.
      Parameters:
      descriptor - The update descriptor.
      Returns:
      A future that will be completed when the invocation completes.

    • updateApplicationWithoutRestartAsync

      default CompletableFuture<Void> updateApplicationWithoutRestartAsync(ApplicationUpdateDescriptor descriptor, Map<String,String> context)
      Updates a deployed application. This operation succeeds only when no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.
      Parameters:
      descriptor - The update descriptor.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • removeApplication

      default void removeApplication(String name) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
      Removes an application from IceGrid.
      Parameters:
      name - The application name.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      ApplicationNotExistException - Thrown when the application doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • removeApplication

      default void removeApplication(String name, Map<String,String> context) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
      Removes an application from IceGrid.
      Parameters:
      name - The application name.
      context - The Context map to send with the invocation.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      ApplicationNotExistException - Thrown when the application doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • removeApplicationAsync

      default CompletableFuture<Void> removeApplicationAsync(String name)
      Removes an application from IceGrid.
      Parameters:
      name - The application name.
      Returns:
      A future that will be completed when the invocation completes.

    • removeApplicationAsync

      default CompletableFuture<Void> removeApplicationAsync(String name, Map<String,String> context)
      Removes an application from IceGrid.
      Parameters:
      name - The application name.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • instantiateServer

      default void instantiateServer(String application, String node, ServerInstanceDescriptor desc) throws AccessDeniedException, ApplicationNotExistException, DeploymentException
      Instantiates a server template.
      Parameters:
      application - The application name.
      node - The name of the node where the server will be deployed.
      desc - The descriptor of the server instance to deploy.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      ApplicationNotExistException - Thrown when the application doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • instantiateServer

      default void instantiateServer(String application, String node, ServerInstanceDescriptor desc, Map<String,String> context) throws AccessDeniedException, ApplicationNotExistException, DeploymentException
      Instantiates a server template.
      Parameters:
      application - The application name.
      node - The name of the node where the server will be deployed.
      desc - The descriptor of the server instance to deploy.
      context - The Context map to send with the invocation.
      Throws:
      AccessDeniedException - Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.
      ApplicationNotExistException - Thrown when the application doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • instantiateServerAsync

      default CompletableFuture<Void> instantiateServerAsync(String application, String node, ServerInstanceDescriptor desc)
      Instantiates a server template.
      Parameters:
      application - The application name.
      node - The name of the node where the server will be deployed.
      desc - The descriptor of the server instance to deploy.
      Returns:
      A future that will be completed when the invocation completes.

    • instantiateServerAsync

      default CompletableFuture<Void> instantiateServerAsync(String application, String node, ServerInstanceDescriptor desc, Map<String,String> context)
      Instantiates a server template.
      Parameters:
      application - The application name.
      node - The name of the node where the server will be deployed.
      desc - The descriptor of the server instance to deploy.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • getApplicationInfo

      default ApplicationInfo getApplicationInfo(String name) throws ApplicationNotExistException
      Gets an application descriptor.
      Parameters:
      name - The application name.
      Returns:
      The application descriptor.
      Throws:
      ApplicationNotExistException - Thrown when the application doesn't exist.

    • getApplicationInfo

      default ApplicationInfo getApplicationInfo(String name, Map<String,String> context) throws ApplicationNotExistException
      Gets an application descriptor.
      Parameters:
      name - The application name.
      context - The Context map to send with the invocation.
      Returns:
      The application descriptor.
      Throws:
      ApplicationNotExistException - Thrown when the application doesn't exist.

    • getApplicationInfoAsync

      default CompletableFuture<ApplicationInfo> getApplicationInfoAsync(String name)
      Gets an application descriptor.
      Parameters:
      name - The application name.
      Returns:
      The application descriptor.

    • getApplicationInfoAsync

      default CompletableFuture<ApplicationInfo> getApplicationInfoAsync(String name, Map<String,String> context)
      Gets an application descriptor.
      Parameters:
      name - The application name.
      context - The Context map to send with the invocation.
      Returns:
      The application descriptor.

    • getDefaultApplicationDescriptor

      default ApplicationDescriptor getDefaultApplicationDescriptor() throws DeploymentException
      Gets the default application descriptor.
      Returns:
      The default application descriptor.
      Throws:
      DeploymentException - Thrown when the default application descriptor is invalid or unreachable.

    • getDefaultApplicationDescriptor

      default ApplicationDescriptor getDefaultApplicationDescriptor(Map<String,String> context) throws DeploymentException
      Gets the default application descriptor.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The default application descriptor.
      Throws:
      DeploymentException - Thrown when the default application descriptor is invalid or unreachable.

    • getDefaultApplicationDescriptorAsync

      default CompletableFuture<ApplicationDescriptor> getDefaultApplicationDescriptorAsync()
      Gets the default application descriptor.
      Returns:
      The default application descriptor.

    • getDefaultApplicationDescriptorAsync

      default CompletableFuture<ApplicationDescriptor> getDefaultApplicationDescriptorAsync(Map<String,String> context)
      Gets the default application descriptor.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The default application descriptor.

    • getAllApplicationNames

      default String[] getAllApplicationNames()
      Gets all the IceGrid applications currently registered.
      Returns:
      The application names.

    • getAllApplicationNames

      default String[] getAllApplicationNames(Map<String,String> context)
      Gets all the IceGrid applications currently registered.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The application names.

    • getAllApplicationNamesAsync

      default CompletableFuture<String[]> getAllApplicationNamesAsync()
      Gets all the IceGrid applications currently registered.
      Returns:
      The application names.

    • getAllApplicationNamesAsync

      default CompletableFuture<String[]> getAllApplicationNamesAsync(Map<String,String> context)
      Gets all the IceGrid applications currently registered.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The application names.

    • getServerInfo

      default ServerInfo getServerInfo(String id) throws ServerNotExistException
      Gets information about a server.
      Parameters:
      id - The server ID.
      Returns:
      The server information.
      Throws:
      ServerNotExistException - Thrown when the server doesn't exist.

    • getServerInfo

      default ServerInfo getServerInfo(String id, Map<String,String> context) throws ServerNotExistException
      Gets information about a server.
      Parameters:
      id - The server ID.
      context - The Context map to send with the invocation.
      Returns:
      The server information.
      Throws:
      ServerNotExistException - Thrown when the server doesn't exist.

    • getServerInfoAsync

      default CompletableFuture<ServerInfo> getServerInfoAsync(String id)
      Gets information about a server.
      Parameters:
      id - The server ID.
      Returns:
      The server information.

    • getServerInfoAsync

      default CompletableFuture<ServerInfo> getServerInfoAsync(String id, Map<String,String> context)
      Gets information about a server.
      Parameters:
      id - The server ID.
      context - The Context map to send with the invocation.
      Returns:
      The server information.

    • getServerState

      default ServerState getServerState(String id) throws ServerNotExistException, NodeUnreachableException, DeploymentException
      Gets the state of a server.
      Parameters:
      id - The server ID.
      Returns:
      The server state.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • getServerState

      default ServerState getServerState(String id, Map<String,String> context) throws ServerNotExistException, NodeUnreachableException, DeploymentException
      Gets the state of a server.
      Parameters:
      id - The server ID.
      context - The Context map to send with the invocation.
      Returns:
      The server state.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • getServerStateAsync

      default CompletableFuture<ServerState> getServerStateAsync(String id)
      Gets the state of a server.
      Parameters:
      id - The server ID.
      Returns:
      The server state.

    • getServerStateAsync

      default CompletableFuture<ServerState> getServerStateAsync(String id, Map<String,String> context)
      Gets the state of a server.
      Parameters:
      id - The server ID.
      context - The Context map to send with the invocation.
      Returns:
      The server state.

    • getServerPid

      default int getServerPid(String id) throws ServerNotExistException, NodeUnreachableException, DeploymentException
      Gets the system process ID of a server. The process ID is operating system dependent.
      Parameters:
      id - The server ID.
      Returns:
      The process ID.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • getServerPid

      default int getServerPid(String id, Map<String,String> context) throws ServerNotExistException, NodeUnreachableException, DeploymentException
      Gets the system process ID of a server. The process ID is operating system dependent.
      Parameters:
      id - The server ID.
      context - The Context map to send with the invocation.
      Returns:
      The process ID.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • getServerPidAsync

      default CompletableFuture<Integer> getServerPidAsync(String id)
      Gets the system process ID of a server. The process ID is operating system dependent.
      Parameters:
      id - The server ID.
      Returns:
      The process ID.

    • getServerPidAsync

      default CompletableFuture<Integer> getServerPidAsync(String id, Map<String,String> context)
      Gets the system process ID of a server. The process ID is operating system dependent.
      Parameters:
      id - The server ID.
      context - The Context map to send with the invocation.
      Returns:
      The process ID.

    • getServerAdminCategory

      default String getServerAdminCategory()
      Gets the category for server admin objects. You can manufacture a server admin proxy from the admin proxy by changing its identity: use the server ID as name and the returned category as category.
      Returns:
      The category for server admin objects.

    • getServerAdminCategory

      default String getServerAdminCategory(Map<String,String> context)
      Gets the category for server admin objects. You can manufacture a server admin proxy from the admin proxy by changing its identity: use the server ID as name and the returned category as category.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The category for server admin objects.

    • getServerAdminCategoryAsync

      default CompletableFuture<String> getServerAdminCategoryAsync()
      Gets the category for server admin objects. You can manufacture a server admin proxy from the admin proxy by changing its identity: use the server ID as name and the returned category as category.
      Returns:
      The category for server admin objects.

    • getServerAdminCategoryAsync

      default CompletableFuture<String> getServerAdminCategoryAsync(Map<String,String> context)
      Gets the category for server admin objects. You can manufacture a server admin proxy from the admin proxy by changing its identity: use the server ID as name and the returned category as category.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The category for server admin objects.

    • getServerAdmin

      default ObjectPrx getServerAdmin(String id) throws ServerNotExistException, NodeUnreachableException, DeploymentException
      Gets a proxy to the admin object of a server.
      Parameters:
      id - The server ID.
      Returns:
      A proxy to the admin object of the server. This proxy is never null.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • getServerAdmin

      default ObjectPrx getServerAdmin(String id, Map<String,String> context) throws ServerNotExistException, NodeUnreachableException, DeploymentException
      Gets a proxy to the admin object of a server.
      Parameters:
      id - The server ID.
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the admin object of the server. This proxy is never null.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • getServerAdminAsync

      default CompletableFuture<ObjectPrx> getServerAdminAsync(String id)
      Gets a proxy to the admin object of a server.
      Parameters:
      id - The server ID.
      Returns:
      A proxy to the admin object of the server. This proxy is never null.

    • getServerAdminAsync

      default CompletableFuture<ObjectPrx> getServerAdminAsync(String id, Map<String,String> context)
      Gets a proxy to the admin object of a server.
      Parameters:
      id - The server ID.
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the admin object of the server. This proxy is never null.

    • enableServer

      default void enableServer(String id, boolean enabled) throws ServerNotExistException, NodeUnreachableException, DeploymentException
      Enables or disables a server. A disabled server can't be started on demand or administratively. The enable state of the server is not persistent: if the node is shut down and restarted, the server will be enabled by default.
      Parameters:
      id - The server ID.
      enabled - true to enable the server, false to disable it.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • enableServer

      default void enableServer(String id, boolean enabled, Map<String,String> context) throws ServerNotExistException, NodeUnreachableException, DeploymentException
      Enables or disables a server. A disabled server can't be started on demand or administratively. The enable state of the server is not persistent: if the node is shut down and restarted, the server will be enabled by default.
      Parameters:
      id - The server ID.
      enabled - true to enable the server, false to disable it.
      context - The Context map to send with the invocation.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • enableServerAsync

      default CompletableFuture<Void> enableServerAsync(String id, boolean enabled)
      Enables or disables a server. A disabled server can't be started on demand or administratively. The enable state of the server is not persistent: if the node is shut down and restarted, the server will be enabled by default.
      Parameters:
      id - The server ID.
      enabled - true to enable the server, false to disable it.
      Returns:
      A future that will be completed when the invocation completes.

    • enableServerAsync

      default CompletableFuture<Void> enableServerAsync(String id, boolean enabled, Map<String,String> context)
      Enables or disables a server. A disabled server can't be started on demand or administratively. The enable state of the server is not persistent: if the node is shut down and restarted, the server will be enabled by default.
      Parameters:
      id - The server ID.
      enabled - true to enable the server, false to disable it.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • isServerEnabled

      default boolean isServerEnabled(String id) throws ServerNotExistException, NodeUnreachableException, DeploymentException
      Checks if the server is enabled or disabled.
      Parameters:
      id - The server ID.
      Returns:
      true if the server is enabled, false otherwise.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • isServerEnabled

      default boolean isServerEnabled(String id, Map<String,String> context) throws ServerNotExistException, NodeUnreachableException, DeploymentException
      Checks if the server is enabled or disabled.
      Parameters:
      id - The server ID.
      context - The Context map to send with the invocation.
      Returns:
      true if the server is enabled, false otherwise.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • isServerEnabledAsync

      default CompletableFuture<Boolean> isServerEnabledAsync(String id)
      Checks if the server is enabled or disabled.
      Parameters:
      id - The server ID.
      Returns:
      true if the server is enabled, false otherwise.

    • isServerEnabledAsync

      default CompletableFuture<Boolean> isServerEnabledAsync(String id, Map<String,String> context)
      Checks if the server is enabled or disabled.
      Parameters:
      id - The server ID.
      context - The Context map to send with the invocation.
      Returns:
      true if the server is enabled, false otherwise.

    • startServer

      default void startServer(String id) throws ServerNotExistException, ServerStartException, NodeUnreachableException, DeploymentException
      Starts a server and waits for its activation.
      Parameters:
      id - The server id.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.
      ServerStartException - Thrown when the server startup failed.

    • startServer

      default void startServer(String id, Map<String,String> context) throws ServerNotExistException, ServerStartException, NodeUnreachableException, DeploymentException
      Starts a server and waits for its activation.
      Parameters:
      id - The server id.
      context - The Context map to send with the invocation.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.
      ServerStartException - Thrown when the server startup failed.

    • startServerAsync

      default CompletableFuture<Void> startServerAsync(String id)
      Starts a server and waits for its activation.
      Parameters:
      id - The server id.
      Returns:
      A future that will be completed when the invocation completes.

    • startServerAsync

      default CompletableFuture<Void> startServerAsync(String id, Map<String,String> context)
      Starts a server and waits for its activation.
      Parameters:
      id - The server id.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • stopServer

      default void stopServer(String id) throws ServerNotExistException, ServerStopException, NodeUnreachableException, DeploymentException
      Stops a server.
      Parameters:
      id - The server ID.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.
      ServerStopException - Thrown when the server stop failed.

    • stopServer

      default void stopServer(String id, Map<String,String> context) throws ServerNotExistException, ServerStopException, NodeUnreachableException, DeploymentException
      Stops a server.
      Parameters:
      id - The server ID.
      context - The Context map to send with the invocation.
      Throws:
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.
      ServerStopException - Thrown when the server stop failed.

    • stopServerAsync

      default CompletableFuture<Void> stopServerAsync(String id)
      Stops a server.
      Parameters:
      id - The server ID.
      Returns:
      A future that will be completed when the invocation completes.

    • stopServerAsync

      default CompletableFuture<Void> stopServerAsync(String id, Map<String,String> context)
      Stops a server.
      Parameters:
      id - The server ID.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • sendSignal

      default void sendSignal(String id, String signal) throws ServerNotExistException, NodeUnreachableException, DeploymentException, BadSignalException
      Sends a signal to a server.
      Parameters:
      id - The server ID.
      signal - The signal, for example SIGTERM or 15.
      Throws:
      BadSignalException - Thrown when the signal is not recognized by the target server.
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • sendSignal

      default void sendSignal(String id, String signal, Map<String,String> context) throws ServerNotExistException, NodeUnreachableException, DeploymentException, BadSignalException
      Sends a signal to a server.
      Parameters:
      id - The server ID.
      signal - The signal, for example SIGTERM or 15.
      context - The Context map to send with the invocation.
      Throws:
      BadSignalException - Thrown when the signal is not recognized by the target server.
      DeploymentException - Thrown when the deployment of the server failed.
      NodeUnreachableException - Thrown when the node is unreachable.
      ServerNotExistException - Thrown when the server doesn't exist.

    • sendSignalAsync

      default CompletableFuture<Void> sendSignalAsync(String id, String signal)
      Sends a signal to a server.
      Parameters:
      id - The server ID.
      signal - The signal, for example SIGTERM or 15.
      Returns:
      A future that will be completed when the invocation completes.

    • sendSignalAsync

      default CompletableFuture<Void> sendSignalAsync(String id, String signal, Map<String,String> context)
      Sends a signal to a server.
      Parameters:
      id - The server ID.
      signal - The signal, for example SIGTERM or 15.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • getAllServerIds

      default String[] getAllServerIds()
      Gets the IDs of all the servers registered with IceGrid.
      Returns:
      The server IDs.

    • getAllServerIds

      default String[] getAllServerIds(Map<String,String> context)
      Gets the IDs of all the servers registered with IceGrid.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The server IDs.

    • getAllServerIdsAsync

      default CompletableFuture<String[]> getAllServerIdsAsync()
      Gets the IDs of all the servers registered with IceGrid.
      Returns:
      The server IDs.

    • getAllServerIdsAsync

      default CompletableFuture<String[]> getAllServerIdsAsync(Map<String,String> context)
      Gets the IDs of all the servers registered with IceGrid.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The server IDs.

    • getAdapterInfo

      default AdapterInfo[] getAdapterInfo(String id) throws AdapterNotExistException
      Gets adapter information for the replica group or adapter with the given ID.
      Parameters:
      id - The adapter or replica group ID.
      Returns:
      A sequence of AdapterInfo. If id refers to an adapter, this sequence contains a single element. If id refers to a replica group, this sequence contains adapter information for each member of the replica group.
      Throws:
      AdapterNotExistException - Thrown when the adapter or replica group doesn't exist.

    • getAdapterInfo

      default AdapterInfo[] getAdapterInfo(String id, Map<String,String> context) throws AdapterNotExistException
      Gets adapter information for the replica group or adapter with the given ID.
      Parameters:
      id - The adapter or replica group ID.
      context - The Context map to send with the invocation.
      Returns:
      A sequence of AdapterInfo. If id refers to an adapter, this sequence contains a single element. If id refers to a replica group, this sequence contains adapter information for each member of the replica group.
      Throws:
      AdapterNotExistException - Thrown when the adapter or replica group doesn't exist.

    • getAdapterInfoAsync

      default CompletableFuture<AdapterInfo[]> getAdapterInfoAsync(String id)
      Gets adapter information for the replica group or adapter with the given ID.
      Parameters:
      id - The adapter or replica group ID.
      Returns:
      A sequence of AdapterInfo. If id refers to an adapter, this sequence contains a single element. If id refers to a replica group, this sequence contains adapter information for each member of the replica group.

    • getAdapterInfoAsync

      default CompletableFuture<AdapterInfo[]> getAdapterInfoAsync(String id, Map<String,String> context)
      Gets adapter information for the replica group or adapter with the given ID.
      Parameters:
      id - The adapter or replica group ID.
      context - The Context map to send with the invocation.
      Returns:
      A sequence of AdapterInfo. If id refers to an adapter, this sequence contains a single element. If id refers to a replica group, this sequence contains adapter information for each member of the replica group.

    • removeAdapter

      default void removeAdapter(String id) throws AdapterNotExistException, DeploymentException
      Removes the adapter with the given ID.
      Parameters:
      id - The adapter ID.
      Throws:
      AdapterNotExistException - Thrown when the adapter doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • removeAdapter

      default void removeAdapter(String id, Map<String,String> context) throws AdapterNotExistException, DeploymentException
      Removes the adapter with the given ID.
      Parameters:
      id - The adapter ID.
      context - The Context map to send with the invocation.
      Throws:
      AdapterNotExistException - Thrown when the adapter doesn't exist.
      DeploymentException - Thrown when the application deployment failed.

    • removeAdapterAsync

      default CompletableFuture<Void> removeAdapterAsync(String id)
      Removes the adapter with the given ID.
      Parameters:
      id - The adapter ID.
      Returns:
      A future that will be completed when the invocation completes.

    • removeAdapterAsync

      default CompletableFuture<Void> removeAdapterAsync(String id, Map<String,String> context)
      Removes the adapter with the given ID.
      Parameters:
      id - The adapter ID.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • getAllAdapterIds

      default String[] getAllAdapterIds()
      Gets the IDs of all adapters registered with IceGrid.
      Returns:
      The adapter IDs.

    • getAllAdapterIds

      default String[] getAllAdapterIds(Map<String,String> context)
      Gets the IDs of all adapters registered with IceGrid.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The adapter IDs.

    • getAllAdapterIdsAsync

      default CompletableFuture<String[]> getAllAdapterIdsAsync()
      Gets the IDs of all adapters registered with IceGrid.
      Returns:
      The adapter IDs.

    • getAllAdapterIdsAsync

      default CompletableFuture<String[]> getAllAdapterIdsAsync(Map<String,String> context)
      Gets the IDs of all adapters registered with IceGrid.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The adapter IDs.

    • addObject

      default void addObject(ObjectPrx obj) throws ObjectExistsException, DeploymentException
      Adds an object to the object registry. IceGrid gets the object type by calling ice_id on obj. The object must be reachable.
      Parameters:
      obj - A proxy to the object. This proxy is never null.
      Throws:
      DeploymentException - Thrown when the object can't be added.
      ObjectExistsException - Thrown when the object is already registered.

    • addObject

      default void addObject(ObjectPrx obj, Map<String,String> context) throws ObjectExistsException, DeploymentException
      Adds an object to the object registry. IceGrid gets the object type by calling ice_id on obj. The object must be reachable.
      Parameters:
      obj - A proxy to the object. This proxy is never null.
      context - The Context map to send with the invocation.
      Throws:
      DeploymentException - Thrown when the object can't be added.
      ObjectExistsException - Thrown when the object is already registered.

    • addObjectAsync

      default CompletableFuture<Void> addObjectAsync(ObjectPrx obj)
      Adds an object to the object registry. IceGrid gets the object type by calling ice_id on obj. The object must be reachable.
      Parameters:
      obj - A proxy to the object. This proxy is never null.
      Returns:
      A future that will be completed when the invocation completes.

    • addObjectAsync

      default CompletableFuture<Void> addObjectAsync(ObjectPrx obj, Map<String,String> context)
      Adds an object to the object registry. IceGrid gets the object type by calling ice_id on obj. The object must be reachable.
      Parameters:
      obj - A proxy to the object. This proxy is never null.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • updateObject

      default void updateObject(ObjectPrx obj) throws ObjectNotRegisteredException, DeploymentException
      Updates an object in the object registry. Only objects added with this interface can be updated with this operation. Objects added with deployment descriptors should be updated with the deployment mechanism.
      Parameters:
      obj - A proxy to the object. This proxy is never null.
      Throws:
      DeploymentException - Thrown when the object can't be updated.
      ObjectNotRegisteredException - Thrown when the object isn't registered with the registry.

    • updateObject

      default void updateObject(ObjectPrx obj, Map<String,String> context) throws ObjectNotRegisteredException, DeploymentException
      Updates an object in the object registry. Only objects added with this interface can be updated with this operation. Objects added with deployment descriptors should be updated with the deployment mechanism.
      Parameters:
      obj - A proxy to the object. This proxy is never null.
      context - The Context map to send with the invocation.
      Throws:
      DeploymentException - Thrown when the object can't be updated.
      ObjectNotRegisteredException - Thrown when the object isn't registered with the registry.

    • updateObjectAsync

      default CompletableFuture<Void> updateObjectAsync(ObjectPrx obj)
      Updates an object in the object registry. Only objects added with this interface can be updated with this operation. Objects added with deployment descriptors should be updated with the deployment mechanism.
      Parameters:
      obj - A proxy to the object. This proxy is never null.
      Returns:
      A future that will be completed when the invocation completes.

    • updateObjectAsync

      default CompletableFuture<Void> updateObjectAsync(ObjectPrx obj, Map<String,String> context)
      Updates an object in the object registry. Only objects added with this interface can be updated with this operation. Objects added with deployment descriptors should be updated with the deployment mechanism.
      Parameters:
      obj - A proxy to the object. This proxy is never null.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • addObjectWithType

      default void addObjectWithType(ObjectPrx obj, String type) throws ObjectExistsException, DeploymentException
      Adds an object to the object registry and explicitly specifies its type.
      Parameters:
      obj - The object to be added to the registry. The proxy is never null.
      type - The type name.
      Throws:
      DeploymentException - Thrown when the application deployment failed.
      ObjectExistsException - Thrown when the object is already registered.

    • addObjectWithType

      default void addObjectWithType(ObjectPrx obj, String type, Map<String,String> context) throws ObjectExistsException, DeploymentException
      Adds an object to the object registry and explicitly specifies its type.
      Parameters:
      obj - The object to be added to the registry. The proxy is never null.
      type - The type name.
      context - The Context map to send with the invocation.
      Throws:
      DeploymentException - Thrown when the application deployment failed.
      ObjectExistsException - Thrown when the object is already registered.

    • addObjectWithTypeAsync

      default CompletableFuture<Void> addObjectWithTypeAsync(ObjectPrx obj, String type)
      Adds an object to the object registry and explicitly specifies its type.
      Parameters:
      obj - The object to be added to the registry. The proxy is never null.
      type - The type name.
      Returns:
      A future that will be completed when the invocation completes.

    • addObjectWithTypeAsync

      default CompletableFuture<Void> addObjectWithTypeAsync(ObjectPrx obj, String type, Map<String,String> context)
      Adds an object to the object registry and explicitly specifies its type.
      Parameters:
      obj - The object to be added to the registry. The proxy is never null.
      type - The type name.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • removeObject

      default void removeObject(Identity id) throws ObjectNotRegisteredException, DeploymentException
      Removes an object from the object registry. Only objects added with this interface can be removed with this operation. Objects added with deployment descriptors should be removed with the deployment mechanism.
      Parameters:
      id - The identity of the object to remove.
      Throws:
      DeploymentException - Thrown when the object can't be removed.
      ObjectNotRegisteredException - Thrown when the object isn't registered with the registry.

    • removeObject

      default void removeObject(Identity id, Map<String,String> context) throws ObjectNotRegisteredException, DeploymentException
      Removes an object from the object registry. Only objects added with this interface can be removed with this operation. Objects added with deployment descriptors should be removed with the deployment mechanism.
      Parameters:
      id - The identity of the object to remove.
      context - The Context map to send with the invocation.
      Throws:
      DeploymentException - Thrown when the object can't be removed.
      ObjectNotRegisteredException - Thrown when the object isn't registered with the registry.

    • removeObjectAsync

      default CompletableFuture<Void> removeObjectAsync(Identity id)
      Removes an object from the object registry. Only objects added with this interface can be removed with this operation. Objects added with deployment descriptors should be removed with the deployment mechanism.
      Parameters:
      id - The identity of the object to remove.
      Returns:
      A future that will be completed when the invocation completes.

    • removeObjectAsync

      default CompletableFuture<Void> removeObjectAsync(Identity id, Map<String,String> context)
      Removes an object from the object registry. Only objects added with this interface can be removed with this operation. Objects added with deployment descriptors should be removed with the deployment mechanism.
      Parameters:
      id - The identity of the object to remove.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • getObjectInfo

      default ObjectInfo getObjectInfo(Identity id) throws ObjectNotRegisteredException
      Gets the object info for the object.
      Parameters:
      id - The identity of the object.
      Returns:
      The object info.
      Throws:
      ObjectNotRegisteredException - Thrown when the object isn't registered with the registry.

    • getObjectInfo

      default ObjectInfo getObjectInfo(Identity id, Map<String,String> context) throws ObjectNotRegisteredException
      Gets the object info for the object.
      Parameters:
      id - The identity of the object.
      context - The Context map to send with the invocation.
      Returns:
      The object info.
      Throws:
      ObjectNotRegisteredException - Thrown when the object isn't registered with the registry.

    • getObjectInfoAsync

      default CompletableFuture<ObjectInfo> getObjectInfoAsync(Identity id)
      Gets the object info for the object.
      Parameters:
      id - The identity of the object.
      Returns:
      The object info.

    • getObjectInfoAsync

      default CompletableFuture<ObjectInfo> getObjectInfoAsync(Identity id, Map<String,String> context)
      Gets the object info for the object.
      Parameters:
      id - The identity of the object.
      context - The Context map to send with the invocation.
      Returns:
      The object info.

    • getObjectInfosByType

      default ObjectInfo[] getObjectInfosByType(String type)
      Gets the object info of all the registered objects with a given type.
      Parameters:
      type - The type name.
      Returns:
      The object infos.

    • getObjectInfosByType

      default ObjectInfo[] getObjectInfosByType(String type, Map<String,String> context)
      Gets the object info of all the registered objects with a given type.
      Parameters:
      type - The type name.
      context - The Context map to send with the invocation.
      Returns:
      The object infos.

    • getObjectInfosByTypeAsync

      default CompletableFuture<ObjectInfo[]> getObjectInfosByTypeAsync(String type)
      Gets the object info of all the registered objects with a given type.
      Parameters:
      type - The type name.
      Returns:
      The object infos.

    • getObjectInfosByTypeAsync

      default CompletableFuture<ObjectInfo[]> getObjectInfosByTypeAsync(String type, Map<String,String> context)
      Gets the object info of all the registered objects with a given type.
      Parameters:
      type - The type name.
      context - The Context map to send with the invocation.
      Returns:
      The object infos.

    • getAllObjectInfos

      default ObjectInfo[] getAllObjectInfos(String expr)
      Gets the object info of all the registered objects whose stringified identities match the given expression.
      Parameters:
      expr - The expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.
      Returns:
      All the object infos with a stringified identity matching the given expression.

    • getAllObjectInfos

      default ObjectInfo[] getAllObjectInfos(String expr, Map<String,String> context)
      Gets the object info of all the registered objects whose stringified identities match the given expression.
      Parameters:
      expr - The expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.
      context - The Context map to send with the invocation.
      Returns:
      All the object infos with a stringified identity matching the given expression.

    • getAllObjectInfosAsync

      default CompletableFuture<ObjectInfo[]> getAllObjectInfosAsync(String expr)
      Gets the object info of all the registered objects whose stringified identities match the given expression.
      Parameters:
      expr - The expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.
      Returns:
      All the object infos with a stringified identity matching the given expression.

    • getAllObjectInfosAsync

      default CompletableFuture<ObjectInfo[]> getAllObjectInfosAsync(String expr, Map<String,String> context)
      Gets the object info of all the registered objects whose stringified identities match the given expression.
      Parameters:
      expr - The expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.
      context - The Context map to send with the invocation.
      Returns:
      All the object infos with a stringified identity matching the given expression.

    • pingNode

      default boolean pingNode(String name) throws NodeNotExistException
      Pings an IceGrid node to see if it is active.
      Parameters:
      name - The node name.
      Returns:
      true if the node ping succeeded, false otherwise.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.

    • pingNode

      default boolean pingNode(String name, Map<String,String> context) throws NodeNotExistException
      Pings an IceGrid node to see if it is active.
      Parameters:
      name - The node name.
      context - The Context map to send with the invocation.
      Returns:
      true if the node ping succeeded, false otherwise.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.

    • pingNodeAsync

      default CompletableFuture<Boolean> pingNodeAsync(String name)
      Pings an IceGrid node to see if it is active.
      Parameters:
      name - The node name.
      Returns:
      true if the node ping succeeded, false otherwise.

    • pingNodeAsync

      default CompletableFuture<Boolean> pingNodeAsync(String name, Map<String,String> context)
      Pings an IceGrid node to see if it is active.
      Parameters:
      name - The node name.
      context - The Context map to send with the invocation.
      Returns:
      true if the node ping succeeded, false otherwise.

    • getNodeLoad

      default LoadInfo getNodeLoad(String name) throws NodeNotExistException, NodeUnreachableException
      Gets the load averages of a node.
      Parameters:
      name - The node name.
      Returns:
      The node load information.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • getNodeLoad

      default LoadInfo getNodeLoad(String name, Map<String,String> context) throws NodeNotExistException, NodeUnreachableException
      Gets the load averages of a node.
      Parameters:
      name - The node name.
      context - The Context map to send with the invocation.
      Returns:
      The node load information.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • getNodeLoadAsync

      default CompletableFuture<LoadInfo> getNodeLoadAsync(String name)
      Gets the load averages of a node.
      Parameters:
      name - The node name.
      Returns:
      The node load information.

    • getNodeLoadAsync

      default CompletableFuture<LoadInfo> getNodeLoadAsync(String name, Map<String,String> context)
      Gets the load averages of a node.
      Parameters:
      name - The node name.
      context - The Context map to send with the invocation.
      Returns:
      The node load information.

    • getNodeInfo

      default NodeInfo getNodeInfo(String name) throws NodeNotExistException, NodeUnreachableException
      Gets the node information of a node.
      Parameters:
      name - The node name.
      Returns:
      The node information.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • getNodeInfo

      default NodeInfo getNodeInfo(String name, Map<String,String> context) throws NodeNotExistException, NodeUnreachableException
      Gets the node information of a node.
      Parameters:
      name - The node name.
      context - The Context map to send with the invocation.
      Returns:
      The node information.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • getNodeInfoAsync

      default CompletableFuture<NodeInfo> getNodeInfoAsync(String name)
      Gets the node information of a node.
      Parameters:
      name - The node name.
      Returns:
      The node information.

    • getNodeInfoAsync

      default CompletableFuture<NodeInfo> getNodeInfoAsync(String name, Map<String,String> context)
      Gets the node information of a node.
      Parameters:
      name - The node name.
      context - The Context map to send with the invocation.
      Returns:
      The node information.

    • getNodeAdmin

      default ObjectPrx getNodeAdmin(String name) throws NodeNotExistException, NodeUnreachableException
      Gets a proxy to the admin object of an IceGrid node.
      Parameters:
      name - The IceGrid node name.
      Returns:
      A proxy to the IceGrid node's admin object. This proxy is never null.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • getNodeAdmin

      default ObjectPrx getNodeAdmin(String name, Map<String,String> context) throws NodeNotExistException, NodeUnreachableException
      Gets a proxy to the admin object of an IceGrid node.
      Parameters:
      name - The IceGrid node name.
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the IceGrid node's admin object. This proxy is never null.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • getNodeAdminAsync

      default CompletableFuture<ObjectPrx> getNodeAdminAsync(String name)
      Gets a proxy to the admin object of an IceGrid node.
      Parameters:
      name - The IceGrid node name.
      Returns:
      A proxy to the IceGrid node's admin object. This proxy is never null.

    • getNodeAdminAsync

      default CompletableFuture<ObjectPrx> getNodeAdminAsync(String name, Map<String,String> context)
      Gets a proxy to the admin object of an IceGrid node.
      Parameters:
      name - The IceGrid node name.
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the IceGrid node's admin object. This proxy is never null.

    • getNodeProcessorSocketCount

      default int getNodeProcessorSocketCount(String name) throws NodeNotExistException, NodeUnreachableException
      Gets the number of physical processor sockets in the computer where an IceGrid node is deployed. Note that this operation returns 1 on operating systems where this can't be automatically determined and where the IceGrid.Node.ProcessorSocketCount property for the node is not set.
      Parameters:
      name - The node name.
      Returns:
      The number of processor sockets or 1 if the number of sockets can't be determined.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • getNodeProcessorSocketCount

      default int getNodeProcessorSocketCount(String name, Map<String,String> context) throws NodeNotExistException, NodeUnreachableException
      Gets the number of physical processor sockets in the computer where an IceGrid node is deployed. Note that this operation returns 1 on operating systems where this can't be automatically determined and where the IceGrid.Node.ProcessorSocketCount property for the node is not set.
      Parameters:
      name - The node name.
      context - The Context map to send with the invocation.
      Returns:
      The number of processor sockets or 1 if the number of sockets can't be determined.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • getNodeProcessorSocketCountAsync

      default CompletableFuture<Integer> getNodeProcessorSocketCountAsync(String name)
      Gets the number of physical processor sockets in the computer where an IceGrid node is deployed. Note that this operation returns 1 on operating systems where this can't be automatically determined and where the IceGrid.Node.ProcessorSocketCount property for the node is not set.
      Parameters:
      name - The node name.
      Returns:
      The number of processor sockets or 1 if the number of sockets can't be determined.

    • getNodeProcessorSocketCountAsync

      default CompletableFuture<Integer> getNodeProcessorSocketCountAsync(String name, Map<String,String> context)
      Gets the number of physical processor sockets in the computer where an IceGrid node is deployed. Note that this operation returns 1 on operating systems where this can't be automatically determined and where the IceGrid.Node.ProcessorSocketCount property for the node is not set.
      Parameters:
      name - The node name.
      context - The Context map to send with the invocation.
      Returns:
      The number of processor sockets or 1 if the number of sockets can't be determined.

    • shutdownNode

      default void shutdownNode(String name) throws NodeNotExistException, NodeUnreachableException
      Shuts down an IceGrid node.
      Parameters:
      name - The node name.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • shutdownNode

      default void shutdownNode(String name, Map<String,String> context) throws NodeNotExistException, NodeUnreachableException
      Shuts down an IceGrid node.
      Parameters:
      name - The node name.
      context - The Context map to send with the invocation.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • shutdownNodeAsync

      default CompletableFuture<Void> shutdownNodeAsync(String name)
      Shuts down an IceGrid node.
      Parameters:
      name - The node name.
      Returns:
      A future that will be completed when the invocation completes.

    • shutdownNodeAsync

      default CompletableFuture<Void> shutdownNodeAsync(String name, Map<String,String> context)
      Shuts down an IceGrid node.
      Parameters:
      name - The node name.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • getNodeHostname

      default String getNodeHostname(String name) throws NodeNotExistException, NodeUnreachableException
      Get the hostname of a node.
      Parameters:
      name - The node name.
      Returns:
      The node hostname.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • getNodeHostname

      default String getNodeHostname(String name, Map<String,String> context) throws NodeNotExistException, NodeUnreachableException
      Get the hostname of a node.
      Parameters:
      name - The node name.
      context - The Context map to send with the invocation.
      Returns:
      The node hostname.
      Throws:
      NodeNotExistException - Thrown when the node doesn't exist.
      NodeUnreachableException - Thrown when the node is unreachable.

    • getNodeHostnameAsync

      default CompletableFuture<String> getNodeHostnameAsync(String name)
      Get the hostname of a node.
      Parameters:
      name - The node name.
      Returns:
      The node hostname.

    • getNodeHostnameAsync

      default CompletableFuture<String> getNodeHostnameAsync(String name, Map<String,String> context)
      Get the hostname of a node.
      Parameters:
      name - The node name.
      context - The Context map to send with the invocation.
      Returns:
      The node hostname.

    • getAllNodeNames

      default String[] getAllNodeNames()
      Gets the names of all IceGrid nodes currently registered.
      Returns:
      The node names.

    • getAllNodeNames

      default String[] getAllNodeNames(Map<String,String> context)
      Gets the names of all IceGrid nodes currently registered.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The node names.

    • getAllNodeNamesAsync

      default CompletableFuture<String[]> getAllNodeNamesAsync()
      Gets the names of all IceGrid nodes currently registered.
      Returns:
      The node names.

    • getAllNodeNamesAsync

      default CompletableFuture<String[]> getAllNodeNamesAsync(Map<String,String> context)
      Gets the names of all IceGrid nodes currently registered.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The node names.

    • pingRegistry

      default boolean pingRegistry(String name) throws RegistryNotExistException
      Pings an IceGrid registry to see if it is active.
      Parameters:
      name - The registry name.
      Returns:
      true if the registry ping succeeded, false otherwise.
      Throws:
      RegistryNotExistException - Thrown when the registry doesn't exist.

    • pingRegistry

      default boolean pingRegistry(String name, Map<String,String> context) throws RegistryNotExistException
      Pings an IceGrid registry to see if it is active.
      Parameters:
      name - The registry name.
      context - The Context map to send with the invocation.
      Returns:
      true if the registry ping succeeded, false otherwise.
      Throws:
      RegistryNotExistException - Thrown when the registry doesn't exist.

    • pingRegistryAsync

      default CompletableFuture<Boolean> pingRegistryAsync(String name)
      Pings an IceGrid registry to see if it is active.
      Parameters:
      name - The registry name.
      Returns:
      true if the registry ping succeeded, false otherwise.

    • pingRegistryAsync

      default CompletableFuture<Boolean> pingRegistryAsync(String name, Map<String,String> context)
      Pings an IceGrid registry to see if it is active.
      Parameters:
      name - The registry name.
      context - The Context map to send with the invocation.
      Returns:
      true if the registry ping succeeded, false otherwise.

    • getRegistryInfo

      default RegistryInfo getRegistryInfo(String name) throws RegistryNotExistException, RegistryUnreachableException
      Gets the registry information of an IceGrid registry.
      Parameters:
      name - The registry name.
      Returns:
      The registry information.
      Throws:
      RegistryNotExistException - Thrown when the registry doesn't exist.
      RegistryUnreachableException - Thrown when the registry is unreachable.

    • getRegistryInfo

      default RegistryInfo getRegistryInfo(String name, Map<String,String> context) throws RegistryNotExistException, RegistryUnreachableException
      Gets the registry information of an IceGrid registry.
      Parameters:
      name - The registry name.
      context - The Context map to send with the invocation.
      Returns:
      The registry information.
      Throws:
      RegistryNotExistException - Thrown when the registry doesn't exist.
      RegistryUnreachableException - Thrown when the registry is unreachable.

    • getRegistryInfoAsync

      default CompletableFuture<RegistryInfo> getRegistryInfoAsync(String name)
      Gets the registry information of an IceGrid registry.
      Parameters:
      name - The registry name.
      Returns:
      The registry information.

    • getRegistryInfoAsync

      default CompletableFuture<RegistryInfo> getRegistryInfoAsync(String name, Map<String,String> context)
      Gets the registry information of an IceGrid registry.
      Parameters:
      name - The registry name.
      context - The Context map to send with the invocation.
      Returns:
      The registry information.

    • getRegistryAdmin

      default ObjectPrx getRegistryAdmin(String name) throws RegistryNotExistException
      Gets a proxy to the admin object of an IceGrid registry.
      Parameters:
      name - The registry name.
      Returns:
      A proxy to the admin object of an IceGrid registry. This proxy is never null.
      Throws:
      RegistryNotExistException - Thrown when the registry doesn't exist.

    • getRegistryAdmin

      default ObjectPrx getRegistryAdmin(String name, Map<String,String> context) throws RegistryNotExistException
      Gets a proxy to the admin object of an IceGrid registry.
      Parameters:
      name - The registry name.
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the admin object of an IceGrid registry. This proxy is never null.
      Throws:
      RegistryNotExistException - Thrown when the registry doesn't exist.

    • getRegistryAdminAsync

      default CompletableFuture<ObjectPrx> getRegistryAdminAsync(String name)
      Gets a proxy to the admin object of an IceGrid registry.
      Parameters:
      name - The registry name.
      Returns:
      A proxy to the admin object of an IceGrid registry. This proxy is never null.

    • getRegistryAdminAsync

      default CompletableFuture<ObjectPrx> getRegistryAdminAsync(String name, Map<String,String> context)
      Gets a proxy to the admin object of an IceGrid registry.
      Parameters:
      name - The registry name.
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the admin object of an IceGrid registry. This proxy is never null.

    • shutdownRegistry

      default void shutdownRegistry(String name) throws RegistryNotExistException, RegistryUnreachableException
      Shuts down an IceGrid registry.
      Parameters:
      name - The registry name.
      Throws:
      RegistryNotExistException - Thrown when the registry doesn't exist.
      RegistryUnreachableException - Thrown when the registry is unreachable.

    • shutdownRegistry

      default void shutdownRegistry(String name, Map<String,String> context) throws RegistryNotExistException, RegistryUnreachableException
      Shuts down an IceGrid registry.
      Parameters:
      name - The registry name.
      context - The Context map to send with the invocation.
      Throws:
      RegistryNotExistException - Thrown when the registry doesn't exist.
      RegistryUnreachableException - Thrown when the registry is unreachable.

    • shutdownRegistryAsync

      default CompletableFuture<Void> shutdownRegistryAsync(String name)
      Shuts down an IceGrid registry.
      Parameters:
      name - The registry name.
      Returns:
      A future that will be completed when the invocation completes.

    • shutdownRegistryAsync

      default CompletableFuture<Void> shutdownRegistryAsync(String name, Map<String,String> context)
      Shuts down an IceGrid registry.
      Parameters:
      name - The registry name.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • getAllRegistryNames

      default String[] getAllRegistryNames()
      Gets the names of all the IceGrid registries currently registered.
      Returns:
      The registry names.

    • getAllRegistryNames

      default String[] getAllRegistryNames(Map<String,String> context)
      Gets the names of all the IceGrid registries currently registered.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The registry names.

    • getAllRegistryNamesAsync

      default CompletableFuture<String[]> getAllRegistryNamesAsync()
      Gets the names of all the IceGrid registries currently registered.
      Returns:
      The registry names.

    • getAllRegistryNamesAsync

      default CompletableFuture<String[]> getAllRegistryNamesAsync(Map<String,String> context)
      Gets the names of all the IceGrid registries currently registered.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The registry names.

    • shutdown

      default void shutdown()
      Shuts down the IceGrid registry.

    • shutdown

      default void shutdown(Map<String,String> context)
      Shuts down the IceGrid registry.
      Parameters:
      context - The Context map to send with the invocation.

    • shutdownAsync

      default CompletableFuture<Void> shutdownAsync()
      Shuts down the IceGrid registry.
      Returns:
      A future that will be completed when the invocation completes.

    • shutdownAsync

      default CompletableFuture<Void> shutdownAsync(Map<String,String> context)
      Shuts down the IceGrid registry.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • createProxy

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

    • checkedCast

      static AdminPrx 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 AdminPrx 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 AdminPrx 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 AdminPrx 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 AdminPrx 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 AdminPrx 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

      AdminPrx 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
      Parameters:
      newContext - The context for the new proxy.
      Returns:
      A proxy with the new per-proxy context.

    • ice_adapterId

      AdminPrx 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
      Parameters:
      newAdapterId - The adapter ID for the new proxy.
      Returns:
      A proxy with the new adapter ID.

    • ice_endpoints

      AdminPrx 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
      Parameters:
      newEndpoints - The endpoints for the new proxy.
      Returns:
      A proxy with the new endpoints.

    • ice_locatorCacheTimeout

      AdminPrx 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
      Parameters:
      newTimeout - The new locator cache timeout (in seconds).
      Returns:
      A proxy with the new timeout.
      See Also:

    • ice_invocationTimeout

      AdminPrx 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
      Parameters:
      newTimeout - The new invocation timeout (in milliseconds).
      Returns:
      The proxy with the new timeout.

    • ice_invocationTimeout

      AdminPrx 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
      Parameters:
      newTimeout - The new invocation timeout.
      Returns:
      The proxy with the new timeout.

    • ice_connectionCached

      AdminPrx 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
      Parameters:
      newCache - true if the new proxy should cache connections; false otherwise.
      Returns:
      The proxy with the specified caching policy.

    • ice_endpointSelection

      AdminPrx 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
      Parameters:
      newType - The new endpoint selection policy.
      Returns:
      The proxy with the specified endpoint selection policy.
      See Also:

    • ice_encodingVersion

      AdminPrx 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
      Parameters:
      e - The encoding version to use to marshal request parameters.
      Returns:
      The proxy with the specified encoding version.

    • ice_router

      AdminPrx 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
      Parameters:
      router - The router for the new proxy.
      Returns:
      The proxy with the specified router.

    • ice_locator

      AdminPrx 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
      Parameters:
      locator - The locator for the new proxy.
      Returns:
      The proxy with the specified locator.

    • ice_collocationOptimized

      AdminPrx 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
      Parameters:
      b - true if the new proxy enables collocation optimization; false otherwise.
      Returns:
      The proxy with the specified collocation optimization.

    • ice_twoway

      AdminPrx 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
      Returns:
      A proxy that uses twoway invocations.

    • ice_oneway

      AdminPrx 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
      Returns:
      A proxy that uses oneway invocations.

    • ice_batchOneway

      AdminPrx 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
      Returns:
      A proxy that uses batch oneway invocations.

    • ice_datagram

      AdminPrx 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
      Returns:
      A proxy that uses datagram invocations.

    • ice_batchDatagram

      AdminPrx 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
      Returns:
      A proxy that uses batch datagram invocations.

    • ice_compress

      AdminPrx 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
      Parameters:
      co - true enables compression for the new proxy; false disables compression.
      Returns:
      A proxy with the specified compression setting.

    • ice_connectionId

      AdminPrx 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
      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

      AdminPrx 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
      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::Admin"