Glacier2

Class _RouterDisp

java.lang.Object

Ice.ObjectImpl

Glacier2._RouterDisp

All Implemented Interfaces:

Ice._RouterOperations, Ice._RouterOperationsNC, Ice.Object, Ice.Router, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

_RouterTie

public abstract class _RouterDisp
extends Ice.ObjectImpl
implements Router

The Glacier2 specialization of the Router interface.

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from interface Glacier2.Router

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_RouterDisp()

Method Summary

Modifier and Type	Method and Description
static Ice.DispatchStatus	___createSession(Router __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___createSessionFromSecureConnection(Router __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___destroySession(Router __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getACMTimeout(Router __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getCategoryForClient(Router __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getSessionTimeout(Router __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___refreshSession(Router __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)
Ice.ObjectPrx[]	addProxies(Ice.ObjectPrx[] proxies) Add new proxy information to the router's routing table.
void	createSession_async(AMD_Router_createSession __cb, java.lang.String userId, java.lang.String password) Create a per-client session with the router.
void	createSessionFromSecureConnection_async(AMD_Router_createSessionFromSecureConnection __cb) Create a per-client session with the router.
void	destroySession() Destroy the calling client's session with this router.
int	getACMTimeout() Get the value of the ACM timeout.
java.lang.String	getCategoryForClient() This category must be used in the identities of all of the client's callback objects.
Ice.ObjectPrx	getClientProxy() Get the router's client proxy, i.e., the proxy to use for forwarding requests from the client to the router.
Ice.ObjectPrx	getServerProxy() Get the router's server proxy, i.e., the proxy to use for forwarding requests from the server to the router.
long	getSessionTimeout() Get the value of the session timeout.
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	refreshSession_async(AMD_Router_refreshSession __cb) Keep the calling client's session with this router alive.

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 Glacier2._RouterOperations

createSession_async, createSessionFromSecureConnection_async, destroySession, getACMTimeout, getCategoryForClient, getSessionTimeout, refreshSession_async

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 Ice._RouterOperations

addProxies, getClientProxy, getServerProxy

Field Detail

__ids

public static final java.lang.String[] __ids

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_RouterDisp

public _RouterDisp()

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()

createSession_async

public final void createSession_async(AMD_Router_createSession __cb,
                                      java.lang.String userId,
                                      java.lang.String password)
                               throws CannotCreateSessionException,
                                      PermissionDeniedException

Create a per-client session with the router. If a SessionManager has been installed, a proxy to a Session object is returned to the client. Otherwise, null is returned and only an internal session (i.e., not visible to the client) is created. If a session proxy is returned, it must be configured to route through the router that created it. This will happen automatically if the router is configured as the client's default router at the time the session proxy is created in the client process, otherwise the client must configure the session proxy explicitly.

Parameters:

__cb - The callback object for the operation.

userId - The user id for which to check the password.

password - The password for the given user id.

Throws:

PermissionDeniedException - Raised if the password for the given user id is not correct, or if the user is not allowed access.

CannotCreateSessionException - Raised if the session cannot be created.

createSessionFromSecureConnection_async

public final void createSessionFromSecureConnection_async(AMD_Router_createSessionFromSecureConnection __cb)
                                                   throws CannotCreateSessionException,
                                                          PermissionDeniedException

Create a per-client session with the router. The user is authenticated through the SSL certificates that have been associated with the connection. If a SessionManager has been installed, a proxy to a Session object is returned to the client. Otherwise, null is returned and only an internal session (i.e., not visible to the client) is created. If a session proxy is returned, it must be configured to route through the router that created it. This will happen automatically if the router is configured as the client's default router at the time the session proxy is created in the client process, otherwise the client must configure the session proxy explicitly.

Parameters:

__cb - The callback object for the operation.

Throws:

PermissionDeniedException - Raised if the user cannot be authenticated or if the user is not allowed access.

CannotCreateSessionException - Raised if the session cannot be created.

destroySession

public final void destroySession()
                          throws SessionNotExistException

Destroy the calling client's session with this router.

Throws:

SessionNotExistException - Raised if no session exists for the calling client.

getACMTimeout

public final int getACMTimeout()

Get the value of the ACM timeout. Clients supporting connection heartbeats can enable them instead of explicitly sending keep alives requests. NOTE: This method is only available since Ice 3.6.

Returns:

The timeout (in seconds).

getCategoryForClient

public final java.lang.String getCategoryForClient()

This category must be used in the identities of all of the client's callback objects. This is necessary in order for the router to forward callback requests to the intended client. If the Glacier2 server endpoints are not set, the returned category is an empty string.

Returns:

The category.

getSessionTimeout

public final long getSessionTimeout()

Get the value of the session timeout. Sessions are destroyed if they see no activity for this period of time.

Returns:

The timeout (in seconds).

refreshSession_async

public final void refreshSession_async(AMD_Router_refreshSession __cb)
                                throws SessionNotExistException

Keep the calling client's session with this router alive.

Parameters:

__cb - The callback object for the operation.

Throws:

SessionNotExistException - Raised if no session exists for the calling client.

addProxies

public final Ice.ObjectPrx[] addProxies(Ice.ObjectPrx[] proxies)

Add new proxy information to the router's routing table.

Specified by:

addProxies in interface Ice._RouterOperationsNC

Parameters:

proxies - The proxies to add.

Returns:

Proxies discarded by the router.

getClientProxy

public final Ice.ObjectPrx getClientProxy()

Get the router's client proxy, i.e., the proxy to use for forwarding requests from the client to the router. If a null proxy is returned, the client will forward requests to the router's endpoints.

Specified by:

getClientProxy in interface Ice._RouterOperationsNC

Returns:

The router's client proxy.

getServerProxy

public final Ice.ObjectPrx getServerProxy()

Get the router's server proxy, i.e., the proxy to use for forwarding requests from the server to the router.

Specified by:

getServerProxy in interface Ice._RouterOperationsNC

Returns:

The router's server proxy.

___getCategoryForClient

public static Ice.DispatchStatus ___getCategoryForClient(Router __obj,
                                                         IceInternal.Incoming __inS,
                                                         Ice.Current __current)

___createSession

public static Ice.DispatchStatus ___createSession(Router __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

___createSessionFromSecureConnection

public static Ice.DispatchStatus ___createSessionFromSecureConnection(Router __obj,
                                                                      IceInternal.Incoming __inS,
                                                                      Ice.Current __current)

___refreshSession

public static Ice.DispatchStatus ___refreshSession(Router __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___destroySession

public static Ice.DispatchStatus ___destroySession(Router __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___getSessionTimeout

public static Ice.DispatchStatus ___getSessionTimeout(Router __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

___getACMTimeout

public static Ice.DispatchStatus ___getACMTimeout(Router __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