Module com.zeroc.icegrid

Package com.zeroc.IceGrid

Interface AsyncAdmin

All Superinterfaces:

Object

public interface AsyncAdmin
extends Object

Provides administrative access to an IceGrid deployment.

Remarks: The Slice compiler generated this skeleton interface from Slice interface ::IceGrid::Admin.

Nested Class Summary

Nested classes/interfaces inherited from interface com.zeroc.Ice.Object

Object.Ice_invokeResult

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	addApplicationAsync(ApplicationDescriptor descriptor, Current current)	Adds an application to IceGrid.
CompletionStage<Void>	addObjectAsync(ObjectPrx obj, Current current)	Adds an object to the object registry.
CompletionStage<Void>	addObjectWithTypeAsync(ObjectPrx obj, String type, Current current)	Adds an object to the object registry and explicitly specifies its type.
default CompletionStage<OutgoingResponse>	dispatch(IncomingRequest request)	Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.
CompletionStage<Void>	enableServerAsync(String id, boolean enabled, Current current)	Enables or disables a server.
CompletionStage<AdapterInfo[]>	getAdapterInfoAsync(String id, Current current)	Gets adapter information for the replica group or adapter with the given ID.
CompletionStage<String[]>	getAllAdapterIdsAsync(Current current)	Gets the IDs of all adapters registered with IceGrid.
CompletionStage<String[]>	getAllApplicationNamesAsync(Current current)	Gets all the IceGrid applications currently registered.
CompletionStage<String[]>	getAllNodeNamesAsync(Current current)	Gets the names of all IceGrid nodes currently registered.
CompletionStage<ObjectInfo[]>	getAllObjectInfosAsync(String expr, Current current)	Gets the object info of all the registered objects whose stringified identities match the given expression.
CompletionStage<String[]>	getAllRegistryNamesAsync(Current current)	Gets the names of all the IceGrid registries currently registered.
CompletionStage<String[]>	getAllServerIdsAsync(Current current)	Gets the IDs of all the servers registered with IceGrid.
CompletionStage<ApplicationInfo>	getApplicationInfoAsync(String name, Current current)	Gets an application descriptor.
CompletionStage<ApplicationDescriptor>	getDefaultApplicationDescriptorAsync(Current current)	Gets the default application descriptor.
CompletionStage<ObjectPrx>	getNodeAdminAsync(String name, Current current)	Gets a proxy to the admin object of an IceGrid node.
CompletionStage<String>	getNodeHostnameAsync(String name, Current current)	Get the hostname of a node.
CompletionStage<NodeInfo>	getNodeInfoAsync(String name, Current current)	Gets the node information of a node.
CompletionStage<LoadInfo>	getNodeLoadAsync(String name, Current current)	Gets the load averages of a node.
CompletionStage<Integer>	getNodeProcessorSocketCountAsync(String name, Current current)	Gets the number of physical processor sockets in the computer where an IceGrid node is deployed.
CompletionStage<ObjectInfo>	getObjectInfoAsync(Identity id, Current current)	Gets the object info for the object.
CompletionStage<ObjectInfo[]>	getObjectInfosByTypeAsync(String type, Current current)	Gets the object info of all the registered objects with a given type.
CompletionStage<ObjectPrx>	getRegistryAdminAsync(String name, Current current)	Gets a proxy to the admin object of an IceGrid registry.
CompletionStage<RegistryInfo>	getRegistryInfoAsync(String name, Current current)	Gets the registry information of an IceGrid registry.
CompletionStage<ObjectPrx>	getServerAdminAsync(String id, Current current)	Gets a proxy to the admin object of a server.
CompletionStage<String>	getServerAdminCategoryAsync(Current current)	Gets the category for server admin objects.
CompletionStage<ServerInfo>	getServerInfoAsync(String id, Current current)	Gets information about a server.
CompletionStage<Integer>	getServerPidAsync(String id, Current current)	Gets the system process ID of a server.
CompletionStage<ServerState>	getServerStateAsync(String id, Current current)	Gets the state of a server.
static String	ice_staticId()	Gets the type ID of the associated Slice interface.
CompletionStage<Void>	instantiateServerAsync(String application, String node, ServerInstanceDescriptor desc, Current current)	Instantiates a server template.
CompletionStage<Boolean>	isServerEnabledAsync(String id, Current current)	Checks if the server is enabled or disabled.
CompletionStage<Boolean>	pingNodeAsync(String name, Current current)	Pings an IceGrid node to see if it is active.
CompletionStage<Boolean>	pingRegistryAsync(String name, Current current)	Pings an IceGrid registry to see if it is active.
CompletionStage<Void>	removeAdapterAsync(String id, Current current)	Removes the adapter with the given ID.
CompletionStage<Void>	removeApplicationAsync(String name, Current current)	Removes an application from IceGrid.
CompletionStage<Void>	removeObjectAsync(Identity id, Current current)	Removes an object from the object registry.
CompletionStage<Void>	sendSignalAsync(String id, String signal, Current current)	Sends a signal to a server.
CompletionStage<Void>	shutdownAsync(Current current)	Shuts down the IceGrid registry.
CompletionStage<Void>	shutdownNodeAsync(String name, Current current)	Shuts down an IceGrid node.
CompletionStage<Void>	shutdownRegistryAsync(String name, Current current)	Shuts down an IceGrid registry.
CompletionStage<Void>	startServerAsync(String id, Current current)	Starts a server and waits for its activation.
CompletionStage<Void>	stopServerAsync(String id, Current current)	Stops a server.
CompletionStage<Void>	syncApplicationAsync(ApplicationDescriptor descriptor, Current current)	Synchronizes a deployed application.
CompletionStage<Void>	syncApplicationWithoutRestartAsync(ApplicationDescriptor descriptor, Current current)	Synchronizes a deployed application.
CompletionStage<Void>	updateApplicationAsync(ApplicationUpdateDescriptor descriptor, Current current)	Updates a deployed application.
CompletionStage<Void>	updateApplicationWithoutRestartAsync(ApplicationUpdateDescriptor descriptor, Current current)	Updates a deployed application.
CompletionStage<Void>	updateObjectAsync(ObjectPrx obj, Current current)	Updates an object in the object registry.

