Glacier2

Interface _RouterOperationsNC

All Superinterfaces:

Ice._RouterOperationsNC

All Known Subinterfaces:

Router

public interface _RouterOperationsNC
extends Ice._RouterOperationsNC

The Glacier2 specialization of the Router interface.

Method Summary

Modifier and Type	Method and Description
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.
long	getSessionTimeout() Get the value of the session timeout.
void	refreshSession_async(AMD_Router_refreshSession __cb) Keep the calling client's session with this router alive.

Methods inherited from interface Ice._RouterOperationsNC

addProxies, getClientProxy, getServerProxy

Method Detail

getCategoryForClient

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.

createSession_async

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

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.

refreshSession_async

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.

destroySession

void destroySession()
             throws SessionNotExistException

Destroy the calling client's session with this router.

Throws:

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

getSessionTimeout

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

getACMTimeout

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