Module com.zeroc.glacier2

Package com.zeroc.Glacier2

Interface SessionPrx

All Superinterfaces:

ObjectPrx

All Known Subinterfaces:

AdminSessionPrx, SessionPrx

public interface SessionPrx
extends ObjectPrx

Represents a session between a client application and the Glacier2 router. With Glacier2, the lifetime of a session is tied to the Ice connection between the client and the router: the session is destroyed when the connection is closed.

See Also:

• Router
• SessionManager

Field Summary

Fields inherited from interface com.zeroc.Ice.ObjectPrx

ice_staticId, noExplicitContext

Method Summary

Modifier and Type	Method	Description
static SessionPrx	checkedCast(ObjectPrx obj)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static SessionPrx	checkedCast(ObjectPrx obj, String facet)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static SessionPrx	checkedCast(ObjectPrx obj, String facet, Map<String,String> context)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static SessionPrx	checkedCast(ObjectPrx obj, Map<String,String> context)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static SessionPrx	createProxy(Communicator communicator, String proxyString)	Creates a new proxy that implements SessionPrx.
default void	destroy()	Destroys this session.
default void	destroy(Map<String,String> context)	Destroys this session.
default CompletableFuture<Void>	destroyAsync()	Destroys this session.
default CompletableFuture<Void>	destroyAsync(Map<String,String> context)	Destroys this session.
SessionPrx	ice_adapterId(String newAdapterId)	Creates a new proxy that is identical to this proxy, except for the adapter ID.
SessionPrx	ice_batchDatagram()	Creates a new proxy that is identical to this proxy, but uses batch datagram invocations.
SessionPrx	ice_batchOneway()	Creates a new proxy that is identical to this proxy, but uses batch oneway invocations.
SessionPrx	ice_collocationOptimized(boolean b)	Returns a proxy that is identical to this proxy, except for collocation optimization.
SessionPrx	ice_compress(boolean co)	Returns a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
SessionPrx	ice_connectionCached(boolean newCache)	Returns a proxy that is identical to this proxy, except for connection caching.
SessionPrx	ice_connectionId(String connectionId)	Returns a proxy that is identical to this proxy, except for its connection ID.
SessionPrx	ice_context(Map<String,String> newContext)	Creates a new proxy that is identical to this proxy, except for the per-proxy context.
SessionPrx	ice_datagram()	Creates a new proxy that is identical to this proxy, but uses datagram invocations.
SessionPrx	ice_encodingVersion(EncodingVersion e)	Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
SessionPrx	ice_endpoints(Endpoint[] newEndpoints)	Creates a new proxy that is identical to this proxy, except for the endpoints.
SessionPrx	ice_endpointSelection(EndpointSelectionType newType)	Returns a proxy that is identical to this proxy, except for the endpoint selection policy.
SessionPrx	ice_fixed(Connection connection)	Creates a new proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
SessionPrx	ice_invocationTimeout(int newTimeout)	Returns a proxy that is identical to this proxy, except for the invocation timeout.
SessionPrx	ice_invocationTimeout(Duration newTimeout)	Returns a proxy that is identical to this proxy, except for the invocation timeout.
SessionPrx	ice_locator(LocatorPrx locator)	Returns a proxy that is identical to this proxy, except for the locator.
SessionPrx	ice_locatorCacheTimeout(int newTimeout)	Creates a new proxy that is identical to this proxy, except for the locator cache timeout.
SessionPrx	ice_oneway()	Creates a new proxy that is identical to this proxy, but uses oneway invocations.
SessionPrx	ice_router(RouterPrx router)	Returns a proxy that is identical to this proxy, except for the router.
static String	ice_staticId()	Gets the type ID of the associated Slice interface.
SessionPrx	ice_twoway()	Creates a new proxy that is identical to this proxy, but uses twoway invocations.
static SessionPrx	uncheckedCast(ObjectPrx obj)	Creates a new proxy from an existing proxy.
static SessionPrx	uncheckedCast(ObjectPrx obj, String facet)	Creates a new proxy from an existing proxy.

