Module com.zeroc.icegrid

Package com.zeroc.IceGrid

Interface AsyncAdminSession

All Superinterfaces:

AsyncSession, Object

public interface AsyncAdminSession
extends AsyncSession

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

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

See Also:

• RegistryPrx

Nested Class Summary

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

Object.Ice_invokeResult

Method Summary

Modifier and Type	Method	Description
default CompletionStage<OutgoingResponse>	dispatch(IncomingRequest request)	Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.
CompletionStage<Void>	finishUpdateAsync(Current current)	Finishes updating the registry and releases the exclusive lock.
CompletionStage<AdminPrx>	getAdminAsync(Current current)	Gets a proxy to the IceGrid admin object.
CompletionStage<ObjectPrx>	getAdminCallbackTemplateAsync(Current current)	Gets a "template" proxy for admin callback objects.
CompletionStage<String>	getReplicaNameAsync(Current current)	Gets the name of the registry replica hosting this session.
static String	ice_staticId()	Gets the type ID of the associated Slice interface.
CompletionStage<Void>	keepAliveAsync(Current current)	Keeps the session alive.
CompletionStage<FileIteratorPrx>	openNodeStdErrAsync(String name, int count, Current current)	Opens a node stderr file for reading.
CompletionStage<FileIteratorPrx>	openNodeStdOutAsync(String name, int count, Current current)	Opens a node stdout file for reading.
CompletionStage<FileIteratorPrx>	openRegistryStdErrAsync(String name, int count, Current current)	Opens a registry stderr file for reading.
CompletionStage<FileIteratorPrx>	openRegistryStdOutAsync(String name, int count, Current current)	Opens a registry stdout file for reading.
CompletionStage<FileIteratorPrx>	openServerLogAsync(String id, String path, int count, Current current)	Opens a server log file for reading.
CompletionStage<FileIteratorPrx>	openServerStdErrAsync(String id, int count, Current current)	Opens a server stderr file for reading.
CompletionStage<FileIteratorPrx>	openServerStdOutAsync(String id, int count, Current current)	Opens a server stdout file for reading.
CompletionStage<Void>	setObserversAsync(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs, Current current)	Sets the observer proxies that receive notifications when the state of the registry or nodes changes.
CompletionStage<Void>	setObserversByIdentityAsync(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs, Current current)	Sets the observer identities that receive notifications when the state of the registry or nodes changes.
CompletionStage<Integer>	startUpdateAsync(Current current)	Acquires an exclusive lock to start updating the registry applications.

Methods inherited from interface com.zeroc.Glacier2.AsyncSession

destroyAsync

Methods inherited from interface com.zeroc.Ice.Object

ice_id, ice_ids, ice_isA, ice_ping

Method Details

keepAliveAsync

CompletionStage<Void> keepAliveAsync(Current current)

Keeps the session alive.

Parameters:

current - the Current object of the incoming request

Returns:

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

getAdminAsync

CompletionStage<AdminPrx> getAdminAsync(Current current)

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

Parameters:

current - the Current object of the incoming request

Returns:

A proxy to the IceGrid admin object. This proxy is never null.

getAdminCallbackTemplateAsync

CompletionStage<ObjectPrx> getAdminCallbackTemplateAsync(Current current)

Gets a "template" proxy for admin callback objects. An Admin client uses this proxy to set the category of its callback objects, and the published endpoints of the object adapter hosting the admin callback objects.

Parameters:

current - the Current object of the incoming request

Returns:

A template proxy. The returned proxy is null when the Admin session was established using Glacier2.

setObserversAsync

CompletionStage<Void> setObserversAsync(RegistryObserverPrx registryObs,
 NodeObserverPrx nodeObs,
 ApplicationObserverPrx appObs,
 AdapterObserverPrx adptObs,
 ObjectObserverPrx objObs,
 Current current)
                                 throws ObserverAlreadyRegisteredException

Sets the observer proxies that receive notifications when the state of the registry or nodes changes.

Parameters:

registryObs - The registry observer.

nodeObs - The node observer.

appObs - The application observer.

adptObs - The adapter observer.

objObs - The object observer.

current - the Current object of the incoming request

Returns:

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

Throws:

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

setObserversByIdentityAsync

CompletionStage<Void> setObserversByIdentityAsync(Identity registryObs,
 Identity nodeObs,
 Identity appObs,
 Identity adptObs,
 Identity objObs,
 Current current)
                                           throws ObserverAlreadyRegisteredException

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

Parameters:

registryObs - The registry observer identity.

nodeObs - The node observer identity.

appObs - The application observer.

adptObs - The adapter observer.

objObs - The object observer.

current - the Current object of the incoming request

Returns:

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

Throws:

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

startUpdateAsync

CompletionStage<Integer> startUpdateAsync(Current current)
                                   throws AccessDeniedException

