// ********************************************************************** // // Copyright (c) 2003-2010 ZeroC, Inc. All rights reserved. // // This copy of Ice is licensed to you under the terms described in the // ICE_LICENSE file included in this distribution. // // ********************************************************************** // Ice version 3.4.1 package Glacier2; // <auto-generated> // // Generated from file `Router.ice' // // Warning: do not edit this file. // // </auto-generated> /** * The Glacier2 specialization of the {@link Ice.Router} * interface. * **/ public interface RouterPrx extends Ice.RouterPrx { /** * 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. * * @return The category. * **/ public 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. * * @param __ctx The Context map to send with the invocation. * @return The category. * **/ public String getCategoryForClient(java.util.Map<String, String> __ctx); /** * 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. * * @return The asynchronous result object. **/ public Ice.AsyncResult begin_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. * * @param __ctx The Context map to send with the invocation. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_getCategoryForClient(java.util.Map<String, String> __ctx); /** * 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. * * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_getCategoryForClient(Ice.Callback __cb); /** * 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. * * @param __ctx The Context map to send with the invocation. * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_getCategoryForClient(java.util.Map<String, String> __ctx, Ice.Callback __cb); /** * 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. * * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_getCategoryForClient(Callback_Router_getCategoryForClient __cb); /** * 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. * * @param __ctx The Context map to send with the invocation. * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_getCategoryForClient(java.util.Map<String, String> __ctx, Callback_Router_getCategoryForClient __cb); /** * 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. * * @param __result The asynchronous result object. * @return The category. * **/ public String end_getCategoryForClient(Ice.AsyncResult __result); /** * Create a per-client session with the router. If a * {@link SessionManager} has been installed, a proxy to a {@link 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. * * @see Session * @see SessionManager * @see PermissionsVerifier * * @return A proxy for the newly created session, or null if no * {@link SessionManager} has been installed. * * @param userId The user id for which to check the password. * * @param 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. * * @throws CannotCreateSessionException Raised if the session * cannot be created. * **/ public SessionPrx createSession(String userId, String password) throws CannotCreateSessionException, PermissionDeniedException; /** * Create a per-client session with the router. If a * {@link SessionManager} has been installed, a proxy to a {@link 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. * * @see Session * @see SessionManager * @see PermissionsVerifier * * @param __ctx The Context map to send with the invocation. * @return A proxy for the newly created session, or null if no * {@link SessionManager} has been installed. * * @param userId The user id for which to check the password. * * @param 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. * * @throws CannotCreateSessionException Raised if the session * cannot be created. * **/ public SessionPrx createSession(String userId, String password, java.util.Map<String, String> __ctx) throws CannotCreateSessionException, PermissionDeniedException; /** * Create a per-client session with the router. If a * {@link SessionManager} has been installed, a proxy to a {@link 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. * * @param userId The user id for which to check the password. * * @param password The password for the given user id. * * @return The asynchronous result object. **/ public Ice.AsyncResult begin_createSession(String userId, String password); /** * Create a per-client session with the router. If a * {@link SessionManager} has been installed, a proxy to a {@link 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. * * @param userId The user id for which to check the password. * * @param password The password for the given user id. * * @param __ctx The Context map to send with the invocation. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_createSession(String userId, String password, java.util.Map<String, String> __ctx); /** * Create a per-client session with the router. If a * {@link SessionManager} has been installed, a proxy to a {@link 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. * * @param userId The user id for which to check the password. * * @param password The password for the given user id. * * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_createSession(String userId, String password, Ice.Callback __cb); /** * Create a per-client session with the router. If a * {@link SessionManager} has been installed, a proxy to a {@link 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. * * @param userId The user id for which to check the password. * * @param password The password for the given user id. * * @param __ctx The Context map to send with the invocation. * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_createSession(String userId, String password, java.util.Map<String, String> __ctx, Ice.Callback __cb); /** * Create a per-client session with the router. If a * {@link SessionManager} has been installed, a proxy to a {@link 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. * * @param userId The user id for which to check the password. * * @param password The password for the given user id. * * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_createSession(String userId, String password, Callback_Router_createSession __cb); /** * Create a per-client session with the router. If a * {@link SessionManager} has been installed, a proxy to a {@link 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. * * @param userId The user id for which to check the password. * * @param password The password for the given user id. * * @param __ctx The Context map to send with the invocation. * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_createSession(String userId, String password, java.util.Map<String, String> __ctx, Callback_Router_createSession __cb); /** * Create a per-client session with the router. If a * {@link SessionManager} has been installed, a proxy to a {@link 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. * * @param __result The asynchronous result object. * @see Session * @see SessionManager * @see PermissionsVerifier * * @return A proxy for the newly created session, or null if no * {@link SessionManager} has been installed. * * @param userId The user id for which to check the password. * * @param 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. * * @throws CannotCreateSessionException Raised if the session * cannot be created. * **/ public SessionPrx end_createSession(Ice.AsyncResult __result) 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 {@link SessionManager} has been * installed, a proxy to a {@link 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. * * @see Session * @see SessionManager * @see PermissionsVerifier * * @return A proxy for the newly created session, or null if no * {@link SessionManager} has been installed. * * @throws PermissionDeniedException Raised if the user cannot be * authenticated or if the user is not allowed access. * * @throws CannotCreateSessionException Raised if the session * cannot be created. * **/ public SessionPrx createSessionFromSecureConnection() 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 {@link SessionManager} has been * installed, a proxy to a {@link 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. * * @see Session * @see SessionManager * @see PermissionsVerifier * * @param __ctx The Context map to send with the invocation. * @return A proxy for the newly created session, or null if no * {@link SessionManager} has been installed. * * @throws PermissionDeniedException Raised if the user cannot be * authenticated or if the user is not allowed access. * * @throws CannotCreateSessionException Raised if the session * cannot be created. * **/ public SessionPrx createSessionFromSecureConnection(java.util.Map<String, String> __ctx) 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 {@link SessionManager} has been * installed, a proxy to a {@link 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. * * @return The asynchronous result object. **/ public Ice.AsyncResult begin_createSessionFromSecureConnection(); /** * 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 {@link SessionManager} has been * installed, a proxy to a {@link 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. * * @param __ctx The Context map to send with the invocation. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_createSessionFromSecureConnection(java.util.Map<String, String> __ctx); /** * 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 {@link SessionManager} has been * installed, a proxy to a {@link 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. * * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_createSessionFromSecureConnection(Ice.Callback __cb); /** * 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 {@link SessionManager} has been * installed, a proxy to a {@link 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. * * @param __ctx The Context map to send with the invocation. * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_createSessionFromSecureConnection(java.util.Map<String, String> __ctx, Ice.Callback __cb); /** * 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 {@link SessionManager} has been * installed, a proxy to a {@link 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. * * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_createSessionFromSecureConnection(Callback_Router_createSessionFromSecureConnection __cb); /** * 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 {@link SessionManager} has been * installed, a proxy to a {@link 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. * * @param __ctx The Context map to send with the invocation. * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_createSessionFromSecureConnection(java.util.Map<String, String> __ctx, Callback_Router_createSessionFromSecureConnection __cb); /** * 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 {@link SessionManager} has been * installed, a proxy to a {@link 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. * * @param __result The asynchronous result object. * @see Session * @see SessionManager * @see PermissionsVerifier * * @return A proxy for the newly created session, or null if no * {@link SessionManager} has been installed. * * @throws PermissionDeniedException Raised if the user cannot be * authenticated or if the user is not allowed access. * * @throws CannotCreateSessionException Raised if the session * cannot be created. * **/ public SessionPrx end_createSessionFromSecureConnection(Ice.AsyncResult __result) throws CannotCreateSessionException, PermissionDeniedException; /** * Keep the calling client's session with this router alive. * * @throws SessionNotExistException Raised if no session exists * for the calling client. * **/ public void refreshSession() throws SessionNotExistException; /** * Keep the calling client's session with this router alive. * * @throws SessionNotExistException Raised if no session exists * for the calling client. * * @param __ctx The Context map to send with the invocation. **/ public void refreshSession(java.util.Map<String, String> __ctx) throws SessionNotExistException; /** * Keep the calling client's session with this router alive. * * @return The asynchronous result object. **/ public Ice.AsyncResult begin_refreshSession(); /** * Keep the calling client's session with this router alive. * * @param __ctx The Context map to send with the invocation. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_refreshSession(java.util.Map<String, String> __ctx); /** * Keep the calling client's session with this router alive. * * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_refreshSession(Ice.Callback __cb); /** * Keep the calling client's session with this router alive. * * @param __ctx The Context map to send with the invocation. * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_refreshSession(java.util.Map<String, String> __ctx, Ice.Callback __cb); /** * Keep the calling client's session with this router alive. * * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_refreshSession(Callback_Router_refreshSession __cb); /** * Keep the calling client's session with this router alive. * * @param __ctx The Context map to send with the invocation. * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_refreshSession(java.util.Map<String, String> __ctx, Callback_Router_refreshSession __cb); /** * Keep the calling client's session with this router alive. * * @param __result The asynchronous result object. * @throws SessionNotExistException Raised if no session exists * for the calling client. * **/ public void end_refreshSession(Ice.AsyncResult __result) throws SessionNotExistException; /** * Keep the calling client's session with this router alive. * * @param __cb The callback object for the operation. **/ public boolean refreshSession_async(AMI_Router_refreshSession __cb); /** * Keep the calling client's session with this router alive. * * @param __cb The callback object for the operation. * @param __ctx The Context map to send with the invocation. **/ public boolean refreshSession_async(AMI_Router_refreshSession __cb, java.util.Map<String, String> __ctx); /** * Destroy the calling client's session with this router. * * @throws SessionNotExistException Raised if no session exists * for the calling client. * **/ public void destroySession() throws SessionNotExistException; /** * Destroy the calling client's session with this router. * * @throws SessionNotExistException Raised if no session exists * for the calling client. * * @param __ctx The Context map to send with the invocation. **/ public void destroySession(java.util.Map<String, String> __ctx) throws SessionNotExistException; /** * Destroy the calling client's session with this router. * * @return The asynchronous result object. **/ public Ice.AsyncResult begin_destroySession(); /** * Destroy the calling client's session with this router. * * @param __ctx The Context map to send with the invocation. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_destroySession(java.util.Map<String, String> __ctx); /** * Destroy the calling client's session with this router. * * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_destroySession(Ice.Callback __cb); /** * Destroy the calling client's session with this router. * * @param __ctx The Context map to send with the invocation. * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_destroySession(java.util.Map<String, String> __ctx, Ice.Callback __cb); /** * Destroy the calling client's session with this router. * * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_destroySession(Callback_Router_destroySession __cb); /** * Destroy the calling client's session with this router. * * @param __ctx The Context map to send with the invocation. * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_destroySession(java.util.Map<String, String> __ctx, Callback_Router_destroySession __cb); /** * Destroy the calling client's session with this router. * * @param __result The asynchronous result object. * @throws SessionNotExistException Raised if no session exists * for the calling client. * **/ public void end_destroySession(Ice.AsyncResult __result) throws SessionNotExistException; /** * Destroy the calling client's session with this router. * * @param __cb The callback object for the operation. **/ public boolean destroySession_async(AMI_Router_destroySession __cb); /** * Destroy the calling client's session with this router. * * @param __cb The callback object for the operation. * @param __ctx The Context map to send with the invocation. **/ public boolean destroySession_async(AMI_Router_destroySession __cb, java.util.Map<String, String> __ctx); /** * Get the value of the session timeout. Sessions are destroyed * if they see no activity for this period of time. * * @return The timeout (in seconds). * **/ public long getSessionTimeout(); /** * Get the value of the session timeout. Sessions are destroyed * if they see no activity for this period of time. * * @param __ctx The Context map to send with the invocation. * @return The timeout (in seconds). * **/ public long getSessionTimeout(java.util.Map<String, String> __ctx); /** * Get the value of the session timeout. Sessions are destroyed * if they see no activity for this period of time. * * @return The asynchronous result object. **/ public Ice.AsyncResult begin_getSessionTimeout(); /** * Get the value of the session timeout. Sessions are destroyed * if they see no activity for this period of time. * * @param __ctx The Context map to send with the invocation. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_getSessionTimeout(java.util.Map<String, String> __ctx); /** * Get the value of the session timeout. Sessions are destroyed * if they see no activity for this period of time. * * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_getSessionTimeout(Ice.Callback __cb); /** * Get the value of the session timeout. Sessions are destroyed * if they see no activity for this period of time. * * @param __ctx The Context map to send with the invocation. * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_getSessionTimeout(java.util.Map<String, String> __ctx, Ice.Callback __cb); /** * Get the value of the session timeout. Sessions are destroyed * if they see no activity for this period of time. * * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_getSessionTimeout(Callback_Router_getSessionTimeout __cb); /** * Get the value of the session timeout. Sessions are destroyed * if they see no activity for this period of time. * * @param __ctx The Context map to send with the invocation. * @param __cb The asynchronous callback object. * @return The asynchronous result object. **/ public Ice.AsyncResult begin_getSessionTimeout(java.util.Map<String, String> __ctx, Callback_Router_getSessionTimeout __cb); /** * Get the value of the session timeout. Sessions are destroyed * if they see no activity for this period of time. * * @param __result The asynchronous result object. * @return The timeout (in seconds). * **/ public long end_getSessionTimeout(Ice.AsyncResult __result); }