Package com.zeroc.IceGrid
Interface AdminPrx
- All Superinterfaces:
ObjectPrx
The IceGrid administrative interface.
Allowing access to this interface is a security risk! Please see the IceGrid documentation for further information.
-
Field Summary
Fields inherited from interface com.zeroc.Ice.ObjectPrx
ice_staticId, noExplicitContext
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
addApplication
(ApplicationDescriptor descriptor) Add an application to IceGrid.default void
addApplication
(ApplicationDescriptor descriptor, Map<String, String> context) Add an application to IceGrid.default CompletableFuture<Void>
addApplicationAsync
(ApplicationDescriptor descriptor) Add an application to IceGrid.default CompletableFuture<Void>
addApplicationAsync
(ApplicationDescriptor descriptor, Map<String, String> context) Add an application to IceGrid.default void
Add an object to the object registry.default void
Add an object to the object registry.default CompletableFuture<Void>
addObjectAsync
(ObjectPrx obj) Add an object to the object registry.default CompletableFuture<Void>
addObjectAsync
(ObjectPrx obj, Map<String, String> context) Add an object to the object registry.default void
addObjectWithType
(ObjectPrx obj, String type) Add an object to the object registry and explicitly specify its type.default void
Add an object to the object registry and explicitly specify its type.default CompletableFuture<Void>
addObjectWithTypeAsync
(ObjectPrx obj, String type) Add an object to the object registry and explicitly specify its type.default CompletableFuture<Void>
Add an object to the object registry and explicitly specify its type.static AdminPrx
checkedCast
(ObjectPrx obj) Contacts the remote server to verify that the object implements this type.static AdminPrx
checkedCast
(ObjectPrx obj, String facet) Contacts the remote server to verify that a facet of the object implements this type.static AdminPrx
Contacts the remote server to verify that a facet of the object implements this type.static AdminPrx
checkedCast
(ObjectPrx obj, Map<String, String> context) Contacts the remote server to verify that the object implements this type.default void
enableServer
(String id, boolean enabled) Enable or disable a server.default void
enableServer
(String id, boolean enabled, Map<String, String> context) Enable or disable a server.default CompletableFuture<Void>
enableServerAsync
(String id, boolean enabled) Enable or disable a server.default CompletableFuture<Void>
enableServerAsync
(String id, boolean enabled, Map<String, String> context) Enable or disable a server.default AdapterInfo[]
getAdapterInfo
(String id) Get the adapter information for the replica group or adapter with the given id.default AdapterInfo[]
getAdapterInfo
(String id, Map<String, String> context) Get the adapter information for the replica group or adapter with the given id.default CompletableFuture<AdapterInfo[]>
Get the adapter information for the replica group or adapter with the given id.default CompletableFuture<AdapterInfo[]>
getAdapterInfoAsync
(String id, Map<String, String> context) Get the adapter information for the replica group or adapter with the given id.default String[]
Get all the adapter ids registered with IceGrid.default String[]
getAllAdapterIds
(Map<String, String> context) Get all the adapter ids registered with IceGrid.default CompletableFuture<String[]>
Get all the adapter ids registered with IceGrid.default CompletableFuture<String[]>
getAllAdapterIdsAsync
(Map<String, String> context) Get all the adapter ids registered with IceGrid.default String[]
Get all the IceGrid applications currently registered.default String[]
getAllApplicationNames
(Map<String, String> context) Get all the IceGrid applications currently registered.default CompletableFuture<String[]>
Get all the IceGrid applications currently registered.default CompletableFuture<String[]>
getAllApplicationNamesAsync
(Map<String, String> context) Get all the IceGrid applications currently registered.default String[]
Get all the IceGrid nodes currently registered.default String[]
getAllNodeNames
(Map<String, String> context) Get all the IceGrid nodes currently registered.default CompletableFuture<String[]>
Get all the IceGrid nodes currently registered.default CompletableFuture<String[]>
getAllNodeNamesAsync
(Map<String, String> context) Get all the IceGrid nodes currently registered.default ObjectInfo[]
getAllObjectInfos
(String expr) Get the object info of all the registered objects whose stringified identities match the given expression.default ObjectInfo[]
getAllObjectInfos
(String expr, Map<String, String> context) Get the object info of all the registered objects whose stringified identities match the given expression.default CompletableFuture<ObjectInfo[]>
getAllObjectInfosAsync
(String expr) Get the object info of all the registered objects whose stringified identities match the given expression.default CompletableFuture<ObjectInfo[]>
getAllObjectInfosAsync
(String expr, Map<String, String> context) Get the object info of all the registered objects whose stringified identities match the given expression.default String[]
Get all the IceGrid registries currently registered.default String[]
getAllRegistryNames
(Map<String, String> context) Get all the IceGrid registries currently registered.default CompletableFuture<String[]>
Get all the IceGrid registries currently registered.default CompletableFuture<String[]>
getAllRegistryNamesAsync
(Map<String, String> context) Get all the IceGrid registries currently registered.default String[]
Get all the server ids registered with IceGrid.default String[]
getAllServerIds
(Map<String, String> context) Get all the server ids registered with IceGrid.default CompletableFuture<String[]>
Get all the server ids registered with IceGrid.default CompletableFuture<String[]>
getAllServerIdsAsync
(Map<String, String> context) Get all the server ids registered with IceGrid.default ApplicationInfo
getApplicationInfo
(String name) Get an application descriptor.default ApplicationInfo
getApplicationInfo
(String name, Map<String, String> context) Get an application descriptor.default CompletableFuture<ApplicationInfo>
Get an application descriptor.default CompletableFuture<ApplicationInfo>
getApplicationInfoAsync
(String name, Map<String, String> context) Get an application descriptor.default ApplicationDescriptor
Get the default application descriptor.default ApplicationDescriptor
getDefaultApplicationDescriptor
(Map<String, String> context) Get the default application descriptor.default CompletableFuture<ApplicationDescriptor>
Get the default application descriptor.default CompletableFuture<ApplicationDescriptor>
getDefaultApplicationDescriptorAsync
(Map<String, String> context) Get the default application descriptor.default ObjectPrx
getNodeAdmin
(String name) Get a proxy to the IceGrid node's admin object.default ObjectPrx
getNodeAdmin
(String name, Map<String, String> context) Get a proxy to the IceGrid node's admin object.default CompletableFuture<ObjectPrx>
getNodeAdminAsync
(String name) Get a proxy to the IceGrid node's admin object.default CompletableFuture<ObjectPrx>
getNodeAdminAsync
(String name, Map<String, String> context) Get a proxy to the IceGrid node's admin object.default String
getNodeHostname
(String name) Get the hostname of this node.default String
getNodeHostname
(String name, Map<String, String> context) Get the hostname of this node.default CompletableFuture<String>
getNodeHostnameAsync
(String name) Get the hostname of this node.default CompletableFuture<String>
getNodeHostnameAsync
(String name, Map<String, String> context) Get the hostname of this node.default NodeInfo
getNodeInfo
(String name) Get the node information for the node with the given name.default NodeInfo
getNodeInfo
(String name, Map<String, String> context) Get the node information for the node with the given name.default CompletableFuture<NodeInfo>
getNodeInfoAsync
(String name) Get the node information for the node with the given name.default CompletableFuture<NodeInfo>
getNodeInfoAsync
(String name, Map<String, String> context) Get the node information for the node with the given name.default LoadInfo
getNodeLoad
(String name) Get the load averages of the node.default LoadInfo
getNodeLoad
(String name, Map<String, String> context) Get the load averages of the node.default CompletableFuture<LoadInfo>
getNodeLoadAsync
(String name) Get the load averages of the node.default CompletableFuture<LoadInfo>
getNodeLoadAsync
(String name, Map<String, String> context) Get the load averages of the node.default int
Get the number of physical processor sockets for the machine running the node with the given name.default int
getNodeProcessorSocketCount
(String name, Map<String, String> context) Get the number of physical processor sockets for the machine running the node with the given name.default CompletableFuture<Integer>
Get the number of physical processor sockets for the machine running the node with the given name.default CompletableFuture<Integer>
getNodeProcessorSocketCountAsync
(String name, Map<String, String> context) Get the number of physical processor sockets for the machine running the node with the given name.default ObjectInfo
Get the object info for the object with the given identity.default ObjectInfo
getObjectInfo
(Identity id, Map<String, String> context) Get the object info for the object with the given identity.default CompletableFuture<ObjectInfo>
Get the object info for the object with the given identity.default CompletableFuture<ObjectInfo>
getObjectInfoAsync
(Identity id, Map<String, String> context) Get the object info for the object with the given identity.default ObjectInfo[]
getObjectInfosByType
(String type) Get the object info of all the registered objects with the given type.default ObjectInfo[]
getObjectInfosByType
(String type, Map<String, String> context) Get the object info of all the registered objects with the given type.default CompletableFuture<ObjectInfo[]>
Get the object info of all the registered objects with the given type.default CompletableFuture<ObjectInfo[]>
getObjectInfosByTypeAsync
(String type, Map<String, String> context) Get the object info of all the registered objects with the given type.default ObjectPrx
getRegistryAdmin
(String name) Get a proxy to the IceGrid registry's admin object.default ObjectPrx
getRegistryAdmin
(String name, Map<String, String> context) Get a proxy to the IceGrid registry's admin object.default CompletableFuture<ObjectPrx>
getRegistryAdminAsync
(String name) Get a proxy to the IceGrid registry's admin object.default CompletableFuture<ObjectPrx>
getRegistryAdminAsync
(String name, Map<String, String> context) Get a proxy to the IceGrid registry's admin object.default RegistryInfo
getRegistryInfo
(String name) Get the registry information for the registry with the given name.default RegistryInfo
getRegistryInfo
(String name, Map<String, String> context) Get the registry information for the registry with the given name.default CompletableFuture<RegistryInfo>
getRegistryInfoAsync
(String name) Get the registry information for the registry with the given name.default CompletableFuture<RegistryInfo>
getRegistryInfoAsync
(String name, Map<String, String> context) Get the registry information for the registry with the given name.default ObjectPrx
getServerAdmin
(String id) Get a proxy to the server's admin object.default ObjectPrx
getServerAdmin
(String id, Map<String, String> context) Get a proxy to the server's admin object.default CompletableFuture<ObjectPrx>
Get a proxy to the server's admin object.default CompletableFuture<ObjectPrx>
getServerAdminAsync
(String id, Map<String, String> context) Get a proxy to the server's admin object.default String
Get the category for server admin objects.default String
getServerAdminCategory
(Map<String, String> context) Get the category for server admin objects.default CompletableFuture<String>
Get the category for server admin objects.default CompletableFuture<String>
getServerAdminCategoryAsync
(Map<String, String> context) Get the category for server admin objects.default ServerInfo
getServerInfo
(String id) Get the server information for the server with the given id.default ServerInfo
getServerInfo
(String id, Map<String, String> context) Get the server information for the server with the given id.default CompletableFuture<ServerInfo>
Get the server information for the server with the given id.default CompletableFuture<ServerInfo>
getServerInfoAsync
(String id, Map<String, String> context) Get the server information for the server with the given id.default int
getServerPid
(String id) Get a server's system process id.default int
getServerPid
(String id, Map<String, String> context) Get a server's system process id.default CompletableFuture<Integer>
Get a server's system process id.default CompletableFuture<Integer>
getServerPidAsync
(String id, Map<String, String> context) Get a server's system process id.default ServerState
getServerState
(String id) Get a server's state.default ServerState
getServerState
(String id, Map<String, String> context) Get a server's state.default CompletableFuture<ServerState>
Get a server's state.default CompletableFuture<ServerState>
getServerStateAsync
(String id, Map<String, String> context) Get a server's state.Returns the checksums for the IceGrid Slice definitions.getSliceChecksums
(Map<String, String> context) Returns the checksums for the IceGrid Slice definitions.default CompletableFuture<Map<String,
String>> Returns the checksums for the IceGrid Slice definitions.default CompletableFuture<Map<String,
String>> getSliceChecksumsAsync
(Map<String, String> context) Returns the checksums for the IceGrid Slice definitions.default AdminPrx
ice_adapterId
(String newAdapterId) Returns a proxy that is identical to this proxy, except for the adapter ID.default AdminPrx
Returns a proxy that is identical to this proxy, but uses batch datagram invocations.default AdminPrx
Returns a proxy that is identical to this proxy, but uses batch oneway invocations.default AdminPrx
ice_collocationOptimized
(boolean b) Returns a proxy that is identical to this proxy, except for collocation optimization.default AdminPrx
ice_compress
(boolean co) Returns a proxy that is identical to this proxy, except for compression.default AdminPrx
ice_connectionCached
(boolean newCache) Returns a proxy that is identical to this proxy, except for connection caching.default AdminPrx
ice_connectionId
(String connectionId) Returns a proxy that is identical to this proxy, except for its connection ID.default AdminPrx
ice_context
(Map<String, String> newContext) Returns a proxy that is identical to this proxy, except for the per-proxy context.default AdminPrx
Returns a proxy that is identical to this proxy, but uses datagram invocations.default AdminPrx
Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.default AdminPrx
ice_endpoints
(Endpoint[] newEndpoints) Returns a proxy that is identical to this proxy, except for the endpoints.default AdminPrx
Returns a proxy that is identical to this proxy, except for the endpoint selection policy.default AdminPrx
ice_fixed
(Connection connection) Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy connection.default AdminPrx
ice_invocationTimeout
(int newTimeout) Returns a proxy that is identical to this proxy, except for the invocation timeout.default AdminPrx
ice_locator
(LocatorPrx locator) Returns a proxy that is identical to this proxy, except for the locator.default AdminPrx
ice_locatorCacheTimeout
(int newTimeout) Returns a proxy that is identical to this proxy, except for the locator cache timeout.default AdminPrx
Returns a proxy that is identical to this proxy, but uses oneway invocations.default AdminPrx
ice_preferSecure
(boolean b) Returns a proxy that is identical to this proxy, except for its endpoint selection policy.default AdminPrx
ice_router
(RouterPrx router) Returns a proxy that is identical to this proxy, except for the router.default AdminPrx
ice_secure
(boolean b) Returns a proxy that is identical to this proxy, except for how it selects endpoints.static String
Returns the Slice type ID associated with this type.default AdminPrx
ice_timeout
(int t) Returns a proxy that is identical to this proxy, except for its connection timeout setting.default AdminPrx
Returns a proxy that is identical to this proxy, but uses twoway invocations.default void
instantiateServer
(String application, String node, ServerInstanceDescriptor desc) Instantiate a server template from an application on the given node.default void
instantiateServer
(String application, String node, ServerInstanceDescriptor desc, Map<String, String> context) Instantiate a server template from an application on the given node.default CompletableFuture<Void>
instantiateServerAsync
(String application, String node, ServerInstanceDescriptor desc) Instantiate a server template from an application on the given node.default CompletableFuture<Void>
instantiateServerAsync
(String application, String node, ServerInstanceDescriptor desc, Map<String, String> context) Instantiate a server template from an application on the given node.default boolean
Check if the server is enabled or disabled.default boolean
isServerEnabled
(String id, Map<String, String> context) Check if the server is enabled or disabled.default CompletableFuture<Boolean>
Check if the server is enabled or disabled.default CompletableFuture<Boolean>
isServerEnabledAsync
(String id, Map<String, String> context) Check if the server is enabled or disabled.default void
patchApplication
(String name, boolean shutdown) Patch the given application data.default void
patchApplication
(String name, boolean shutdown, Map<String, String> context) Patch the given application data.default CompletableFuture<Void>
patchApplicationAsync
(String name, boolean shutdown) Patch the given application data.default CompletableFuture<Void>
patchApplicationAsync
(String name, boolean shutdown, Map<String, String> context) Patch the given application data.default void
patchServer
(String id, boolean shutdown) Patch a server.default void
patchServer
(String id, boolean shutdown, Map<String, String> context) Patch a server.default CompletableFuture<Void>
patchServerAsync
(String id, boolean shutdown) Patch a server.default CompletableFuture<Void>
patchServerAsync
(String id, boolean shutdown, Map<String, String> context) Patch a server.default boolean
Ping an IceGrid node to see if it is active.default boolean
Ping an IceGrid node to see if it is active.default CompletableFuture<Boolean>
pingNodeAsync
(String name) Ping an IceGrid node to see if it is active.default CompletableFuture<Boolean>
pingNodeAsync
(String name, Map<String, String> context) Ping an IceGrid node to see if it is active.default boolean
pingRegistry
(String name) Ping an IceGrid registry to see if it is active.default boolean
pingRegistry
(String name, Map<String, String> context) Ping an IceGrid registry to see if it is active.default CompletableFuture<Boolean>
pingRegistryAsync
(String name) Ping an IceGrid registry to see if it is active.default CompletableFuture<Boolean>
pingRegistryAsync
(String name, Map<String, String> context) Ping an IceGrid registry to see if it is active.default void
removeAdapter
(String id) Remove the adapter with the given id.default void
removeAdapter
(String id, Map<String, String> context) Remove the adapter with the given id.default CompletableFuture<Void>
Remove the adapter with the given id.default CompletableFuture<Void>
removeAdapterAsync
(String id, Map<String, String> context) Remove the adapter with the given id.default void
removeApplication
(String name) Remove an application from IceGrid.default void
removeApplication
(String name, Map<String, String> context) Remove an application from IceGrid.default CompletableFuture<Void>
removeApplicationAsync
(String name) Remove an application from IceGrid.default CompletableFuture<Void>
removeApplicationAsync
(String name, Map<String, String> context) Remove an application from IceGrid.default void
removeObject
(Identity id) Remove an object from the object registry.default void
removeObject
(Identity id, Map<String, String> context) Remove an object from the object registry.default CompletableFuture<Void>
Remove an object from the object registry.default CompletableFuture<Void>
removeObjectAsync
(Identity id, Map<String, String> context) Remove an object from the object registry.default void
sendSignal
(String id, String signal) Send signal to a server.default void
Send signal to a server.default CompletableFuture<Void>
sendSignalAsync
(String id, String signal) Send signal to a server.default CompletableFuture<Void>
Send signal to a server.default void
shutdown()
Shut down the IceGrid registry.default void
Shut down the IceGrid registry.default CompletableFuture<Void>
Shut down the IceGrid registry.default CompletableFuture<Void>
shutdownAsync
(Map<String, String> context) Shut down the IceGrid registry.default void
shutdownNode
(String name) Shutdown an IceGrid node.default void
shutdownNode
(String name, Map<String, String> context) Shutdown an IceGrid node.default CompletableFuture<Void>
shutdownNodeAsync
(String name) Shutdown an IceGrid node.default CompletableFuture<Void>
shutdownNodeAsync
(String name, Map<String, String> context) Shutdown an IceGrid node.default void
shutdownRegistry
(String name) Shutdown an IceGrid registry.default void
shutdownRegistry
(String name, Map<String, String> context) Shutdown an IceGrid registry.default CompletableFuture<Void>
shutdownRegistryAsync
(String name) Shutdown an IceGrid registry.default CompletableFuture<Void>
shutdownRegistryAsync
(String name, Map<String, String> context) Shutdown an IceGrid registry.default void
startServer
(String id) Start a server and wait for its activation.default void
startServer
(String id, Map<String, String> context) Start a server and wait for its activation.default CompletableFuture<Void>
Start a server and wait for its activation.default CompletableFuture<Void>
startServerAsync
(String id, Map<String, String> context) Start a server and wait for its activation.default void
stopServer
(String id) Stop a server.default void
stopServer
(String id, Map<String, String> context) Stop a server.default CompletableFuture<Void>
Stop a server.default CompletableFuture<Void>
stopServerAsync
(String id, Map<String, String> context) Stop a server.default void
syncApplication
(ApplicationDescriptor descriptor) Synchronize a deployed application with the given application descriptor.default void
syncApplication
(ApplicationDescriptor descriptor, Map<String, String> context) Synchronize a deployed application with the given application descriptor.default CompletableFuture<Void>
syncApplicationAsync
(ApplicationDescriptor descriptor) Synchronize a deployed application with the given application descriptor.default CompletableFuture<Void>
syncApplicationAsync
(ApplicationDescriptor descriptor, Map<String, String> context) Synchronize a deployed application with the given application descriptor.default void
syncApplicationWithoutRestart
(ApplicationDescriptor descriptor) Synchronize a deployed application with the given application descriptor.default void
syncApplicationWithoutRestart
(ApplicationDescriptor descriptor, Map<String, String> context) Synchronize a deployed application with the given application descriptor.default CompletableFuture<Void>
Synchronize a deployed application with the given application descriptor.default CompletableFuture<Void>
syncApplicationWithoutRestartAsync
(ApplicationDescriptor descriptor, Map<String, String> context) Synchronize a deployed application with the given application descriptor.static AdminPrx
uncheckedCast
(ObjectPrx obj) Downcasts the given proxy to this type without contacting the remote server.static AdminPrx
uncheckedCast
(ObjectPrx obj, String facet) Downcasts the given proxy to this type without contacting the remote server.default void
updateApplication
(ApplicationUpdateDescriptor descriptor) Update a deployed application with the given update application descriptor.default void
updateApplication
(ApplicationUpdateDescriptor descriptor, Map<String, String> context) Update a deployed application with the given update application descriptor.default CompletableFuture<Void>
updateApplicationAsync
(ApplicationUpdateDescriptor descriptor) Update a deployed application with the given update application descriptor.default CompletableFuture<Void>
updateApplicationAsync
(ApplicationUpdateDescriptor descriptor, Map<String, String> context) Update a deployed application with the given update application descriptor.default void
Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application.default void
updateApplicationWithoutRestart
(ApplicationUpdateDescriptor descriptor, Map<String, String> context) Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application.default CompletableFuture<Void>
Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application.default CompletableFuture<Void>
updateApplicationWithoutRestartAsync
(ApplicationUpdateDescriptor descriptor, Map<String, String> context) Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application.default void
updateObject
(ObjectPrx obj) Update an object in the object registry.default void
updateObject
(ObjectPrx obj, Map<String, String> context) Update an object in the object registry.default CompletableFuture<Void>
Update an object in the object registry.default CompletableFuture<Void>
updateObjectAsync
(ObjectPrx obj, Map<String, String> context) Update an object in the object registry.Methods inherited from interface com.zeroc.Ice.ObjectPrx
equals, ice_executor, ice_facet, ice_flushBatchRequests, ice_flushBatchRequestsAsync, ice_getAdapterId, ice_getCachedConnection, ice_getCommunicator, ice_getCompress, ice_getConnection, ice_getConnectionAsync, ice_getConnectionId, ice_getContext, ice_getEncodingVersion, ice_getEndpoints, ice_getEndpointSelection, ice_getFacet, ice_getIdentity, ice_getInvocationTimeout, ice_getLocator, ice_getLocatorCacheTimeout, ice_getRouter, ice_getTimeout, ice_id, ice_id, ice_idAsync, ice_idAsync, ice_identity, ice_ids, ice_ids, ice_idsAsync, ice_idsAsync, ice_invoke, ice_invoke, ice_invokeAsync, ice_invokeAsync, ice_isA, ice_isA, ice_isAAsync, ice_isAAsync, ice_isBatchDatagram, ice_isBatchOneway, ice_isCollocationOptimized, ice_isConnectionCached, ice_isDatagram, ice_isFixed, ice_isOneway, ice_isPreferSecure, ice_isSecure, ice_isTwoway, ice_ping, ice_ping, ice_pingAsync, ice_pingAsync
-
Method Details
-
addApplication
default void addApplication(ApplicationDescriptor descriptor) throws AccessDeniedException, DeploymentException Add an application to IceGrid.- Parameters:
descriptor
- The application descriptor.- Throws:
AccessDeniedException
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.DeploymentException
- Raised if application deployment failed.
-
addApplication
default void addApplication(ApplicationDescriptor descriptor, Map<String, String> context) throws AccessDeniedException, DeploymentExceptionAdd an application to IceGrid.- Parameters:
descriptor
- The application descriptor.context
- The Context map to send with the invocation.- Throws:
AccessDeniedException
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.DeploymentException
- Raised if application deployment failed.
-
addApplicationAsync
Add 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) Add 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, ApplicationNotExistException, DeploymentException Synchronize a deployed application with the given application descriptor. This operation will replace the current descriptor with this new descriptor.- Parameters:
descriptor
- The application descriptor.- Throws:
AccessDeniedException
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.ApplicationNotExistException
- Raised if the application doesn't exist.DeploymentException
- Raised if application deployment failed.
-
syncApplication
default void syncApplication(ApplicationDescriptor descriptor, Map<String, String> context) throws AccessDeniedException, ApplicationNotExistException, DeploymentExceptionSynchronize a deployed application with the given application descriptor. This operation will replace the current descriptor with this new descriptor.- Parameters:
descriptor
- The application descriptor.context
- The Context map to send with the invocation.- Throws:
AccessDeniedException
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.ApplicationNotExistException
- Raised if the application doesn't exist.DeploymentException
- Raised if application deployment failed.
-
syncApplicationAsync
Synchronize a deployed application with the given application descriptor. This operation will replace the current descriptor with this new descriptor.- Parameters:
descriptor
- The application descriptor.- Returns:
- A future that will be completed when the invocation completes.
-
syncApplicationAsync
default CompletableFuture<Void> syncApplicationAsync(ApplicationDescriptor descriptor, Map<String, String> context) Synchronize a deployed application with the given application descriptor. This operation will replace the current descriptor with this new descriptor.- 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.
-
updateApplication
default void updateApplication(ApplicationUpdateDescriptor descriptor) throws AccessDeniedException, ApplicationNotExistException, DeploymentException Update a deployed application with the given update application descriptor.- Parameters:
descriptor
- The update descriptor.- Throws:
AccessDeniedException
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.ApplicationNotExistException
- Raised if the application doesn't exist.DeploymentException
- Raised if application deployment failed.
-
updateApplication
default void updateApplication(ApplicationUpdateDescriptor descriptor, Map<String, String> context) throws AccessDeniedException, ApplicationNotExistException, DeploymentExceptionUpdate a deployed application with the given update application descriptor.- Parameters:
descriptor
- The update descriptor.context
- The Context map to send with the invocation.- Throws:
AccessDeniedException
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.ApplicationNotExistException
- Raised if the application doesn't exist.DeploymentException
- Raised if application deployment failed.
-
updateApplicationAsync
Update a deployed application with the given update application descriptor.- 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) Update a deployed application with the given update application descriptor.- 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, ApplicationNotExistException, DeploymentException Synchronize a deployed application with the given application descriptor. This operation will replace the current descriptor with this 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
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.ApplicationNotExistException
- Raised if the application doesn't exist.DeploymentException
- Raised if application deployment failed.
-
syncApplicationWithoutRestart
default void syncApplicationWithoutRestart(ApplicationDescriptor descriptor, Map<String, String> context) throws AccessDeniedException, ApplicationNotExistException, DeploymentExceptionSynchronize a deployed application with the given application descriptor. This operation will replace the current descriptor with this 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
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.ApplicationNotExistException
- Raised if the application doesn't exist.DeploymentException
- Raised if application deployment failed.
-
syncApplicationWithoutRestartAsync
default CompletableFuture<Void> syncApplicationWithoutRestartAsync(ApplicationDescriptor descriptor) Synchronize a deployed application with the given application descriptor. This operation will replace the current descriptor with this 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) Synchronize a deployed application with the given application descriptor. This operation will replace the current descriptor with this 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, ApplicationNotExistException, DeploymentException Update a deployed application with the given update application 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 update descriptor.- Throws:
AccessDeniedException
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.ApplicationNotExistException
- Raised if the application doesn't exist.DeploymentException
- Raised if application deployment failed.
-
updateApplicationWithoutRestart
default void updateApplicationWithoutRestart(ApplicationUpdateDescriptor descriptor, Map<String, String> context) throws AccessDeniedException, ApplicationNotExistException, DeploymentExceptionUpdate a deployed application with the given update application 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 update descriptor.context
- The Context map to send with the invocation.- Throws:
AccessDeniedException
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.ApplicationNotExistException
- Raised if the application doesn't exist.DeploymentException
- Raised if application deployment failed.
-
updateApplicationWithoutRestartAsync
default CompletableFuture<Void> updateApplicationWithoutRestartAsync(ApplicationUpdateDescriptor descriptor) Update a deployed application with the given update application 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 update descriptor.- Returns:
- A future that will be completed when the invocation completes.
-
updateApplicationWithoutRestartAsync
default CompletableFuture<Void> updateApplicationWithoutRestartAsync(ApplicationUpdateDescriptor descriptor, Map<String, String> context) Update a deployed application with the given update application 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 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, ApplicationNotExistException, DeploymentException Remove an application from IceGrid.- Parameters:
name
- The application name.- Throws:
AccessDeniedException
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.ApplicationNotExistException
- Raised if the application doesn't exist.DeploymentException
- Raised if application deployment failed.
-
removeApplication
default void removeApplication(String name, Map<String, String> context) throws AccessDeniedException, ApplicationNotExistException, DeploymentExceptionRemove an application from IceGrid.- Parameters:
name
- The application name.context
- The Context map to send with the invocation.- Throws:
AccessDeniedException
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.ApplicationNotExistException
- Raised if the application doesn't exist.DeploymentException
- Raised if application deployment failed.
-
removeApplicationAsync
Remove an application from IceGrid.- Parameters:
name
- The application name.- Returns:
- A future that will be completed when the invocation completes.
-
removeApplicationAsync
Remove 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 Instantiate a server template from an application on the given node.- 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
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.ApplicationNotExistException
- Raised if the application doesn't exist.DeploymentException
- Raised if server instantiation failed.
-
instantiateServer
default void instantiateServer(String application, String node, ServerInstanceDescriptor desc, Map<String, String> context) throws AccessDeniedException, ApplicationNotExistException, DeploymentExceptionInstantiate a server template from an application on the given node.- 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
- Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.ApplicationNotExistException
- Raised if the application doesn't exist.DeploymentException
- Raised if server instantiation failed.
-
instantiateServerAsync
default CompletableFuture<Void> instantiateServerAsync(String application, String node, ServerInstanceDescriptor desc) Instantiate a server template from an application on the given node.- 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) Instantiate a server template from an application on the given node.- 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.
-
patchApplication
default void patchApplication(String name, boolean shutdown) throws ApplicationNotExistException, PatchException Patch the given application data.- Parameters:
name
- The application name.shutdown
- If true, the servers depending on the data to patch will be shut down if necessary.- Throws:
ApplicationNotExistException
- Raised if the application doesn't exist.PatchException
- Raised if the patch failed.
-
patchApplication
default void patchApplication(String name, boolean shutdown, Map<String, String> context) throws ApplicationNotExistException, PatchExceptionPatch the given application data.- Parameters:
name
- The application name.shutdown
- If true, the servers depending on the data to patch will be shut down if necessary.context
- The Context map to send with the invocation.- Throws:
ApplicationNotExistException
- Raised if the application doesn't exist.PatchException
- Raised if the patch failed.
-
patchApplicationAsync
Patch the given application data.- Parameters:
name
- The application name.shutdown
- If true, the servers depending on the data to patch will be shut down if necessary.- Returns:
- A future that will be completed when the invocation completes.
-
patchApplicationAsync
default CompletableFuture<Void> patchApplicationAsync(String name, boolean shutdown, Map<String, String> context) Patch the given application data.- Parameters:
name
- The application name.shutdown
- If true, the servers depending on the data to patch will be shut down if necessary.context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
-
getApplicationInfo
Get an application descriptor.- Parameters:
name
- The application name.- Returns:
- The application descriptor.
- Throws:
ApplicationNotExistException
- Raised if the application doesn't exist.
-
getApplicationInfo
default ApplicationInfo getApplicationInfo(String name, Map<String, String> context) throws ApplicationNotExistExceptionGet an application descriptor.- Parameters:
name
- The application name.context
- The Context map to send with the invocation.- Returns:
- The application descriptor.
- Throws:
ApplicationNotExistException
- Raised if the application doesn't exist.
-
getApplicationInfoAsync
Get an application descriptor.- Parameters:
name
- The application name.- Returns:
- The application descriptor.
-
getApplicationInfoAsync
default CompletableFuture<ApplicationInfo> getApplicationInfoAsync(String name, Map<String, String> context) Get an application descriptor.- Parameters:
name
- The application name.context
- The Context map to send with the invocation.- Returns:
- The application descriptor.
-
getDefaultApplicationDescriptor
Get the default application descriptor.- Returns:
- The default application descriptor.
- Throws:
DeploymentException
- Raised if the default application descriptor can't be accessed or is invalid.
-
getDefaultApplicationDescriptor
default ApplicationDescriptor getDefaultApplicationDescriptor(Map<String, String> context) throws DeploymentExceptionGet the default application descriptor.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The default application descriptor.
- Throws:
DeploymentException
- Raised if the default application descriptor can't be accessed or is invalid.
-
getDefaultApplicationDescriptorAsync
Get the default application descriptor.- Returns:
- The default application descriptor.
-
getDefaultApplicationDescriptorAsync
default CompletableFuture<ApplicationDescriptor> getDefaultApplicationDescriptorAsync(Map<String, String> context) Get the default application descriptor.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The default application descriptor.
-
getAllApplicationNames
Get all the IceGrid applications currently registered.- Returns:
- The application names.
-
getAllApplicationNames
Get all the IceGrid applications currently registered.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The application names.
-
getAllApplicationNamesAsync
Get all the IceGrid applications currently registered.- Returns:
- The application names.
-
getAllApplicationNamesAsync
Get all the IceGrid applications currently registered.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The application names.
-
getServerInfo
Get the server information for the server with the given id.- Parameters:
id
- The server id.- Returns:
- The server information.
- Throws:
ServerNotExistException
- Raised if the server doesn't exist.
-
getServerInfo
default ServerInfo getServerInfo(String id, Map<String, String> context) throws ServerNotExistExceptionGet the server information for the server with the given id.- Parameters:
id
- The server id.context
- The Context map to send with the invocation.- Returns:
- The server information.
- Throws:
ServerNotExistException
- Raised if the server doesn't exist.
-
getServerInfoAsync
Get the server information for the server with the given id.- Parameters:
id
- The server id.- Returns:
- The server information.
-
getServerInfoAsync
Get the server information for the server with the given id.- 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 DeploymentException, NodeUnreachableException, ServerNotExistException Get a server's state.- Parameters:
id
- The server id.- Returns:
- The server state.
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
getServerState
default ServerState getServerState(String id, Map<String, String> context) throws DeploymentException, NodeUnreachableException, ServerNotExistExceptionGet a server's state.- Parameters:
id
- The server id.context
- The Context map to send with the invocation.- Returns:
- The server state.
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
getServerStateAsync
Get a server's state.- Parameters:
id
- The server id.- Returns:
- The server state.
-
getServerStateAsync
Get a server's state.- 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 DeploymentException, NodeUnreachableException, ServerNotExistException Get a server's system process id. The process id is operating system dependent.- Parameters:
id
- The server id.- Returns:
- The server's process id.
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
getServerPid
default int getServerPid(String id, Map<String, String> context) throws DeploymentException, NodeUnreachableException, ServerNotExistExceptionGet a server's system process id. The process id is operating system dependent.- Parameters:
id
- The server id.context
- The Context map to send with the invocation.- Returns:
- The server's process id.
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
getServerPidAsync
Get a server's system process id. The process id is operating system dependent.- Parameters:
id
- The server id.- Returns:
- The server's process id.
-
getServerPidAsync
Get a server's system process id. The process id is operating system dependent.- Parameters:
id
- The server id.context
- The Context map to send with the invocation.- Returns:
- The server's process id.
-
getServerAdminCategory
Get 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
Get 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
Get 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
Get 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 DeploymentException, NodeUnreachableException, ServerNotExistException Get a proxy to the server's admin object.- Parameters:
id
- The server id.- Returns:
- A proxy to the server's admin object
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
getServerAdmin
default ObjectPrx getServerAdmin(String id, Map<String, String> context) throws DeploymentException, NodeUnreachableException, ServerNotExistExceptionGet a proxy to the server's admin object.- Parameters:
id
- The server id.context
- The Context map to send with the invocation.- Returns:
- A proxy to the server's admin object
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
getServerAdminAsync
Get a proxy to the server's admin object.- Parameters:
id
- The server id.- Returns:
- A proxy to the server's admin object
-
getServerAdminAsync
Get a proxy to the server's admin object.- Parameters:
id
- The server id.context
- The Context map to send with the invocation.- Returns:
- A proxy to the server's admin object
-
enableServer
default void enableServer(String id, boolean enabled) throws DeploymentException, NodeUnreachableException, ServerNotExistException Enable or disable 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
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
enableServer
default void enableServer(String id, boolean enabled, Map<String, String> context) throws DeploymentException, NodeUnreachableException, ServerNotExistExceptionEnable or disable 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
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
enableServerAsync
Enable or disable 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) Enable or disable 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 DeploymentException, NodeUnreachableException, ServerNotExistException Check if the server is enabled or disabled.- Parameters:
id
- The server id.- Returns:
- True if the server is enabled.
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
isServerEnabled
default boolean isServerEnabled(String id, Map<String, String> context) throws DeploymentException, NodeUnreachableException, ServerNotExistExceptionCheck 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.
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
isServerEnabledAsync
Check if the server is enabled or disabled.- Parameters:
id
- The server id.- Returns:
- True if the server is enabled.
-
isServerEnabledAsync
Check 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.
-
startServer
default void startServer(String id) throws DeploymentException, NodeUnreachableException, ServerNotExistException, ServerStartException Start a server and wait for its activation.- Parameters:
id
- The server id.- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.ServerStartException
- Raised if the server couldn't be started.
-
startServer
default void startServer(String id, Map<String, String> context) throws DeploymentException, NodeUnreachableException, ServerNotExistException, ServerStartExceptionStart a server and wait for its activation.- Parameters:
id
- The server id.context
- The Context map to send with the invocation.- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.ServerStartException
- Raised if the server couldn't be started.
-
startServerAsync
Start a server and wait for its activation.- Parameters:
id
- The server id.- Returns:
- A future that will be completed when the invocation completes.
-
startServerAsync
Start a server and wait 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 DeploymentException, NodeUnreachableException, ServerNotExistException, ServerStopException Stop a server.- Parameters:
id
- The server id.- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.ServerStopException
- Raised if the server couldn't be stopped.
-
stopServer
default void stopServer(String id, Map<String, String> context) throws DeploymentException, NodeUnreachableException, ServerNotExistException, ServerStopExceptionStop a server.- Parameters:
id
- The server id.context
- The Context map to send with the invocation.- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.ServerStopException
- Raised if the server couldn't be stopped.
-
stopServerAsync
Stop a server.- Parameters:
id
- The server id.- Returns:
- A future that will be completed when the invocation completes.
-
stopServerAsync
Stop 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.
-
patchServer
default void patchServer(String id, boolean shutdown) throws DeploymentException, NodeUnreachableException, PatchException, ServerNotExistException Patch a server.- Parameters:
id
- The server id.shutdown
- If true, servers depending on the data to patch will be shut down if necessary.- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.PatchException
- Raised if the patch failed.ServerNotExistException
- Raised if the server doesn't exist.
-
patchServer
default void patchServer(String id, boolean shutdown, Map<String, String> context) throws DeploymentException, NodeUnreachableException, PatchException, ServerNotExistExceptionPatch a server.- Parameters:
id
- The server id.shutdown
- If true, servers depending on the data to patch will be shut down if necessary.context
- The Context map to send with the invocation.- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.PatchException
- Raised if the patch failed.ServerNotExistException
- Raised if the server doesn't exist.
-
patchServerAsync
Patch a server.- Parameters:
id
- The server id.shutdown
- If true, servers depending on the data to patch will be shut down if necessary.- Returns:
- A future that will be completed when the invocation completes.
-
patchServerAsync
default CompletableFuture<Void> patchServerAsync(String id, boolean shutdown, Map<String, String> context) Patch a server.- Parameters:
id
- The server id.shutdown
- If true, servers depending on the data to patch will be shut down if necessary.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 BadSignalException, DeploymentException, NodeUnreachableException, ServerNotExistException Send signal to a server.- Parameters:
id
- The server id.signal
- The signal, for example SIGTERM or 15.- Throws:
BadSignalException
- Raised if the signal is not recognized by the target server.DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
sendSignal
default void sendSignal(String id, String signal, Map<String, String> context) throws BadSignalException, DeploymentException, NodeUnreachableException, ServerNotExistExceptionSend 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
- Raised if the signal is not recognized by the target server.DeploymentException
- Raised if the server couldn't be deployed on the node.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
sendSignalAsync
Send 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) Send 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
Get all the server ids registered with IceGrid.- Returns:
- The server ids.
-
getAllServerIds
Get all the server ids registered with IceGrid.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The server ids.
-
getAllServerIdsAsync
Get all the server ids registered with IceGrid.- Returns:
- The server ids.
-
getAllServerIdsAsync
Get all the server ids registered with IceGrid.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The server ids.
-
getAdapterInfo
Get the adapter information for the replica group or adapter with the given id.- Parameters:
id
- The adapter id.- Returns:
- A sequence of adapter information structures. If the given id refers to an adapter, this sequence will contain only one element. If the given id refers to a replica group, the sequence will contain the adapter information of each member of the replica group.
- Throws:
AdapterNotExistException
- Raised if the adapter or replica group doesn't exist.
-
getAdapterInfo
default AdapterInfo[] getAdapterInfo(String id, Map<String, String> context) throws AdapterNotExistExceptionGet the adapter information for the replica group or adapter with the given id.- Parameters:
id
- The adapter id.context
- The Context map to send with the invocation.- Returns:
- A sequence of adapter information structures. If the given id refers to an adapter, this sequence will contain only one element. If the given id refers to a replica group, the sequence will contain the adapter information of each member of the replica group.
- Throws:
AdapterNotExistException
- Raised if the adapter or replica group doesn't exist.
-
getAdapterInfoAsync
Get the adapter information for the replica group or adapter with the given id.- Parameters:
id
- The adapter id.- Returns:
- A sequence of adapter information structures. If the given id refers to an adapter, this sequence will contain only one element. If the given id refers to a replica group, the sequence will contain the adapter information of each member of the replica group.
-
getAdapterInfoAsync
Get the adapter information for the replica group or adapter with the given id.- Parameters:
id
- The adapter id.context
- The Context map to send with the invocation.- Returns:
- A sequence of adapter information structures. If the given id refers to an adapter, this sequence will contain only one element. If the given id refers to a replica group, the sequence will contain the adapter information of each member of the replica group.
-
removeAdapter
Remove the adapter with the given id.- Parameters:
id
- The adapter id.- Throws:
AdapterNotExistException
- Raised if the adapter doesn't exist.DeploymentException
- Raised if application deployment failed.
-
removeAdapter
default void removeAdapter(String id, Map<String, String> context) throws AdapterNotExistException, DeploymentExceptionRemove the adapter with the given id.- Parameters:
id
- The adapter id.context
- The Context map to send with the invocation.- Throws:
AdapterNotExistException
- Raised if the adapter doesn't exist.DeploymentException
- Raised if application deployment failed.
-
removeAdapterAsync
Remove the adapter with the given id.- Parameters:
id
- The adapter id.- Returns:
- A future that will be completed when the invocation completes.
-
removeAdapterAsync
Remove 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
Get all the adapter ids registered with IceGrid.- Returns:
- The adapter ids.
-
getAllAdapterIds
Get all the adapter ids registered with IceGrid.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The adapter ids.
-
getAllAdapterIdsAsync
Get all the adapter ids registered with IceGrid.- Returns:
- The adapter ids.
-
getAllAdapterIdsAsync
Get all the adapter ids registered with IceGrid.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The adapter ids.
-
addObject
Add an object to the object registry. IceGrid will get the object type by callingice_id
on the given proxy. The object must be reachable.- Parameters:
obj
- The object to be added to the registry.- Throws:
DeploymentException
- Raised if the object can't be added. This might be raised if the invocation on the proxy to get the object type failed.ObjectExistsException
- Raised if the object is already registered.
-
addObject
default void addObject(ObjectPrx obj, Map<String, String> context) throws DeploymentException, ObjectExistsExceptionAdd an object to the object registry. IceGrid will get the object type by callingice_id
on the given proxy. The object must be reachable.- Parameters:
obj
- The object to be added to the registry.context
- The Context map to send with the invocation.- Throws:
DeploymentException
- Raised if the object can't be added. This might be raised if the invocation on the proxy to get the object type failed.ObjectExistsException
- Raised if the object is already registered.
-
addObjectAsync
Add an object to the object registry. IceGrid will get the object type by callingice_id
on the given proxy. The object must be reachable.- Parameters:
obj
- The object to be added to the registry.- Returns:
- A future that will be completed when the invocation completes.
-
addObjectAsync
Add an object to the object registry. IceGrid will get the object type by callingice_id
on the given proxy. The object must be reachable.- Parameters:
obj
- The object to be added to the registry.context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
-
updateObject
Update 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
- The object to be updated to the registry.- Throws:
DeploymentException
- Raised if the object can't be updated. This might happen if the object was added with a deployment descriptor.ObjectNotRegisteredException
- Raised if the object isn't registered with the registry.
-
updateObject
default void updateObject(ObjectPrx obj, Map<String, String> context) throws DeploymentException, ObjectNotRegisteredExceptionUpdate 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
- The object to be updated to the registry.context
- The Context map to send with the invocation.- Throws:
DeploymentException
- Raised if the object can't be updated. This might happen if the object was added with a deployment descriptor.ObjectNotRegisteredException
- Raised if the object isn't registered with the registry.
-
updateObjectAsync
Update 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
- The object to be updated to the registry.- Returns:
- A future that will be completed when the invocation completes.
-
updateObjectAsync
Update 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
- The object to be updated to the registry.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 DeploymentException, ObjectExistsException Add an object to the object registry and explicitly specify its type.- Parameters:
obj
- The object to be added to the registry.type
- The object type.- Throws:
DeploymentException
- Raised if application deployment failed.ObjectExistsException
- Raised if the object is already registered.
-
addObjectWithType
default void addObjectWithType(ObjectPrx obj, String type, Map<String, String> context) throws DeploymentException, ObjectExistsExceptionAdd an object to the object registry and explicitly specify its type.- Parameters:
obj
- The object to be added to the registry.type
- The object type.context
- The Context map to send with the invocation.- Throws:
DeploymentException
- Raised if application deployment failed.ObjectExistsException
- Raised if the object is already registered.
-
addObjectWithTypeAsync
Add an object to the object registry and explicitly specify its type.- Parameters:
obj
- The object to be added to the registry.type
- The object type.- Returns:
- A future that will be completed when the invocation completes.
-
addObjectWithTypeAsync
default CompletableFuture<Void> addObjectWithTypeAsync(ObjectPrx obj, String type, Map<String, String> context) Add an object to the object registry and explicitly specify its type.- Parameters:
obj
- The object to be added to the registry.type
- The object type.context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
-
removeObject
Remove 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 be removed from the registry.- Throws:
DeploymentException
- Raised if the object can't be removed. This might happen if the object was added with a deployment descriptor.ObjectNotRegisteredException
- Raised if the object isn't registered with the registry.
-
removeObject
default void removeObject(Identity id, Map<String, String> context) throws DeploymentException, ObjectNotRegisteredExceptionRemove 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 be removed from the registry.context
- The Context map to send with the invocation.- Throws:
DeploymentException
- Raised if the object can't be removed. This might happen if the object was added with a deployment descriptor.ObjectNotRegisteredException
- Raised if the object isn't registered with the registry.
-
removeObjectAsync
Remove 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 be removed from the registry.- Returns:
- A future that will be completed when the invocation completes.
-
removeObjectAsync
Remove 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 be removed from the registry.context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
-
getObjectInfo
Get the object info for the object with the given identity.- Parameters:
id
- The identity of the object.- Returns:
- The object info.
- Throws:
ObjectNotRegisteredException
- Raised if the object isn't registered with the registry.
-
getObjectInfo
default ObjectInfo getObjectInfo(Identity id, Map<String, String> context) throws ObjectNotRegisteredExceptionGet the object info for the object with the given identity.- Parameters:
id
- The identity of the object.context
- The Context map to send with the invocation.- Returns:
- The object info.
- Throws:
ObjectNotRegisteredException
- Raised if the object isn't registered with the registry.
-
getObjectInfoAsync
Get the object info for the object with the given identity.- Parameters:
id
- The identity of the object.- Returns:
- The object info.
-
getObjectInfoAsync
Get the object info for the object with the given identity.- Parameters:
id
- The identity of the object.context
- The Context map to send with the invocation.- Returns:
- The object info.
-
getObjectInfosByType
Get the object info of all the registered objects with the given type.- Parameters:
type
- The type of the object.- Returns:
- The object infos.
-
getObjectInfosByType
Get the object info of all the registered objects with the given type.- Parameters:
type
- The type of the object.context
- The Context map to send with the invocation.- Returns:
- The object infos.
-
getObjectInfosByTypeAsync
Get the object info of all the registered objects with the given type.- Parameters:
type
- The type of the object.- Returns:
- The object infos.
-
getObjectInfosByTypeAsync
default CompletableFuture<ObjectInfo[]> getObjectInfosByTypeAsync(String type, Map<String, String> context) Get the object info of all the registered objects with the given type.- Parameters:
type
- The type of the object.context
- The Context map to send with the invocation.- Returns:
- The object infos.
-
getAllObjectInfos
Get 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
Get 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
Get 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) Get 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
Ping 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
- Raised if the node doesn't exist.
-
pingNode
Ping 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
- Raised if the node doesn't exist.
-
pingNodeAsync
Ping an IceGrid node to see if it is active.- Parameters:
name
- The node name.- Returns:
- true if the node ping succeeded, false otherwise.
-
pingNodeAsync
Ping 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
Get the load averages of the node.- Parameters:
name
- The node name.- Returns:
- The node load information.
- Throws:
NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
getNodeLoad
default LoadInfo getNodeLoad(String name, Map<String, String> context) throws NodeNotExistException, NodeUnreachableExceptionGet the load averages of the node.- Parameters:
name
- The node name.context
- The Context map to send with the invocation.- Returns:
- The node load information.
- Throws:
NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
getNodeLoadAsync
Get the load averages of the node.- Parameters:
name
- The node name.- Returns:
- The node load information.
-
getNodeLoadAsync
Get the load averages of the node.- Parameters:
name
- The node name.context
- The Context map to send with the invocation.- Returns:
- The node load information.
-
getNodeInfo
Get the node information for the node with the given name.- Parameters:
name
- The node name.- Returns:
- The node information.
- Throws:
NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
getNodeInfo
default NodeInfo getNodeInfo(String name, Map<String, String> context) throws NodeNotExistException, NodeUnreachableExceptionGet the node information for the node with the given name.- Parameters:
name
- The node name.context
- The Context map to send with the invocation.- Returns:
- The node information.
- Throws:
NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
getNodeInfoAsync
Get the node information for the node with the given name.- Parameters:
name
- The node name.- Returns:
- The node information.
-
getNodeInfoAsync
Get the node information for the node with the given name.- Parameters:
name
- The node name.context
- The Context map to send with the invocation.- Returns:
- The node information.
-
getNodeAdmin
Get a proxy to the IceGrid node's admin object.- Parameters:
name
- The IceGrid node name- Returns:
- A proxy to the IceGrid node's admin object
- Throws:
NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
getNodeAdmin
default ObjectPrx getNodeAdmin(String name, Map<String, String> context) throws NodeNotExistException, NodeUnreachableExceptionGet a proxy to the IceGrid node's admin object.- Parameters:
name
- The IceGrid node namecontext
- The Context map to send with the invocation.- Returns:
- A proxy to the IceGrid node's admin object
- Throws:
NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
getNodeAdminAsync
Get a proxy to the IceGrid node's admin object.- Parameters:
name
- The IceGrid node name- Returns:
- A proxy to the IceGrid node's admin object
-
getNodeAdminAsync
Get a proxy to the IceGrid node's admin object.- Parameters:
name
- The IceGrid node namecontext
- The Context map to send with the invocation.- Returns:
- A proxy to the IceGrid node's admin object
-
getNodeProcessorSocketCount
default int getNodeProcessorSocketCount(String name) throws NodeNotExistException, NodeUnreachableException Get the number of physical processor sockets for the machine running the node with the given name. Note that this method will return 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 determined.
- Throws:
NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
getNodeProcessorSocketCount
default int getNodeProcessorSocketCount(String name, Map<String, String> context) throws NodeNotExistException, NodeUnreachableExceptionGet the number of physical processor sockets for the machine running the node with the given name. Note that this method will return 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 determined.
- Throws:
NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
getNodeProcessorSocketCountAsync
Get the number of physical processor sockets for the machine running the node with the given name. Note that this method will return 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 determined.
-
getNodeProcessorSocketCountAsync
default CompletableFuture<Integer> getNodeProcessorSocketCountAsync(String name, Map<String, String> context) Get the number of physical processor sockets for the machine running the node with the given name. Note that this method will return 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 determined.
-
shutdownNode
Shutdown an IceGrid node.- Parameters:
name
- The node name.- Throws:
NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
shutdownNode
default void shutdownNode(String name, Map<String, String> context) throws NodeNotExistException, NodeUnreachableExceptionShutdown an IceGrid node.- Parameters:
name
- The node name.context
- The Context map to send with the invocation.- Throws:
NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
shutdownNodeAsync
Shutdown an IceGrid node.- Parameters:
name
- The node name.- Returns:
- A future that will be completed when the invocation completes.
-
shutdownNodeAsync
Shutdown 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
Get the hostname of this node.- Parameters:
name
- The node name.- Returns:
- The node hostname.
- Throws:
NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
getNodeHostname
default String getNodeHostname(String name, Map<String, String> context) throws NodeNotExistException, NodeUnreachableExceptionGet the hostname of this node.- Parameters:
name
- The node name.context
- The Context map to send with the invocation.- Returns:
- The node hostname.
- Throws:
NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
getNodeHostnameAsync
Get the hostname of this node.- Parameters:
name
- The node name.- Returns:
- The node hostname.
-
getNodeHostnameAsync
Get the hostname of this node.- Parameters:
name
- The node name.context
- The Context map to send with the invocation.- Returns:
- The node hostname.
-
getAllNodeNames
Get all the IceGrid nodes currently registered.- Returns:
- The node names.
-
getAllNodeNames
Get all the IceGrid nodes currently registered.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The node names.
-
getAllNodeNamesAsync
Get all the IceGrid nodes currently registered.- Returns:
- The node names.
-
getAllNodeNamesAsync
Get all the IceGrid nodes currently registered.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The node names.
-
pingRegistry
Ping 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
- Raised if the registry doesn't exist.
-
pingRegistry
default boolean pingRegistry(String name, Map<String, String> context) throws RegistryNotExistExceptionPing 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
- Raised if the registry doesn't exist.
-
pingRegistryAsync
Ping an IceGrid registry to see if it is active.- Parameters:
name
- The registry name.- Returns:
- true if the registry ping succeeded, false otherwise.
-
pingRegistryAsync
Ping 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 Get the registry information for the registry with the given name.- Parameters:
name
- The registry name.- Returns:
- The registry information.
- Throws:
RegistryNotExistException
- Raised if the registry doesn't exist.RegistryUnreachableException
- Raised if the registry could not be reached.
-
getRegistryInfo
default RegistryInfo getRegistryInfo(String name, Map<String, String> context) throws RegistryNotExistException, RegistryUnreachableExceptionGet the registry information for the registry with the given name.- Parameters:
name
- The registry name.context
- The Context map to send with the invocation.- Returns:
- The registry information.
- Throws:
RegistryNotExistException
- Raised if the registry doesn't exist.RegistryUnreachableException
- Raised if the registry could not be reached.
-
getRegistryInfoAsync
Get the registry information for the registry with the given name.- Parameters:
name
- The registry name.- Returns:
- The registry information.
-
getRegistryInfoAsync
default CompletableFuture<RegistryInfo> getRegistryInfoAsync(String name, Map<String, String> context) Get the registry information for the registry with the given name.- Parameters:
name
- The registry name.context
- The Context map to send with the invocation.- Returns:
- The registry information.
-
getRegistryAdmin
Get a proxy to the IceGrid registry's admin object.- Parameters:
name
- The registry name- Returns:
- A proxy to the IceGrid registry's admin object
- Throws:
RegistryNotExistException
- Raised if the registry doesn't exist.
-
getRegistryAdmin
default ObjectPrx getRegistryAdmin(String name, Map<String, String> context) throws RegistryNotExistExceptionGet a proxy to the IceGrid registry's admin object.- Parameters:
name
- The registry namecontext
- The Context map to send with the invocation.- Returns:
- A proxy to the IceGrid registry's admin object
- Throws:
RegistryNotExistException
- Raised if the registry doesn't exist.
-
getRegistryAdminAsync
Get a proxy to the IceGrid registry's admin object.- Parameters:
name
- The registry name- Returns:
- A proxy to the IceGrid registry's admin object
-
getRegistryAdminAsync
Get a proxy to the IceGrid registry's admin object.- Parameters:
name
- The registry namecontext
- The Context map to send with the invocation.- Returns:
- A proxy to the IceGrid registry's admin object
-
shutdownRegistry
default void shutdownRegistry(String name) throws RegistryNotExistException, RegistryUnreachableException Shutdown an IceGrid registry.- Parameters:
name
- The registry name.- Throws:
RegistryNotExistException
- Raised if the registry doesn't exist.RegistryUnreachableException
- Raised if the registry could not be reached.
-
shutdownRegistry
default void shutdownRegistry(String name, Map<String, String> context) throws RegistryNotExistException, RegistryUnreachableExceptionShutdown an IceGrid registry.- Parameters:
name
- The registry name.context
- The Context map to send with the invocation.- Throws:
RegistryNotExistException
- Raised if the registry doesn't exist.RegistryUnreachableException
- Raised if the registry could not be reached.
-
shutdownRegistryAsync
Shutdown an IceGrid registry.- Parameters:
name
- The registry name.- Returns:
- A future that will be completed when the invocation completes.
-
shutdownRegistryAsync
Shutdown 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
Get all the IceGrid registries currently registered.- Returns:
- The registry names.
-
getAllRegistryNames
Get all the IceGrid registries currently registered.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The registry names.
-
getAllRegistryNamesAsync
Get all the IceGrid registries currently registered.- Returns:
- The registry names.
-
getAllRegistryNamesAsync
Get all the IceGrid registries currently registered.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The registry names.
-
shutdown
default void shutdown()Shut down the IceGrid registry. -
shutdown
Shut down the IceGrid registry.- Parameters:
context
- The Context map to send with the invocation.
-
shutdownAsync
Shut down the IceGrid registry.- Returns:
- A future that will be completed when the invocation completes.
-
shutdownAsync
Shut 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.
-
getSliceChecksums
Returns the checksums for the IceGrid Slice definitions.- Returns:
- A dictionary mapping Slice type ids to their checksums.
-
getSliceChecksums
Returns the checksums for the IceGrid Slice definitions.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- A dictionary mapping Slice type ids to their checksums.
-
getSliceChecksumsAsync
Returns the checksums for the IceGrid Slice definitions.- Returns:
- A dictionary mapping Slice type ids to their checksums.
-
getSliceChecksumsAsync
Returns the checksums for the IceGrid Slice definitions.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- A dictionary mapping Slice type ids to their checksums.
-
checkedCast
Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.- Parameters:
obj
- The untyped proxy.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
checkedCast
Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.- Parameters:
obj
- The untyped proxy.context
- The Context map to send with the invocation.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
checkedCast
Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.- Parameters:
obj
- The untyped proxy.facet
- The name of the desired facet.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
checkedCast
Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.- Parameters:
obj
- The untyped proxy.facet
- The name of the desired facet.context
- The Context map to send with the invocation.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
uncheckedCast
Downcasts the given proxy to this type without contacting the remote server.- Parameters:
obj
- The untyped proxy.- Returns:
- A proxy for this type.
-
uncheckedCast
Downcasts the given proxy to this type without contacting the remote server.- Parameters:
obj
- The untyped proxy.facet
- The name of the desired facet.- Returns:
- A proxy for this type.
-
ice_context
Returns a proxy that is identical to this proxy, except for the per-proxy context.- Specified by:
ice_context
in interfaceObjectPrx
- Parameters:
newContext
- The context for the new proxy.- Returns:
- A proxy with the specified per-proxy context.
-
ice_adapterId
Returns a proxy that is identical to this proxy, except for the adapter ID.- Specified by:
ice_adapterId
in interfaceObjectPrx
- Parameters:
newAdapterId
- The adapter ID for the new proxy.- Returns:
- A proxy with the specified adapter ID.
-
ice_endpoints
Returns a proxy that is identical to this proxy, except for the endpoints.- Specified by:
ice_endpoints
in interfaceObjectPrx
- Parameters:
newEndpoints
- The endpoints for the new proxy.- Returns:
- A proxy with the specified endpoints.
-
ice_locatorCacheTimeout
Returns a proxy that is identical to this proxy, except for the locator cache timeout.- Specified by:
ice_locatorCacheTimeout
in interfaceObjectPrx
- Parameters:
newTimeout
- The new locator cache timeout (in seconds).- Returns:
- A proxy with the specified locator cache timeout.
- See Also:
-
ice_invocationTimeout
Returns a proxy that is identical to this proxy, except for the invocation timeout.- Specified by:
ice_invocationTimeout
in interfaceObjectPrx
- Parameters:
newTimeout
- The new invocation timeout (in seconds).- Returns:
- A proxy with the specified invocation timeout.
-
ice_connectionCached
Returns a proxy that is identical to this proxy, except for connection caching.- Specified by:
ice_connectionCached
in interfaceObjectPrx
- Parameters:
newCache
-true
if the new proxy should cache connections;false
otherwise.- Returns:
- A proxy with the specified caching policy.
-
ice_endpointSelection
Returns a proxy that is identical to this proxy, except for the endpoint selection policy.- Specified by:
ice_endpointSelection
in interfaceObjectPrx
- Parameters:
newType
- The new endpoint selection policy.- Returns:
- A proxy with the specified endpoint selection policy.
- See Also:
-
ice_secure
Returns a proxy that is identical to this proxy, except for how it selects endpoints.- Specified by:
ice_secure
in interfaceObjectPrx
- Parameters:
b
- Ifb
istrue
, only endpoints that use a secure transport are used by the new proxy. Ifb
is false, the returned proxy uses both secure and insecure endpoints.- Returns:
- A proxy with the specified selection policy.
-
ice_encodingVersion
Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.- Specified by:
ice_encodingVersion
in interfaceObjectPrx
- Parameters:
e
- The encoding version to use to marshal request parameters.- Returns:
- A proxy with the specified encoding version.
-
ice_preferSecure
Returns a proxy that is identical to this proxy, except for its endpoint selection policy.- Specified by:
ice_preferSecure
in interfaceObjectPrx
- Parameters:
b
- Ifb
istrue
, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. Ifb
isfalse
, the proxy prefers insecure endpoints to secure ones.- Returns:
- A proxy with the specified selection policy.
-
ice_router
Returns a proxy that is identical to this proxy, except for the router.- Specified by:
ice_router
in interfaceObjectPrx
- Parameters:
router
- The router for the new proxy.- Returns:
- A proxy with the specified router.
-
ice_locator
Returns a proxy that is identical to this proxy, except for the locator.- Specified by:
ice_locator
in interfaceObjectPrx
- Parameters:
locator
- The locator for the new proxy.- Returns:
- A proxy with the specified locator.
-
ice_collocationOptimized
Returns a proxy that is identical to this proxy, except for collocation optimization.- Specified by:
ice_collocationOptimized
in interfaceObjectPrx
- Parameters:
b
-true
if the new proxy enables collocation optimization;false
otherwise.- Returns:
- A proxy with the specified collocation optimization.
-
ice_twoway
Returns a proxy that is identical to this proxy, but uses twoway invocations.- Specified by:
ice_twoway
in interfaceObjectPrx
- Returns:
- A proxy that uses twoway invocations.
-
ice_oneway
Returns a proxy that is identical to this proxy, but uses oneway invocations.- Specified by:
ice_oneway
in interfaceObjectPrx
- Returns:
- A proxy that uses oneway invocations.
-
ice_batchOneway
Returns a proxy that is identical to this proxy, but uses batch oneway invocations.- Specified by:
ice_batchOneway
in interfaceObjectPrx
- Returns:
- A proxy that uses batch oneway invocations.
-
ice_datagram
Returns a proxy that is identical to this proxy, but uses datagram invocations.- Specified by:
ice_datagram
in interfaceObjectPrx
- Returns:
- A proxy that uses datagram invocations.
-
ice_batchDatagram
Returns a proxy that is identical to this proxy, but uses batch datagram invocations.- Specified by:
ice_batchDatagram
in interfaceObjectPrx
- Returns:
- A proxy that uses batch datagram invocations.
-
ice_compress
Returns a proxy that is identical to this proxy, except for compression.- Specified by:
ice_compress
in interfaceObjectPrx
- Parameters:
co
-true
enables compression for the new proxy;false
disables compression.- Returns:
- A proxy with the specified compression setting.
-
ice_timeout
Returns a proxy that is identical to this proxy, except for its connection timeout setting.- Specified by:
ice_timeout
in interfaceObjectPrx
- Parameters:
t
- The connection timeout for the proxy in milliseconds.- Returns:
- A proxy with the specified timeout.
-
ice_connectionId
Returns a proxy that is identical to this proxy, except for its connection ID.- Specified by:
ice_connectionId
in interfaceObjectPrx
- 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
Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy connection. -
ice_staticId
Description copied from interface:ObjectPrx
Returns the Slice type ID associated with this type.- Returns:
- The Slice type ID.
-