Package com.zeroc.Glacier2

Interface RouterPrx

All Superinterfaces:

com.zeroc.Ice.ObjectPrx, com.zeroc.Ice.RouterPrx

public interface RouterPrx
extends com.zeroc.Ice.RouterPrx

The Glacier2 specialization of the Ice::Router interface.

Field Summary

Fields inherited from interface com.zeroc.Ice.ObjectPrx

ice_staticId, noExplicitContext

Method Summary

Modifier and Type	Method	Description
static RouterPrx	checkedCast(com.zeroc.Ice.ObjectPrx obj)	Contacts the remote server to verify that the object implements this type.
static RouterPrx	checkedCast(com.zeroc.Ice.ObjectPrx obj, String facet)	Contacts the remote server to verify that a facet of the object implements this type.
static RouterPrx	checkedCast(com.zeroc.Ice.ObjectPrx obj, String facet, Map<String,String> context)	Contacts the remote server to verify that a facet of the object implements this type.
static RouterPrx	checkedCast(com.zeroc.Ice.ObjectPrx obj, Map<String,String> context)	Contacts the remote server to verify that the object implements this type.
default SessionPrx	createSession(String userId, String password)	Create a per-client session with the router.
default SessionPrx	createSession(String userId, String password, Map<String,String> context)	Create a per-client session with the router.
default CompletableFuture<SessionPrx>	createSessionAsync(String userId, String password)	Create a per-client session with the router.
default CompletableFuture<SessionPrx>	createSessionAsync(String userId, String password, Map<String,String> context)	Create a per-client session with the router.
default SessionPrx	createSessionFromSecureConnection()	Create a per-client session with the router.
default SessionPrx	createSessionFromSecureConnection(Map<String,String> context)	Create a per-client session with the router.
default CompletableFuture<SessionPrx>	createSessionFromSecureConnectionAsync()	Create a per-client session with the router.
default CompletableFuture<SessionPrx>	createSessionFromSecureConnectionAsync(Map<String,String> context)	Create a per-client session with the router.
default void	destroySession()	Destroy the calling client's session with this router.
default void	destroySession(Map<String,String> context)	Destroy the calling client's session with this router.
default CompletableFuture<Void>	destroySessionAsync()	Destroy the calling client's session with this router.
default CompletableFuture<Void>	destroySessionAsync(Map<String,String> context)	Destroy the calling client's session with this router.
default int	getACMTimeout()	Get the value of the ACM timeout.
default int	getACMTimeout(Map<String,String> context)	Get the value of the ACM timeout.
default CompletableFuture<Integer>	getACMTimeoutAsync()	Get the value of the ACM timeout.
default CompletableFuture<Integer>	getACMTimeoutAsync(Map<String,String> context)	Get the value of the ACM timeout.
default String	getCategoryForClient()	This category must be used in the identities of all of the client's callback objects.
default String	getCategoryForClient(Map<String,String> context)	This category must be used in the identities of all of the client's callback objects.
default CompletableFuture<String>	getCategoryForClientAsync()	This category must be used in the identities of all of the client's callback objects.
default CompletableFuture<String>	getCategoryForClientAsync(Map<String,String> context)	This category must be used in the identities of all of the client's callback objects.
default long	getSessionTimeout()	Get the value of the session timeout.
default long	getSessionTimeout(Map<String,String> context)	Get the value of the session timeout.
default CompletableFuture<Long>	getSessionTimeoutAsync()	Get the value of the session timeout.
default CompletableFuture<Long>	getSessionTimeoutAsync(Map<String,String> context)	Get the value of the session timeout.
default RouterPrx	ice_adapterId(String newAdapterId)	Returns a proxy that is identical to this proxy, except for the adapter ID.
default RouterPrx	ice_batchDatagram()	Returns a proxy that is identical to this proxy, but uses batch datagram invocations.
default RouterPrx	ice_batchOneway()	Returns a proxy that is identical to this proxy, but uses batch oneway invocations.
default RouterPrx	ice_collocationOptimized(boolean b)	Returns a proxy that is identical to this proxy, except for collocation optimization.
default RouterPrx	ice_compress(boolean co)	Returns a proxy that is identical to this proxy, except for compression.
default RouterPrx	ice_connectionCached(boolean newCache)	Returns a proxy that is identical to this proxy, except for connection caching.
default RouterPrx	ice_connectionId(String connectionId)	Returns a proxy that is identical to this proxy, except for its connection ID.
default RouterPrx	ice_context(Map<String,String> newContext)	Returns a proxy that is identical to this proxy, except for the per-proxy context.
default RouterPrx	ice_datagram()	Returns a proxy that is identical to this proxy, but uses datagram invocations.
default RouterPrx	ice_encodingVersion(com.zeroc.Ice.EncodingVersion e)	Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
default RouterPrx	ice_endpoints(com.zeroc.Ice.Endpoint[] newEndpoints)	Returns a proxy that is identical to this proxy, except for the endpoints.
default RouterPrx	ice_endpointSelection(com.zeroc.Ice.EndpointSelectionType newType)	Returns a proxy that is identical to this proxy, except for the endpoint selection policy.
default RouterPrx	ice_fixed(com.zeroc.Ice.Connection connection)	Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy connection.
default RouterPrx	ice_invocationTimeout(int newTimeout)	Returns a proxy that is identical to this proxy, except for the invocation timeout.
default RouterPrx	ice_locator(com.zeroc.Ice.LocatorPrx locator)	Returns a proxy that is identical to this proxy, except for the locator.
default RouterPrx	ice_locatorCacheTimeout(int newTimeout)	Returns a proxy that is identical to this proxy, except for the locator cache timeout.
default RouterPrx	ice_oneway()	Returns a proxy that is identical to this proxy, but uses oneway invocations.
default RouterPrx	ice_preferSecure(boolean b)	Returns a proxy that is identical to this proxy, except for its endpoint selection policy.
default RouterPrx	ice_router(com.zeroc.Ice.RouterPrx router)	Returns a proxy that is identical to this proxy, except for the router.
default RouterPrx	ice_secure(boolean b)	Returns a proxy that is identical to this proxy, except for how it selects endpoints.
static String	ice_staticId()
default RouterPrx	ice_timeout(int t)	Returns a proxy that is identical to this proxy, except for its connection timeout setting.
default RouterPrx	ice_twoway()	Returns a proxy that is identical to this proxy, but uses twoway invocations.
default void	refreshSession()	Keep the calling client's session with this router alive.
default void	refreshSession(Map<String,String> context)	Keep the calling client's session with this router alive.
default CompletableFuture<Void>	refreshSessionAsync()	Keep the calling client's session with this router alive.
default CompletableFuture<Void>	refreshSessionAsync(Map<String,String> context)	Keep the calling client's session with this router alive.
static RouterPrx	uncheckedCast(com.zeroc.Ice.ObjectPrx obj)	Downcasts the given proxy to this type without contacting the remote server.
static RouterPrx	uncheckedCast(com.zeroc.Ice.ObjectPrx obj, String facet)	Downcasts the given proxy to this type without contacting the remote server.