Methods inherited from interface com.zeroc.Ice.Object

ice_id, ice_ids, ice_isA, ice_ping

Method Details

addApplicationAsync

CompletionStage<Void> addApplicationAsync(ApplicationDescriptor descriptor,
 Current current)
                                   throws AccessDeniedException,
DeploymentException

Adds an application to IceGrid.

Parameters:

descriptor - The application descriptor.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

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.

syncApplicationAsync

CompletionStage<Void> syncApplicationAsync(ApplicationDescriptor descriptor,
 Current current)
                                    throws AccessDeniedException,
DeploymentException,
ApplicationNotExistException

Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor.

Parameters:

descriptor - The new application descriptor.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

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

CompletionStage<Void> updateApplicationAsync(ApplicationUpdateDescriptor descriptor,
 Current current)
                                      throws AccessDeniedException,
DeploymentException,
ApplicationNotExistException

Updates a deployed application.

Parameters:

descriptor - The update descriptor.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

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

CompletionStage<Void> syncApplicationWithoutRestartAsync(ApplicationDescriptor descriptor,
 Current current)
                                                  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.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

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

CompletionStage<Void> updateApplicationWithoutRestartAsync(ApplicationUpdateDescriptor descriptor,
 Current current)
                                                    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.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

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

CompletionStage<Void> removeApplicationAsync(String name,
 Current current)
                                      throws AccessDeniedException,
DeploymentException,
ApplicationNotExistException

Removes an application from IceGrid.

Parameters:

name - The application name.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

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

CompletionStage<Void> instantiateServerAsync(String application,
 String node,
 ServerInstanceDescriptor desc,
 Current current)
                                      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.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

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.

getApplicationInfoAsync