Methods inherited from interface com.zeroc.Ice.ObjectPrx

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_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_isTwoway, ice_locatorCacheTimeout, ice_ping, ice_ping, ice_pingAsync, ice_pingAsync

Method Details

destroy

default void destroy()

Destroys this session.

destroy

default void destroy(Map<String,String> context)

Destroys this session.

Parameters:

context - The Context map to send with the invocation.

destroyAsync

default CompletableFuture<Void> destroyAsync()

Destroys this session.

Returns:

A future that will be completed when the invocation completes.

destroyAsync

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

Destroys this session.

Parameters:

context - The Context map to send with the invocation.

Returns:

A future that will be completed when the invocation completes.

createProxy

static SessionPrx createProxy(Communicator communicator,
 String proxyString)

Creates a new proxy that implements SessionPrx.

Parameters:

communicator - The communicator of the new proxy.

proxyString - The string representation of the proxy.

Returns:

The new proxy.

checkedCast

static SessionPrx checkedCast(ObjectPrx obj)

Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.

Parameters:

obj - The source proxy.

Returns:

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

checkedCast

static SessionPrx checkedCast(ObjectPrx obj,
 Map<String,String> context)

Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.

Parameters:

obj - The source proxy.

context - The Context map to send with the invocation.

Returns:

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

checkedCast

static SessionPrx checkedCast(ObjectPrx obj,
 String facet)

Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.

Parameters:

obj - The source proxy.

facet - The name of the desired facet.

Returns:

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

checkedCast

static SessionPrx checkedCast(ObjectPrx obj,
 String facet,
 Map<String,String> context)

Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.

Parameters:

obj - The source proxy.

facet - The name of the desired facet.

context - The Context map to send with the invocation.

Returns:

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

uncheckedCast

static SessionPrx uncheckedCast(ObjectPrx obj)

Creates a new proxy from an existing proxy.

Parameters:

obj - The untyped proxy.

Returns:

A new proxy for this type.

uncheckedCast

static SessionPrx uncheckedCast(ObjectPrx obj,
 String facet)

Creates a new proxy from an existing proxy.

Parameters:

obj - The untyped proxy.

facet - The name of the desired facet.

Returns:

A new proxy for this type.

ice_context

SessionPrx ice_context(Map<String,String> newContext)

Description copied from interface: ObjectPrx

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

Specified by:

ice_context in interface ObjectPrx

Parameters:

newContext - The context for the new proxy.

Returns:

A proxy with the new per-proxy context.

ice_adapterId

SessionPrx ice_adapterId(String newAdapterId)

Description copied from interface: ObjectPrx

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

Specified by:

ice_adapterId in interface ObjectPrx

Parameters:

newAdapterId - The adapter ID for the new proxy.

Returns:

A proxy with the new adapter ID.

ice_endpoints

SessionPrx ice_endpoints(Endpoint[] newEndpoints)

Description copied from interface: ObjectPrx

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

Specified by:

ice_endpoints in interface ObjectPrx

Parameters:

newEndpoints - The endpoints for the new proxy.

Returns:

A proxy with the new endpoints.

ice_locatorCacheTimeout

SessionPrx ice_locatorCacheTimeout(int newTimeout)

Description copied from interface: ObjectPrx

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

Specified by:

ice_locatorCacheTimeout in interface ObjectPrx

Parameters:

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

Returns:

A proxy with the new timeout.

See Also:

• Locator

ice_invocationTimeout

SessionPrx ice_invocationTimeout(int newTimeout)

Description copied from interface: ObjectPrx

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

Specified by:

ice_invocationTimeout in interface ObjectPrx

Parameters:

newTimeout - The new invocation timeout (in milliseconds).

Returns:

The proxy with the new timeout.