Methods inherited from interface com.zeroc.Ice.ObjectPrx

_copyFrom, _getReference, _ice_adapterId, _ice_batchDatagram, _ice_batchOneway, _ice_collocationOptimized, _ice_compress, _ice_connectionCached, _ice_connectionId, _ice_context, _ice_datagram, _ice_encodingVersion, _ice_endpoints, _ice_endpointSelection, _ice_fixed, _ice_invocationTimeout, _ice_locator, _ice_locatorCacheTimeout, _ice_oneway, _ice_preferSecure, _ice_router, _ice_secure, _ice_timeout, _ice_twoway, _newInstance, _write, equals, ice_executor, ice_facet, ice_flushBatchRequests, ice_flushBatchRequestsAsync, ice_getAdapterId, ice_getCachedConnection, ice_getCommunicator, ice_getCompress, ice_getConnection, ice_getConnectionAsync, ice_getConnectionId, ice_getContext, ice_getEncodingVersion, ice_getEndpoints, ice_getEndpointSelection, ice_getFacet, ice_getIdentity, ice_getInvocationTimeout, ice_getLocator, ice_getLocatorCacheTimeout, ice_getRouter, ice_getTimeout, ice_id, ice_id, ice_idAsync, ice_idAsync, ice_identity, ice_ids, ice_ids, ice_idsAsync, ice_idsAsync, ice_invoke, ice_invoke, ice_invokeAsync, ice_invokeAsync, ice_isA, ice_isA, ice_isAAsync, ice_isAAsync, ice_isBatchDatagram, ice_isBatchOneway, ice_isCollocationOptimized, ice_isConnectionCached, ice_isDatagram, ice_isFixed, ice_isOneway, ice_isPreferSecure, ice_isSecure, ice_isTwoway, ice_ping, ice_ping, ice_pingAsync, ice_pingAsync