CompletionStage<ApplicationInfo> getApplicationInfoAsync(String name,
 Current current)
                                                  throws ApplicationNotExistException

Gets an application descriptor.

Parameters:

name - The application name.

current - the Current object of the incoming request

Returns:

The application descriptor.

Throws:

ApplicationNotExistException - Thrown when the application doesn't exist.

getDefaultApplicationDescriptorAsync

CompletionStage<ApplicationDescriptor> getDefaultApplicationDescriptorAsync(Current current)
                                                                     throws DeploymentException

Gets the default application descriptor.

Parameters:

current - the Current object of the incoming request

Returns:

The default application descriptor.

Throws:

DeploymentException - Thrown when the default application descriptor is invalid or unreachable.

getAllApplicationNamesAsync

CompletionStage<String[]> getAllApplicationNamesAsync(Current current)

Gets all the IceGrid applications currently registered.

Parameters:

current - the Current object of the incoming request

Returns:

The application names.

getServerInfoAsync

CompletionStage<ServerInfo> getServerInfoAsync(String id,
 Current current)
                                        throws ServerNotExistException

Gets information about a server.

Parameters:

id - The server ID.

current - the Current object of the incoming request

Returns:

The server information.

Throws:

ServerNotExistException - Thrown when the server doesn't exist.

getServerStateAsync

CompletionStage<ServerState> getServerStateAsync(String id,
 Current current)
                                          throws ServerNotExistException,
NodeUnreachableException,
DeploymentException

Gets the state of a server.

Parameters:

id - The server ID.

current - the Current object of the incoming request

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.

getServerPidAsync

CompletionStage<Integer> getServerPidAsync(String id,
 Current current)
                                    throws ServerNotExistException,
NodeUnreachableException,
DeploymentException

Gets the system process ID of a server. The process ID is operating system dependent.

Parameters:

id - The server ID.

current - the Current object of the incoming request

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.

getServerAdminCategoryAsync

CompletionStage<String> getServerAdminCategoryAsync(Current current)

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:

current - the Current object of the incoming request

Returns:

The category for server admin objects.

getServerAdminAsync

CompletionStage<ObjectPrx> getServerAdminAsync(String id,
 Current current)
                                        throws ServerNotExistException,
NodeUnreachableException,
DeploymentException

Gets a proxy to the admin object of a server.

Parameters:

id - The server ID.

current - the Current object of the incoming request

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.

enableServerAsync

CompletionStage<Void> enableServerAsync(String id,
 boolean enabled,
 Current current)
                                 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.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

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

CompletionStage<Boolean> isServerEnabledAsync(String id,
 Current current)
                                       throws ServerNotExistException,
NodeUnreachableException,
DeploymentException

Checks if the server is enabled or disabled.

Parameters:

id - The server ID.

current - the Current object of the incoming request

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.

startServerAsync

CompletionStage<Void> startServerAsync(String id,
 Current current)
                                throws ServerNotExistException,
ServerStartException,
NodeUnreachableException,
DeploymentException

Starts a server and waits for its activation.

Parameters:

id - The server id.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

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.

stopServerAsync

CompletionStage<Void> stopServerAsync(String id,
 Current current)
                               throws ServerNotExistException,
ServerStopException,
NodeUnreachableException,
DeploymentException

Stops a server.

Parameters:

id - The server ID.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

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.

sendSignalAsync

CompletionStage<Void> sendSignalAsync(String id,
 String signal,
 Current current)
                               throws ServerNotExistException,
NodeUnreachableException,
DeploymentException,
BadSignalException

Sends a signal to a server.

Parameters:

id - The server ID.

signal - The signal, for example SIGTERM or 15.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

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.

getAllServerIdsAsync

CompletionStage<String[]> getAllServerIdsAsync(Current current)

Gets the IDs of all the servers registered with IceGrid.

Parameters:

current - the Current object of the incoming request

Returns:

The server IDs.

getAdapterInfoAsync

CompletionStage<AdapterInfo[]> getAdapterInfoAsync(String id,
 Current current)
                                            throws AdapterNotExistException

