IceGrid

Class _AdminSessionDisp

java.lang.Object

Ice.ObjectImpl

IceGrid._AdminSessionDisp

All Implemented Interfaces:

Glacier2._SessionOperations, Glacier2._SessionOperationsNC, Glacier2.Session, Ice.Object, _AdminSessionOperations, _AdminSessionOperationsNC, AdminSession, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

_AdminSessionTie

public abstract class _AdminSessionDisp
extends Ice.ObjectImpl
implements AdminSession

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, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	__ids
static long	serialVersionUID

Fields inherited from interface IceGrid.AdminSession

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_AdminSessionDisp()

Method Summary

Modifier and Type	Method and Description
static Ice.DispatchStatus	___finishUpdate(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getAdmin(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getAdminCallbackTemplate(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getReplicaName(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___keepAlive(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___openNodeStdErr(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___openNodeStdOut(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___openRegistryStdErr(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___openRegistryStdOut(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___openServerLog(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___openServerStdErr(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___openServerStdOut(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___setObservers(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___setObserversByIdentity(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___startUpdate(AdminSession __obj, IceInternal.Incoming __inS, Ice.Current __current)
Ice.DispatchStatus	__dispatch(IceInternal.Incoming in, Ice.Current __current)
protected void	__readImpl(IceInternal.BasicStream __is)
protected void	__writeImpl(IceInternal.BasicStream __os)
void	destroy() Destroy the session.
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.
protected void	ice_copyStateFrom(Ice.Object __obj)
java.lang.String	ice_id()
java.lang.String	ice_id(Ice.Current __current)
java.lang.String[]	ice_ids()
java.lang.String[]	ice_ids(Ice.Current __current)
boolean	ice_isA(java.lang.String s)
boolean	ice_isA(java.lang.String s, Ice.Current __current)
static java.lang.String	ice_staticId()
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 class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IceGrid._AdminSessionOperations

finishUpdate, getAdmin, getAdminCallbackTemplate, getReplicaName, keepAlive, openNodeStdErr, openNodeStdOut, openRegistryStdErr, openRegistryStdOut, openServerLog, openServerStdErr, openServerStdOut, setObservers, setObserversByIdentity, startUpdate

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from interface Glacier2._SessionOperations

destroy

Field Detail

__ids

public static final java.lang.String[] __ids

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_AdminSessionDisp

public _AdminSessionDisp()

Method Detail

ice_copyStateFrom

protected void ice_copyStateFrom(Ice.Object __obj)
                          throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

ice_isA

public boolean ice_isA(java.lang.String s)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids()

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids(Ice.Current __current)

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id()

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id(Ice.Current __current)

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

destroy

public final void destroy()

Destroy the session. This is called automatically when the router is destroyed.

Specified by:

destroy in interface Glacier2._SessionOperationsNC

finishUpdate

public final void finishUpdate()
                        throws AccessDeniedException

Finish updating the registry and release the exclusive lock.

Specified by:

finishUpdate in interface _AdminSessionOperationsNC

Throws:

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

getAdmin

public final AdminPrx getAdmin()

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

Specified by:

getAdmin in interface _AdminSessionOperationsNC

Returns:

The admin interface proxy.

getAdminCallbackTemplate

public final 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.

Specified by:

getAdminCallbackTemplate in interface _AdminSessionOperationsNC

Returns:

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

getReplicaName

public final java.lang.String getReplicaName()

Get the name of the registry replica hosting this session.

Specified by:

getReplicaName in interface _AdminSessionOperationsNC

Returns:

The replica name of the registry.

keepAlive

public final void keepAlive()

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

Specified by:

keepAlive in interface _AdminSessionOperationsNC

See Also:

_RegistryOperations.getSessionTimeout(Ice.Current)

openNodeStdErr

public final 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.

Specified by:

openNodeStdErr in interface _AdminSessionOperationsNC

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

public final 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.

Specified by:

openNodeStdOut in interface _AdminSessionOperationsNC

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

public final 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.

Specified by:

openRegistryStdErr in interface _AdminSessionOperationsNC

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

public final 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.

Specified by:

openRegistryStdOut in interface _AdminSessionOperationsNC

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.

openServerLog

public final 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.

Specified by:

openServerLog in interface _AdminSessionOperationsNC

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

public final 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.

Specified by:

openServerStdErr in interface _AdminSessionOperationsNC

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

public final 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.

Specified by:

openServerStdOut in interface _AdminSessionOperationsNC

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.

setObservers

public final 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.

Specified by:

setObservers in interface _AdminSessionOperationsNC

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

public final 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.

Specified by:

setObserversByIdentity in interface _AdminSessionOperationsNC

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

public final int startUpdate()
                      throws AccessDeniedException

Acquires an exclusive lock to start updating the registry applications.

Specified by:

startUpdate in interface _AdminSessionOperationsNC

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.

___keepAlive

public static Ice.DispatchStatus ___keepAlive(AdminSession __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___getAdmin

public static Ice.DispatchStatus ___getAdmin(AdminSession __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___getAdminCallbackTemplate

public static Ice.DispatchStatus ___getAdminCallbackTemplate(AdminSession __obj,
                                                             IceInternal.Incoming __inS,
                                                             Ice.Current __current)

___setObservers

public static Ice.DispatchStatus ___setObservers(AdminSession __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___setObserversByIdentity

public static Ice.DispatchStatus ___setObserversByIdentity(AdminSession __obj,
                                                           IceInternal.Incoming __inS,
                                                           Ice.Current __current)

___startUpdate

public static Ice.DispatchStatus ___startUpdate(AdminSession __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___finishUpdate

public static Ice.DispatchStatus ___finishUpdate(AdminSession __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___getReplicaName

public static Ice.DispatchStatus ___getReplicaName(AdminSession __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___openServerLog

public static Ice.DispatchStatus ___openServerLog(AdminSession __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

___openServerStdErr

public static Ice.DispatchStatus ___openServerStdErr(AdminSession __obj,
                                                     IceInternal.Incoming __inS,
                                                     Ice.Current __current)

___openServerStdOut

public static Ice.DispatchStatus ___openServerStdOut(AdminSession __obj,
                                                     IceInternal.Incoming __inS,
                                                     Ice.Current __current)

___openNodeStdErr

public static Ice.DispatchStatus ___openNodeStdErr(AdminSession __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___openNodeStdOut

public static Ice.DispatchStatus ___openNodeStdOut(AdminSession __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___openRegistryStdErr

public static Ice.DispatchStatus ___openRegistryStdErr(AdminSession __obj,
                                                       IceInternal.Incoming __inS,
                                                       Ice.Current __current)

___openRegistryStdOut

public static Ice.DispatchStatus ___openRegistryStdOut(AdminSession __obj,
                                                       IceInternal.Incoming __inS,
                                                       Ice.Current __current)

__dispatch

public Ice.DispatchStatus __dispatch(IceInternal.Incoming in,
                                     Ice.Current __current)

Specified by:

__dispatch in interface Ice.Object

Overrides:

__dispatch in class Ice.ObjectImpl

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:

__writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:

__readImpl in class Ice.ObjectImpl