Acquires an exclusive lock to start updating the registry applications.

Parameters:

current - the Current object of the incoming request

Returns:

The current serial.

Throws:

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

finishUpdateAsync

CompletionStage<Void> finishUpdateAsync(Current current)
                                 throws AccessDeniedException

Finishes updating the registry and releases the exclusive lock.

Parameters:

current - the Current object of the incoming request

Returns:

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

Throws:

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

getReplicaNameAsync

CompletionStage<String> getReplicaNameAsync(Current current)

Gets the name of the registry replica hosting this session.

Parameters:

current - the Current object of the incoming request

Returns:

The replica name of the registry.

openServerLogAsync

CompletionStage<FileIteratorPrx> openServerLogAsync(String id,
 String path,
 int count,
 Current current)
                                             throws FileNotAvailableException,
ServerNotExistException,
NodeUnreachableException,
DeploymentException

Opens a server log file for reading.

Parameters:

id - The server ID.

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

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

current - the Current object of the incoming request

Returns:

An iterator to read the file. This proxy is never null.

Throws:

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

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

NodeUnreachableException - Thrown when the node is unreachable.

ServerNotExistException - Thrown when the server doesn't exist.

openServerStdErrAsync

CompletionStage<FileIteratorPrx> openServerStdErrAsync(String id,
 int count,
 Current current)
                                                throws FileNotAvailableException,
ServerNotExistException,
NodeUnreachableException,
DeploymentException

Opens a server stderr file for reading.

Parameters:

id - The server ID.

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

current - the Current object of the incoming request

Returns:

An iterator to read the file. This proxy is never null.

Throws:

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

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

NodeUnreachableException - Thrown when the node is unreachable.

ServerNotExistException - Thrown when the server doesn't exist.

openServerStdOutAsync

CompletionStage<FileIteratorPrx> openServerStdOutAsync(String id,
 int count,
 Current current)
                                                throws FileNotAvailableException,
ServerNotExistException,
NodeUnreachableException,
DeploymentException

Opens a server stdout file for reading.

Parameters:

id - The server id.

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

current - the Current object of the incoming request

Returns:

An iterator to read the file. This proxy is never null.

Throws:

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

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

NodeUnreachableException - Thrown when the node is unreachable.

ServerNotExistException - Thrown when the server doesn't exist.

openNodeStdErrAsync

CompletionStage<FileIteratorPrx> openNodeStdErrAsync(String name,
 int count,
 Current current)
                                              throws FileNotAvailableException,
NodeNotExistException,
NodeUnreachableException

Opens a node stderr file for reading.

Parameters:

name - The node name.

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

current - the Current object of the incoming request

Returns:

An iterator to read the file. This proxy is never null.

Throws:

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

NodeNotExistException - Thrown when the node doesn't exist.

NodeUnreachableException - Thrown when the node is unreachable.

openNodeStdOutAsync

CompletionStage<FileIteratorPrx> openNodeStdOutAsync(String name,
 int count,
 Current current)
                                              throws FileNotAvailableException,
NodeNotExistException,
NodeUnreachableException

Opens a node stdout file for reading.

Parameters:

name - The node name.

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

current - the Current object of the incoming request

Returns:

An iterator to read the file. This proxy is never null.

Throws:

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

NodeNotExistException - Thrown when the node doesn't exist.

NodeUnreachableException - Thrown when the node is unreachable.

openRegistryStdErrAsync

CompletionStage<FileIteratorPrx> openRegistryStdErrAsync(String name,
 int count,
 Current current)
                                                  throws FileNotAvailableException,
RegistryNotExistException,
RegistryUnreachableException

Opens a registry stderr file for reading.

Parameters:

name - The registry name.

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

current - the Current object of the incoming request

Returns:

An iterator to read the file. This proxy is never null.

Throws:

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

RegistryNotExistException - Thrown when the registry doesn't exist.

RegistryUnreachableException - Thrown when the registry is unreachable.

openRegistryStdOutAsync

CompletionStage<FileIteratorPrx> openRegistryStdOutAsync(String name,
 int count,
 Current current)
                                                  throws FileNotAvailableException,
RegistryNotExistException,
RegistryUnreachableException

Opens a registry stdout file for reading.

Parameters:

name - The registry name.

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

current - the Current object of the incoming request

Returns:

An iterator to read the file. This proxy is never null.

Throws:

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

RegistryNotExistException - Thrown when the registry doesn't exist.

RegistryUnreachableException - Thrown when the registry is unreachable.

ice_staticId

static String ice_staticId()

Gets the type ID of the associated Slice interface.

Returns:

the string "::IceGrid::AdminSession"

dispatch

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

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

Specified by:

dispatch in interface AsyncSession

Specified by:

dispatch in interface Object

Parameters:

request - the incoming request

Returns:

the outgoing response

Throws:

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