Gets adapter information for the replica group or adapter with the given ID.

Parameters:

id - The adapter or replica group ID.

current - the Current object of the incoming request

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.

removeAdapterAsync

CompletionStage<Void> removeAdapterAsync(String id,
 Current current)
                                  throws AdapterNotExistException,
DeploymentException

Removes the adapter with the given ID.

Parameters:

id - The adapter ID.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

Throws:

AdapterNotExistException - Thrown when the adapter doesn't exist.

DeploymentException - Thrown when the application deployment failed.

getAllAdapterIdsAsync

CompletionStage<String[]> getAllAdapterIdsAsync(Current current)

Gets the IDs of all adapters registered with IceGrid.

Parameters:

current - the Current object of the incoming request

Returns:

The adapter IDs.

addObjectAsync

CompletionStage<Void> addObjectAsync(ObjectPrx obj,
 Current current)
                              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.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

Throws:

DeploymentException - Thrown when the object can't be added.

ObjectExistsException - Thrown when the object is already registered.

updateObjectAsync

CompletionStage<Void> updateObjectAsync(ObjectPrx obj,
 Current current)
                                 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.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

Throws:

DeploymentException - Thrown when the object can't be updated.

ObjectNotRegisteredException - Thrown when the object isn't registered with the registry.

addObjectWithTypeAsync

CompletionStage<Void> addObjectWithTypeAsync(ObjectPrx obj,
 String type,
 Current current)
                                      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.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

Throws:

DeploymentException - Thrown when the application deployment failed.

ObjectExistsException - Thrown when the object is already registered.

removeObjectAsync

CompletionStage<Void> removeObjectAsync(Identity id,
 Current current)
                                 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.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

Throws:

DeploymentException - Thrown when the object can't be removed.

ObjectNotRegisteredException - Thrown when the object isn't registered with the registry.

getObjectInfoAsync

CompletionStage<ObjectInfo> getObjectInfoAsync(Identity id,
 Current current)
                                        throws ObjectNotRegisteredException

Gets the object info for the object.

Parameters:

id - The identity of the object.

current - the Current object of the incoming request

Returns:

The object info.

Throws:

ObjectNotRegisteredException - Thrown when the object isn't registered with the registry.

getObjectInfosByTypeAsync

CompletionStage<ObjectInfo[]> getObjectInfosByTypeAsync(String type,
 Current current)

Gets the object info of all the registered objects with a given type.

Parameters:

type - The type name.

current - the Current object of the incoming request

Returns:

The object infos.

getAllObjectInfosAsync

CompletionStage<ObjectInfo[]> getAllObjectInfosAsync(String expr,
 Current current)

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.

current - the Current object of the incoming request

Returns:

All the object infos with a stringified identity matching the given expression.

pingNodeAsync

CompletionStage<Boolean> pingNodeAsync(String name,
 Current current)
                                throws NodeNotExistException

Pings an IceGrid node to see if it is active.

Parameters:

name - The node name.

current - the Current object of the incoming request

Returns:

true if the node ping succeeded, false otherwise.

Throws:

NodeNotExistException - Thrown when the node doesn't exist.

getNodeLoadAsync

CompletionStage<LoadInfo> getNodeLoadAsync(String name,
 Current current)
                                    throws NodeNotExistException,
NodeUnreachableException

Gets the load averages of a node.

Parameters:

name - The node name.

current - the Current object of the incoming request

Returns:

The node load information.

Throws:

NodeNotExistException - Thrown when the node doesn't exist.

NodeUnreachableException - Thrown when the node is unreachable.

getNodeInfoAsync

CompletionStage<NodeInfo> getNodeInfoAsync(String name,
 Current current)
                                    throws NodeNotExistException,
NodeUnreachableException

Gets the node information of a node.

Parameters:

name - The node name.

current - the Current object of the incoming request

Returns:

The node information.

Throws:

NodeNotExistException - Thrown when the node doesn't exist.

