IceGrid

Interface _AdminSessionOperationsNC

All Superinterfaces:

Glacier2._SessionOperationsNC

All Known Subinterfaces:

AdminSession

All Known Implementing Classes:

_AdminSessionDisp, _AdminSessionTie

public interface _AdminSessionOperationsNC
extends Glacier2._SessionOperationsNC

Used by administrative clients to view, update, and receive observer updates from the IceGrid registry. Admin sessions are created either with the Registry object or the registry admin SessionManager object.

See Also:

Registry, SessionManager

Method Summary

Modifier and Type	Method and Description
void	finishUpdate() Finish updating the registry and release the exclusive lock.
AdminPrx	getAdmin() Get the admin interface.
Ice.ObjectPrx	getAdminCallbackTemplate() Get a "template" proxy for admin callback objects.
java.lang.String	getReplicaName() Get the name of the registry replica hosting this session.
void	keepAlive() Keep the session alive.
FileIteratorPrx	openNodeStdErr(java.lang.String name, int count) Open the given node stderr file for reading.
FileIteratorPrx	openNodeStdOut(java.lang.String name, int count) Open the given node stdout file for reading.
FileIteratorPrx	openRegistryStdErr(java.lang.String name, int count) Open the given registry stderr file for reading.
FileIteratorPrx	openRegistryStdOut(java.lang.String name, int count) Open the given registry stdout file for reading.
FileIteratorPrx	openServerLog(java.lang.String id, java.lang.String path, int count) Open the given server log file for reading.
FileIteratorPrx	openServerStdErr(java.lang.String id, int count) Open the given server stderr file for reading.
FileIteratorPrx	openServerStdOut(java.lang.String id, int count) Open the given server stdout file for reading.
void	setObservers(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs) Set the observer proxies that receive notifications when the state of the registry or nodes changes.
void	setObserversByIdentity(Ice.Identity registryObs, Ice.Identity nodeObs, Ice.Identity appObs, Ice.Identity adptObs, Ice.Identity objObs) Set the observer identities that receive notifications the state of the registry or nodes changes.
int	startUpdate() Acquires an exclusive lock to start updating the registry applications.

Methods inherited from interface Glacier2._SessionOperationsNC

destroy

Method Detail

keepAlive

void keepAlive()

Keep the session alive. Clients should call this operation regularly to prevent the server from reaping the session.

See Also:

_RegistryOperations.getSessionTimeout(Ice.Current)

getAdmin

AdminPrx getAdmin()

Get the admin interface. The admin object returned by this operation can only be accessed by the session.

Returns:

The admin interface proxy.

getAdminCallbackTemplate

Ice.ObjectPrx getAdminCallbackTemplate()

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

Returns:

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

setObservers

void setObservers(RegistryObserverPrx registryObs,
                  NodeObserverPrx nodeObs,
                  ApplicationObserverPrx appObs,
                  AdapterObserverPrx adptObs,
                  ObjectObserverPrx objObs)
           throws ObserverAlreadyRegisteredException

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

Parameters:

registryObs - The registry observer.

nodeObs - The node observer.

appObs - The application observer.

adptObs - The adapter observer.

objObs - The object observer.

Throws:

ObserverAlreadyRegisteredException - Raised if an observer is already registered with this registry.

setObserversByIdentity

void setObserversByIdentity(Ice.Identity registryObs,
                            Ice.Identity nodeObs,
                            Ice.Identity appObs,
                            Ice.Identity adptObs,
                            Ice.Identity objObs)
                     throws ObserverAlreadyRegisteredException

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

Parameters:

registryObs - The registry observer identity.

nodeObs - The node observer identity.

appObs - The application observer.

adptObs - The adapter observer.

objObs - The object observer.

Throws:

ObserverAlreadyRegisteredException - Raised if an observer is already registered with this registry.

startUpdate

int startUpdate()
         throws AccessDeniedException

Acquires an exclusive lock to start updating the registry applications.

Returns:

The current serial.

Throws:

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

finishUpdate

void finishUpdate()
           throws AccessDeniedException

Finish updating the registry and release the exclusive lock.