ice_invocationTimeout

SessionPrx ice_invocationTimeout(Duration newTimeout)

Description copied from interface: ObjectPrx

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

Specified by:

ice_invocationTimeout in interface ObjectPrx

Parameters:

newTimeout - The new invocation timeout.

Returns:

The proxy with the new timeout.

ice_connectionCached

SessionPrx ice_connectionCached(boolean newCache)

Description copied from interface: ObjectPrx

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

Specified by:

ice_connectionCached in interface ObjectPrx

Parameters:

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

Returns:

The proxy with the specified caching policy.

ice_endpointSelection

SessionPrx ice_endpointSelection(EndpointSelectionType newType)

Description copied from interface: ObjectPrx

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

Specified by:

ice_endpointSelection in interface ObjectPrx

Parameters:

newType - The new endpoint selection policy.

Returns:

The proxy with the specified endpoint selection policy.

See Also:

• EndpointSelectionType

ice_encodingVersion

SessionPrx ice_encodingVersion(EncodingVersion e)

Description copied from interface: ObjectPrx

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

Specified by:

ice_encodingVersion in interface ObjectPrx

Parameters:

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

Returns:

The proxy with the specified encoding version.

ice_router

SessionPrx ice_router(RouterPrx router)

Description copied from interface: ObjectPrx

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

Specified by:

ice_router in interface ObjectPrx

Parameters:

router - The router for the new proxy.

Returns:

The proxy with the specified router.

ice_locator

SessionPrx ice_locator(LocatorPrx locator)

Description copied from interface: ObjectPrx

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

Specified by:

ice_locator in interface ObjectPrx

Parameters:

locator - The locator for the new proxy.

Returns:

The proxy with the specified locator.

ice_collocationOptimized

SessionPrx ice_collocationOptimized(boolean b)

Description copied from interface: ObjectPrx

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

Specified by:

ice_collocationOptimized in interface ObjectPrx

Parameters:

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

Returns:

The proxy with the specified collocation optimization.

ice_twoway

SessionPrx ice_twoway()

Description copied from interface: ObjectPrx

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

Specified by:

ice_twoway in interface ObjectPrx

Returns:

A proxy that uses twoway invocations.

ice_oneway

SessionPrx ice_oneway()

Description copied from interface: ObjectPrx

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

Specified by:

ice_oneway in interface ObjectPrx

Returns:

A proxy that uses oneway invocations.

ice_batchOneway

SessionPrx ice_batchOneway()

Description copied from interface: ObjectPrx

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

Specified by:

ice_batchOneway in interface ObjectPrx

Returns:

A proxy that uses batch oneway invocations.

ice_datagram

SessionPrx ice_datagram()

Description copied from interface: ObjectPrx

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

Specified by:

ice_datagram in interface ObjectPrx

Returns:

A proxy that uses datagram invocations.

ice_batchDatagram

SessionPrx ice_batchDatagram()

Description copied from interface: ObjectPrx

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

Specified by:

ice_batchDatagram in interface ObjectPrx

Returns:

A proxy that uses batch datagram invocations.

ice_compress

SessionPrx ice_compress(boolean co)

Description copied from interface: ObjectPrx

Returns a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.

Specified by:

ice_compress in interface ObjectPrx

Parameters:

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

Returns:

A proxy with the specified compression setting.

ice_connectionId

SessionPrx ice_connectionId(String connectionId)

Description copied from interface: ObjectPrx

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

Specified by:

ice_connectionId in interface ObjectPrx

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

SessionPrx ice_fixed(Connection connection)

Description copied from interface: ObjectPrx

Creates a new proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.

Specified by:

ice_fixed in interface ObjectPrx

Parameters:

connection - The fixed proxy connection.

Returns:

A fixed proxy bound to the given connection.

ice_staticId

static String ice_staticId()

Gets the type ID of the associated Slice interface.

Returns:

the string "::Glacier2::Session"