NodeUnreachableException - Thrown when the node is unreachable.

getNodeAdminAsync

CompletionStage<ObjectPrx> getNodeAdminAsync(String name,
 Current current)
                                      throws NodeNotExistException,
NodeUnreachableException

Gets a proxy to the admin object of an IceGrid node.

Parameters:

name - The IceGrid node name.

current - the Current object of the incoming request

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.

getNodeProcessorSocketCountAsync

CompletionStage<Integer> getNodeProcessorSocketCountAsync(String name,
 Current current)
                                                   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.

current - the Current object of the incoming request

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.

shutdownNodeAsync

CompletionStage<Void> shutdownNodeAsync(String name,
 Current current)
                                 throws NodeNotExistException,
NodeUnreachableException

Shuts down an IceGrid node.

Parameters:

name - The node name.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

Throws:

NodeNotExistException - Thrown when the node doesn't exist.

NodeUnreachableException - Thrown when the node is unreachable.

getNodeHostnameAsync

CompletionStage<String> getNodeHostnameAsync(String name,
 Current current)
                                      throws NodeNotExistException,
NodeUnreachableException

Get the hostname of a node.

Parameters:

name - The node name.

current - the Current object of the incoming request

Returns:

The node hostname.

Throws:

NodeNotExistException - Thrown when the node doesn't exist.

NodeUnreachableException - Thrown when the node is unreachable.

getAllNodeNamesAsync

CompletionStage<String[]> getAllNodeNamesAsync(Current current)

Gets the names of all IceGrid nodes currently registered.

Parameters:

current - the Current object of the incoming request

Returns:

The node names.

pingRegistryAsync

CompletionStage<Boolean> pingRegistryAsync(String name,
 Current current)
                                    throws RegistryNotExistException

Pings an IceGrid registry to see if it is active.

Parameters:

name - The registry name.

current - the Current object of the incoming request

Returns:

true if the registry ping succeeded, false otherwise.

Throws:

RegistryNotExistException - Thrown when the registry doesn't exist.

getRegistryInfoAsync

CompletionStage<RegistryInfo> getRegistryInfoAsync(String name,
 Current current)
                                            throws RegistryNotExistException,
RegistryUnreachableException

Gets the registry information of an IceGrid registry.

Parameters:

name - The registry name.

current - the Current object of the incoming request

Returns:

The registry information.

Throws:

RegistryNotExistException - Thrown when the registry doesn't exist.

RegistryUnreachableException - Thrown when the registry is unreachable.

getRegistryAdminAsync

CompletionStage<ObjectPrx> getRegistryAdminAsync(String name,
 Current current)
                                          throws RegistryNotExistException

Gets a proxy to the admin object of an IceGrid registry.

Parameters:

name - The registry name.

current - the Current object of the incoming request

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.

shutdownRegistryAsync

CompletionStage<Void> shutdownRegistryAsync(String name,
 Current current)
                                     throws RegistryNotExistException,
RegistryUnreachableException

Shuts down an IceGrid registry.

Parameters:

name - The registry name.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

Throws:

RegistryNotExistException - Thrown when the registry doesn't exist.

RegistryUnreachableException - Thrown when the registry is unreachable.

getAllRegistryNamesAsync

CompletionStage<String[]> getAllRegistryNamesAsync(Current current)

Gets the names of all the IceGrid registries currently registered.

Parameters:

current - the Current object of the incoming request

Returns:

The registry names.

shutdownAsync

CompletionStage<Void> shutdownAsync(Current current)

Shuts down the IceGrid registry.

Parameters:

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

ice_staticId

static String ice_staticId()

Gets the type ID of the associated Slice interface.

Returns:

the string "::IceGrid::Admin"

dispatch

default CompletionStage<OutgoingResponse> dispatch(IncomingRequest request)
                                            throws UserException

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

Specified by:

dispatch in interface Object

Parameters:

request - the incoming request

Returns:

the outgoing response

Throws:

UserException - if a UserException is thrown, Ice will marshal it as the response payload.