Throws:

AccessDeniedException - Raised if the session doesn't hold the exclusive lock.

getReplicaName

java.lang.String getReplicaName()

Get the name of the registry replica hosting this session.

Returns:

The replica name of the registry.

openServerLog

FileIteratorPrx openServerLog(java.lang.String id,
                              java.lang.String path,
                              int count)
                       throws DeploymentException,
                              FileNotAvailableException,
                              NodeUnreachableException,
                              ServerNotExistException

Open the given server log file for reading. The file can be read with the returned file iterator.

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 begining. If 0 or positive, the file is read from the last count lines.

Returns:

An iterator to read the file.

Throws:

FileNotAvailableException - Raised if the file can't be read.

ServerNotExistException - Raised if the server doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

DeploymentException - Raised if the server couldn't be deployed on the node.

openServerStdErr

FileIteratorPrx openServerStdErr(java.lang.String id,
                                 int count)
                          throws DeploymentException,
                                 FileNotAvailableException,
                                 NodeUnreachableException,
                                 ServerNotExistException

Open the given server stderr file for reading. The file can be read with the returned file iterator.

Parameters:

id - The server id.

count - Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the last count lines.

Returns:

An iterator to read the file.

Throws:

FileNotAvailableException - Raised if the file can't be read.

ServerNotExistException - Raised if the server doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

DeploymentException - Raised if the server couldn't be deployed on the node.

openServerStdOut

FileIteratorPrx openServerStdOut(java.lang.String id,
                                 int count)
                          throws DeploymentException,
                                 FileNotAvailableException,
                                 NodeUnreachableException,
                                 ServerNotExistException

Open the given server stdout file for reading. The file can be read with the returned file iterator.

Parameters:

id - The server id.

count - Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the last count lines.

Returns:

An iterator to read the file.

Throws:

FileNotAvailableException - Raised if the file can't be read.

ServerNotExistException - Raised if the server doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

DeploymentException - Raised if the server couldn't be deployed on the node.

openNodeStdErr

FileIteratorPrx openNodeStdErr(java.lang.String name,
                               int count)
                        throws FileNotAvailableException,
                               NodeNotExistException,
                               NodeUnreachableException

Open the given node stderr file for reading. The file can be read with the returned file iterator.

Parameters:

name - The node name.

count - Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the last count lines.

Returns:

An iterator to read the file.

Throws:

FileNotAvailableException - Raised if the file can't be read.

NodeNotExistException - Raised if the node doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

openNodeStdOut

FileIteratorPrx openNodeStdOut(java.lang.String name,
                               int count)
                        throws FileNotAvailableException,
                               NodeNotExistException,
                               NodeUnreachableException

Open the given node stdout file for reading. The file can be read with the returned file iterator.

Parameters:

name - The node name.

count - Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the last count lines.

Returns:

An iterator to read the file.

Throws:

FileNotAvailableException - Raised if the file can't be read.

NodeNotExistException - Raised if the node doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

openRegistryStdErr

FileIteratorPrx openRegistryStdErr(java.lang.String name,
                                   int count)
                            throws FileNotAvailableException,
                                   RegistryNotExistException,
                                   RegistryUnreachableException

Open the given registry stderr file for reading. The file can be read with the returned file iterator.

Parameters:

name - The registry name.

count - Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the last count lines.

Returns:

An iterator to read the file.

Throws:

FileNotAvailableException - Raised if the file can't be read.

RegistryNotExistException - Raised if the registry doesn't exist.

RegistryUnreachableException - Raised if the registry could not be reached.

openRegistryStdOut

FileIteratorPrx openRegistryStdOut(java.lang.String name,
                                   int count)
                            throws FileNotAvailableException,
                                   RegistryNotExistException,
                                   RegistryUnreachableException

Open the given registry stdout file for reading. The file can be read with the returned file iterator.

Parameters:

name - The registry name.

count - Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the last count lines.

Returns:

An iterator to read the file.

Throws:

FileNotAvailableException - Raised if the file can't be read.

RegistryNotExistException - Raised if the registry doesn't exist.

RegistryUnreachableException - Raised if the registry could not be reached.