Methods inherited from interface com.zeroc.Ice.RouterPrx

_iceI_addProxiesAsync, _iceI_getClientProxyAsync, _iceI_getServerProxyAsync, addProxies, addProxies, addProxiesAsync, addProxiesAsync, getClientProxy, getClientProxy, getClientProxyAsync, getClientProxyAsync, getServerProxy, getServerProxy, getServerProxyAsync, getServerProxyAsync

Method Details

getCategoryForClient

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

getCategoryForClient

default String getCategoryForClient(Map<String,String> context)

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.

Parameters:

context - The Context map to send with the invocation.

Returns:

The category.

getCategoryForClientAsync

default CompletableFuture<String> getCategoryForClientAsync()

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.

getCategoryForClientAsync

default CompletableFuture<String> getCategoryForClientAsync(Map<String,String> context)

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.

Parameters:

context - The Context map to send with the invocation.

Returns:

The category.

createSession

default SessionPrx createSession(String userId,
 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:

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

password - The password for the given user id.

Returns:

A proxy for the newly created session, or null if no SessionManager has been installed.

Throws:

CannotCreateSessionException - Raised if the session cannot be created.

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

See Also:

• Session
• SessionManager
• PermissionsVerifier

createSession

default SessionPrx createSession(String userId,
 String password,
 Map<String,String> context)
                          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:

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

password - The password for the given user id.

context - The Context map to send with the invocation.

Returns:

A proxy for the newly created session, or null if no SessionManager has been installed.

Throws:

CannotCreateSessionException - Raised if the session cannot be created.

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

See Also:

• Session
• SessionManager
• PermissionsVerifier

createSessionAsync

default CompletableFuture<SessionPrx> createSessionAsync(String userId,
 String password)

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:

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

password - The password for the given user id.

Returns:

A proxy for the newly created session, or null if no SessionManager has been installed.

See Also:

• Session
• SessionManager
• PermissionsVerifier

createSessionAsync

default CompletableFuture<SessionPrx> createSessionAsync(String userId,
 String password,
 Map<String,String> context)

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:

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

password - The password for the given user id.

context - The Context map to send with the invocation.

Returns:

A proxy for the newly created session, or null if no SessionManager has been installed.

See Also:

• Session
• SessionManager
• PermissionsVerifier

createSessionFromSecureConnection

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

Returns:

A proxy for the newly created session, or null if no SessionManager has been installed.

Throws:

CannotCreateSessionException - Raised if the session cannot be created.

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

See Also:

• Session
• SessionManager
• PermissionsVerifier

createSessionFromSecureConnection

default SessionPrx createSessionFromSecureConnection(Map<String,String> context)
                                              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:

context - The Context map to send with the invocation.

Returns:

A proxy for the newly created session, or null if no SessionManager has been installed.

Throws:

CannotCreateSessionException - Raised if the session cannot be created.

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

See Also:

• Session
• SessionManager
• PermissionsVerifier

createSessionFromSecureConnectionAsync

default CompletableFuture<SessionPrx> createSessionFromSecureConnectionAsync()

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.

Returns:

A proxy for the newly created session, or null if no SessionManager has been installed.

See Also:

• Session
• SessionManager
• PermissionsVerifier

createSessionFromSecureConnectionAsync

default CompletableFuture<SessionPrx> createSessionFromSecureConnectionAsync(Map<String,String> context)

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:

context - The Context map to send with the invocation.

Returns:

A proxy for the newly created session, or null if no SessionManager has been installed.

See Also:

• Session
• SessionManager
• PermissionsVerifier

refreshSession

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

refreshSession

default void refreshSession(Map<String,String> context)
                     throws SessionNotExistException

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

Parameters:

context - The Context map to send with the invocation.

Throws:

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

refreshSessionAsync

default CompletableFuture<Void> refreshSessionAsync()

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

Returns:

A future that will be completed when the invocation completes.

refreshSessionAsync

default CompletableFuture<Void> refreshSessionAsync(Map<String,String> context)

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

Parameters:

context - The Context map to send with the invocation.

Returns:

A future that will be completed when the invocation completes.

destroySession

default void destroySession()
                     throws SessionNotExistException

Destroy the calling client's session with this router.

Throws:

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

destroySession

default void destroySession(Map<String,String> context)
                     throws SessionNotExistException

Destroy the calling client's session with this router.

Parameters:

context - The Context map to send with the invocation.

Throws:

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

destroySessionAsync

default CompletableFuture<Void> destroySessionAsync()

Destroy the calling client's session with this router.

Returns:

A future that will be completed when the invocation completes.

destroySessionAsync

default CompletableFuture<Void> destroySessionAsync(Map<String,String> context)

Destroy the calling client's session with this router.

Parameters:

context - The Context map to send with the invocation.

Returns:

A future that will be completed when the invocation completes.

getSessionTimeout

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

getSessionTimeout

default long getSessionTimeout(Map<String,String> context)

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

Parameters:

context - The Context map to send with the invocation.

Returns:

The timeout (in seconds).

getSessionTimeoutAsync

default CompletableFuture<Long> getSessionTimeoutAsync()

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

getSessionTimeoutAsync

default CompletableFuture<Long> getSessionTimeoutAsync(Map<String,String> context)

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

Parameters:

context - The Context map to send with the invocation.

Returns:

The timeout (in seconds).

getACMTimeout

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

getACMTimeout

default int getACMTimeout(Map<String,String> context)

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.

Parameters:

context - The Context map to send with the invocation.

Returns:

The timeout (in seconds).

getACMTimeoutAsync

default CompletableFuture<Integer> getACMTimeoutAsync()

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

getACMTimeoutAsync

default CompletableFuture<Integer> getACMTimeoutAsync(Map<String,String> context)

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.

Parameters:

context - The Context map to send with the invocation.

Returns:

The timeout (in seconds).

checkedCast

static RouterPrx checkedCast(com.zeroc.Ice.ObjectPrx obj)

Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.

Parameters:

obj - The untyped proxy.

Returns:

A proxy for this type, or null if the object does not support this type.

checkedCast

static RouterPrx checkedCast(com.zeroc.Ice.ObjectPrx obj,
 Map<String,String> context)

Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.

Parameters:

obj - The untyped proxy.

context - The Context map to send with the invocation.

Returns:

A proxy for this type, or null if the object does not support this type.

checkedCast

static RouterPrx checkedCast(com.zeroc.Ice.ObjectPrx obj,
 String facet)

Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.

Parameters:

obj - The untyped proxy.

facet - The name of the desired facet.

Returns:

A proxy for this type, or null if the object does not support this type.

checkedCast

static RouterPrx checkedCast(com.zeroc.Ice.ObjectPrx obj,
 String facet,
 Map<String,String> context)

Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.

Parameters:

obj - The untyped proxy.

facet - The name of the desired facet.

context - The Context map to send with the invocation.

Returns:

A proxy for this type, or null if the object does not support this type.

uncheckedCast

static RouterPrx uncheckedCast(com.zeroc.Ice.ObjectPrx obj)

Downcasts the given proxy to this type without contacting the remote server.

Parameters:

obj - The untyped proxy.

Returns:

A proxy for this type.

uncheckedCast

static RouterPrx uncheckedCast(com.zeroc.Ice.ObjectPrx obj,
 String facet)

Downcasts the given proxy to this type without contacting the remote server.

Parameters:

obj - The untyped proxy.

facet - The name of the desired facet.

Returns:

A proxy for this type.

ice_context

default RouterPrx ice_context(Map<String,String> newContext)

Returns a proxy that is identical to this proxy, except for the per-proxy context.

Specified by:

ice_context in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_context in interface com.zeroc.Ice.RouterPrx

Parameters:

newContext - The context for the new proxy.

Returns:

A proxy with the specified per-proxy context.

ice_adapterId

default RouterPrx ice_adapterId(String newAdapterId)

Returns a proxy that is identical to this proxy, except for the adapter ID.

Specified by:

ice_adapterId in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_adapterId in interface com.zeroc.Ice.RouterPrx

Parameters:

newAdapterId - The adapter ID for the new proxy.

Returns:

A proxy with the specified adapter ID.

ice_endpoints

default RouterPrx ice_endpoints(com.zeroc.Ice.Endpoint[] newEndpoints)

Returns a proxy that is identical to this proxy, except for the endpoints.

Specified by:

ice_endpoints in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_endpoints in interface com.zeroc.Ice.RouterPrx

Parameters:

newEndpoints - The endpoints for the new proxy.

Returns:

A proxy with the specified endpoints.

ice_locatorCacheTimeout

default RouterPrx ice_locatorCacheTimeout(int newTimeout)

Returns a proxy that is identical to this proxy, except for the locator cache timeout.

Specified by:

ice_locatorCacheTimeout in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_locatorCacheTimeout in interface com.zeroc.Ice.RouterPrx

Parameters:

newTimeout - The new locator cache timeout (in seconds).

Returns:

A proxy with the specified locator cache timeout.

ice_invocationTimeout

default RouterPrx ice_invocationTimeout(int newTimeout)

Returns a proxy that is identical to this proxy, except for the invocation timeout.

Specified by:

ice_invocationTimeout in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_invocationTimeout in interface com.zeroc.Ice.RouterPrx

Parameters:

newTimeout - The new invocation timeout (in seconds).

Returns:

A proxy with the specified invocation timeout.

ice_connectionCached

default RouterPrx ice_connectionCached(boolean newCache)

Returns a proxy that is identical to this proxy, except for connection caching.

Specified by:

ice_connectionCached in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_connectionCached in interface com.zeroc.Ice.RouterPrx

Parameters:

newCache - true if the new proxy should cache connections; false otherwise.

Returns:

A proxy with the specified caching policy.

ice_endpointSelection

default RouterPrx ice_endpointSelection(com.zeroc.Ice.EndpointSelectionType newType)

Returns a proxy that is identical to this proxy, except for the endpoint selection policy.

Specified by:

ice_endpointSelection in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_endpointSelection in interface com.zeroc.Ice.RouterPrx

Parameters:

newType - The new endpoint selection policy.

Returns:

A proxy with the specified endpoint selection policy.

ice_secure

default RouterPrx ice_secure(boolean b)

Returns a proxy that is identical to this proxy, except for how it selects endpoints.

Specified by:

ice_secure in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_secure in interface com.zeroc.Ice.RouterPrx

Parameters:

b - If b is true, only endpoints that use a secure transport are used by the new proxy. If b is false, the returned proxy uses both secure and insecure endpoints.

Returns:

A proxy with the specified selection policy.

ice_encodingVersion

default RouterPrx ice_encodingVersion(com.zeroc.Ice.EncodingVersion e)

Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.

Specified by:

ice_encodingVersion in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_encodingVersion in interface com.zeroc.Ice.RouterPrx

Parameters:

e - The encoding version to use to marshal request parameters.

Returns:

A proxy with the specified encoding version.

ice_preferSecure

default RouterPrx ice_preferSecure(boolean b)

Returns a proxy that is identical to this proxy, except for its endpoint selection policy.

Specified by:

ice_preferSecure in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_preferSecure in interface com.zeroc.Ice.RouterPrx

Parameters:

b - If b is true, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. If b is false, the proxy prefers insecure endpoints to secure ones.

Returns:

A proxy with the specified selection policy.

ice_router

default RouterPrx ice_router(com.zeroc.Ice.RouterPrx router)

Returns a proxy that is identical to this proxy, except for the router.

Specified by:

ice_router in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_router in interface com.zeroc.Ice.RouterPrx

Parameters:

router - The router for the new proxy.

Returns:

A proxy with the specified router.

ice_locator

default RouterPrx ice_locator(com.zeroc.Ice.LocatorPrx locator)

Returns a proxy that is identical to this proxy, except for the locator.

Specified by:

ice_locator in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_locator in interface com.zeroc.Ice.RouterPrx

Parameters:

locator - The locator for the new proxy.

Returns:

A proxy with the specified locator.

ice_collocationOptimized

default RouterPrx ice_collocationOptimized(boolean b)

Returns a proxy that is identical to this proxy, except for collocation optimization.

Specified by:

ice_collocationOptimized in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_collocationOptimized in interface com.zeroc.Ice.RouterPrx

Parameters:

b - true if the new proxy enables collocation optimization; false otherwise.

Returns:

A proxy with the specified collocation optimization.

ice_twoway

default RouterPrx ice_twoway()

Returns a proxy that is identical to this proxy, but uses twoway invocations.

Specified by:

ice_twoway in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_twoway in interface com.zeroc.Ice.RouterPrx

Returns:

A proxy that uses twoway invocations.

ice_oneway

default RouterPrx ice_oneway()

Returns a proxy that is identical to this proxy, but uses oneway invocations.

Specified by:

ice_oneway in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_oneway in interface com.zeroc.Ice.RouterPrx

Returns:

A proxy that uses oneway invocations.

ice_batchOneway

default RouterPrx ice_batchOneway()

Returns a proxy that is identical to this proxy, but uses batch oneway invocations.

Specified by:

ice_batchOneway in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_batchOneway in interface com.zeroc.Ice.RouterPrx

Returns:

A proxy that uses batch oneway invocations.

ice_datagram

default RouterPrx ice_datagram()

Returns a proxy that is identical to this proxy, but uses datagram invocations.

Specified by:

ice_datagram in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_datagram in interface com.zeroc.Ice.RouterPrx

Returns:

A proxy that uses datagram invocations.

ice_batchDatagram

default RouterPrx ice_batchDatagram()

Returns a proxy that is identical to this proxy, but uses batch datagram invocations.

Specified by:

ice_batchDatagram in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_batchDatagram in interface com.zeroc.Ice.RouterPrx

Returns:

A proxy that uses batch datagram invocations.

ice_compress

default RouterPrx ice_compress(boolean co)

Returns a proxy that is identical to this proxy, except for compression.

Specified by:

ice_compress in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_compress in interface com.zeroc.Ice.RouterPrx

Parameters:

co - true enables compression for the new proxy; false disables compression.

Returns:

A proxy with the specified compression setting.

ice_timeout

default RouterPrx ice_timeout(int t)

Returns a proxy that is identical to this proxy, except for its connection timeout setting.

Specified by:

ice_timeout in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_timeout in interface com.zeroc.Ice.RouterPrx

Parameters:

t - The connection timeout for the proxy in milliseconds.

Returns:

A proxy with the specified timeout.

ice_connectionId

default RouterPrx ice_connectionId(String connectionId)

Returns a proxy that is identical to this proxy, except for its connection ID.

Specified by:

ice_connectionId in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_connectionId in interface com.zeroc.Ice.RouterPrx

Parameters:

connectionId - The connection ID for the new proxy. An empty string removes the connection ID.

Returns:

A proxy with the specified connection ID.

ice_fixed

default RouterPrx ice_fixed(com.zeroc.Ice.Connection connection)

Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy connection.

Specified by:

ice_fixed in interface com.zeroc.Ice.ObjectPrx

Specified by:

ice_fixed in interface com.zeroc.Ice.RouterPrx

Returns:

A fixed proxy bound to the given connection.

ice_staticId

static String ice_staticId()