- All Superinterfaces:
ObjectPrx
,SessionPrx
Represents a session object used by IceGrid clients to allocate and release objects. Client sessions are created
either via the
RegistryPrx
object or via the registry client SessionManagerPrx
object.-
Field Summary
Fields inherited from interface com.zeroc.Ice.ObjectPrx
ice_staticId, noExplicitContext
-
Method Summary
Modifier and TypeMethodDescriptiondefault ObjectPrx
Allocates an object.default ObjectPrx
allocateObjectById
(Identity id, Map<String, String> context) Allocates an object.default CompletableFuture<ObjectPrx>
Allocates an object.default CompletableFuture<ObjectPrx>
allocateObjectByIdAsync
(Identity id, Map<String, String> context) Allocates an object.default ObjectPrx
allocateObjectByType
(String type) Allocates an object with the given type.default ObjectPrx
allocateObjectByType
(String type, Map<String, String> context) Allocates an object with the given type.default CompletableFuture<ObjectPrx>
Allocates an object with the given type.default CompletableFuture<ObjectPrx>
allocateObjectByTypeAsync
(String type, Map<String, String> context) Allocates an object with the given type.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
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 implementsSessionPrx
.ice_adapterId
(String newAdapterId) Creates a new proxy that is identical to this proxy, except for the adapter ID.Creates a new proxy that is identical to this proxy, but uses batch datagram invocations.Creates a new proxy that is identical to this proxy, but uses batch oneway invocations.ice_collocationOptimized
(boolean b) Returns a proxy that is identical to this proxy, except for collocation optimization.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.ice_connectionCached
(boolean newCache) Returns a proxy that is identical to this proxy, except for connection caching.ice_connectionId
(String connectionId) Returns a proxy that is identical to this proxy, except for its connection ID.ice_context
(Map<String, String> newContext) Creates a new proxy that is identical to this proxy, except for the per-proxy context.Creates a new proxy that is identical to this proxy, but uses datagram invocations.Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.ice_endpoints
(Endpoint[] newEndpoints) Creates a new proxy that is identical to this proxy, except for the endpoints.Returns a proxy that is identical to this proxy, except for the endpoint selection policy.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.ice_invocationTimeout
(int newTimeout) Returns a proxy that is identical to this proxy, except for the invocation timeout.ice_invocationTimeout
(Duration newTimeout) Returns a proxy that is identical to this proxy, except for the invocation timeout.ice_locator
(LocatorPrx locator) Returns a proxy that is identical to this proxy, except for the locator.ice_locatorCacheTimeout
(int newTimeout) Creates a new proxy that is identical to this proxy, except for the locator cache timeout.Creates a new proxy that is identical to this proxy, but uses oneway invocations.ice_router
(RouterPrx router) Returns a proxy that is identical to this proxy, except for the router.static String
Gets the type ID of the associated Slice interface.Creates a new proxy that is identical to this proxy, but uses twoway invocations.default void
Keeps the session alive.default void
Keeps the session alive.default CompletableFuture<Void>
Keeps the session alive.default CompletableFuture<Void>
keepAliveAsync
(Map<String, String> context) Keeps the session alive.default void
Releases an object that was allocated usingallocateObjectById(com.zeroc.Ice.Identity)
orallocateObjectByType(java.lang.String)
.default void
releaseObject
(Identity id, Map<String, String> context) Releases an object that was allocated usingallocateObjectById(com.zeroc.Ice.Identity)
orallocateObjectByType(java.lang.String)
.default CompletableFuture<Void>
Releases an object that was allocated usingallocateObjectById(com.zeroc.Ice.Identity)
orallocateObjectByType(java.lang.String)
.default CompletableFuture<Void>
releaseObjectAsync
(Identity id, Map<String, String> context) Releases an object that was allocated usingallocateObjectById(com.zeroc.Ice.Identity)
orallocateObjectByType(java.lang.String)
.default void
setAllocationTimeout
(int timeout) Sets the allocation timeout.default void
setAllocationTimeout
(int timeout, Map<String, String> context) Sets the allocation timeout.default CompletableFuture<Void>
setAllocationTimeoutAsync
(int timeout) Sets the allocation timeout.default CompletableFuture<Void>
setAllocationTimeoutAsync
(int timeout, Map<String, String> context) Sets the allocation timeout.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
Methods inherited from interface com.zeroc.Glacier2.SessionPrx
destroy, destroy, destroyAsync, destroyAsync
-
Method Details
-
keepAlive
default void keepAlive()Keeps the session alive. -
keepAlive
Keeps the session alive.- Parameters:
context
- The Context map to send with the invocation.
-
keepAliveAsync
Keeps the session alive.- Returns:
- A future that will be completed when the invocation completes.
-
keepAliveAsync
Keeps the session alive.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
-
allocateObjectById
default ObjectPrx allocateObjectById(Identity id) throws ObjectNotRegisteredException, AllocationException Allocates an object.- Parameters:
id
- The identity of the object to allocate.- Returns:
- A proxy to the allocated object. This proxy is never null.
- Throws:
AllocationException
- Thrown when the allocation fails.ObjectNotRegisteredException
- Thrown when an object with the given identity is not registered with the registry.- See Also:
-
allocateObjectById
default ObjectPrx allocateObjectById(Identity id, Map<String, String> context) throws ObjectNotRegisteredException, AllocationExceptionAllocates an object.- Parameters:
id
- The identity of the object to allocate.context
- The Context map to send with the invocation.- Returns:
- A proxy to the allocated object. This proxy is never null.
- Throws:
AllocationException
- Thrown when the allocation fails.ObjectNotRegisteredException
- Thrown when an object with the given identity is not registered with the registry.- See Also:
-
allocateObjectByIdAsync
Allocates an object.- Parameters:
id
- The identity of the object to allocate.- Returns:
- A proxy to the allocated object. This proxy is never null.
- See Also:
-
allocateObjectByIdAsync
default CompletableFuture<ObjectPrx> allocateObjectByIdAsync(Identity id, Map<String, String> context) Allocates an object.- Parameters:
id
- The identity of the object to allocate.context
- The Context map to send with the invocation.- Returns:
- A proxy to the allocated object. This proxy is never null.
- See Also:
-
allocateObjectByType
Allocates an object with the given type.- Parameters:
type
- The type of the object.- Returns:
- A proxy to the allocated object. This proxy is never null.
- Throws:
AllocationException
- Thrown when the allocation fails.- See Also:
-
allocateObjectByType
default ObjectPrx allocateObjectByType(String type, Map<String, String> context) throws AllocationExceptionAllocates an object with the given type.- Parameters:
type
- The type of the object.context
- The Context map to send with the invocation.- Returns:
- A proxy to the allocated object. This proxy is never null.
- Throws:
AllocationException
- Thrown when the allocation fails.- See Also:
-
allocateObjectByTypeAsync
Allocates an object with the given type.- Parameters:
type
- The type of the object.- Returns:
- A proxy to the allocated object. This proxy is never null.
- See Also:
-
allocateObjectByTypeAsync
default CompletableFuture<ObjectPrx> allocateObjectByTypeAsync(String type, Map<String, String> context) Allocates an object with the given type.- Parameters:
type
- The type of the object.context
- The Context map to send with the invocation.- Returns:
- A proxy to the allocated object. This proxy is never null.
- See Also:
-
releaseObject
Releases an object that was allocated usingallocateObjectById(com.zeroc.Ice.Identity)
orallocateObjectByType(java.lang.String)
.- Parameters:
id
- The identity of the object to release.- Throws:
AllocationException
- Thrown when the object can't be released. This can happen when the object is not allocatable or is not allocated by this session.ObjectNotRegisteredException
- Thrown when an object with the given identity is not registered with the registry.
-
releaseObject
default void releaseObject(Identity id, Map<String, String> context) throws ObjectNotRegisteredException, AllocationExceptionReleases an object that was allocated usingallocateObjectById(com.zeroc.Ice.Identity)
orallocateObjectByType(java.lang.String)
.- Parameters:
id
- The identity of the object to release.context
- The Context map to send with the invocation.- Throws:
AllocationException
- Thrown when the object can't be released. This can happen when the object is not allocatable or is not allocated by this session.ObjectNotRegisteredException
- Thrown when an object with the given identity is not registered with the registry.
-
releaseObjectAsync
Releases an object that was allocated usingallocateObjectById(com.zeroc.Ice.Identity)
orallocateObjectByType(java.lang.String)
.- Parameters:
id
- The identity of the object to release.- Returns:
- A future that will be completed when the invocation completes.
-
releaseObjectAsync
Releases an object that was allocated usingallocateObjectById(com.zeroc.Ice.Identity)
orallocateObjectByType(java.lang.String)
.- Parameters:
id
- The identity of the object to release.context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
-
setAllocationTimeout
default void setAllocationTimeout(int timeout) Sets the allocation timeout. When no object is immediately available for an allocation request, the implementation ofallocateObjectById(com.zeroc.Ice.Identity)
andallocateObjectByType(java.lang.String)
waits for the duration of thistimeout
.- Parameters:
timeout
- The timeout in milliseconds.
-
setAllocationTimeout
Sets the allocation timeout. When no object is immediately available for an allocation request, the implementation ofallocateObjectById(com.zeroc.Ice.Identity)
andallocateObjectByType(java.lang.String)
waits for the duration of thistimeout
.- Parameters:
timeout
- The timeout in milliseconds.context
- The Context map to send with the invocation.
-
setAllocationTimeoutAsync
Sets the allocation timeout. When no object is immediately available for an allocation request, the implementation ofallocateObjectById(com.zeroc.Ice.Identity)
andallocateObjectByType(java.lang.String)
waits for the duration of thistimeout
.- Parameters:
timeout
- The timeout in milliseconds.- Returns:
- A future that will be completed when the invocation completes.
-
setAllocationTimeoutAsync
Sets the allocation timeout. When no object is immediately available for an allocation request, the implementation ofallocateObjectById(com.zeroc.Ice.Identity)
andallocateObjectByType(java.lang.String)
waits for the duration of thistimeout
.- Parameters:
timeout
- The timeout in milliseconds.context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
-
createProxy
Creates a new proxy that implementsSessionPrx
.- Parameters:
communicator
- The communicator of the new proxy.proxyString
- The string representation of the proxy.- Returns:
- The new proxy.
-
checkedCast
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
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
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
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
Creates a new proxy from an existing proxy.- Parameters:
obj
- The untyped proxy.- Returns:
- A new proxy for this type.
-
uncheckedCast
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
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 interfaceObjectPrx
- Specified by:
ice_context
in interfaceSessionPrx
- Parameters:
newContext
- The context for the new proxy.- Returns:
- A proxy with the new per-proxy context.
-
ice_adapterId
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 interfaceObjectPrx
- Specified by:
ice_adapterId
in interfaceSessionPrx
- Parameters:
newAdapterId
- The adapter ID for the new proxy.- Returns:
- A proxy with the new adapter ID.
-
ice_endpoints
Description copied from interface:ObjectPrx
Creates a new proxy that is identical to this proxy, except for the endpoints.- Specified by:
ice_endpoints
in interfaceObjectPrx
- Specified by:
ice_endpoints
in interfaceSessionPrx
- Parameters:
newEndpoints
- The endpoints for the new proxy.- Returns:
- A proxy with the new endpoints.
-
ice_locatorCacheTimeout
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 interfaceObjectPrx
- Specified by:
ice_locatorCacheTimeout
in interfaceSessionPrx
- Parameters:
newTimeout
- The new locator cache timeout (in seconds).- Returns:
- A proxy with the new timeout.
- See Also:
-
ice_invocationTimeout
Description copied from interface:ObjectPrx
Returns a proxy that is identical to this proxy, except for the invocation timeout.- Specified by:
ice_invocationTimeout
in interfaceObjectPrx
- Specified by:
ice_invocationTimeout
in interfaceSessionPrx
- Parameters:
newTimeout
- The new invocation timeout (in milliseconds).- Returns:
- The proxy with the new timeout.
-
ice_invocationTimeout
Description copied from interface:ObjectPrx
Returns a proxy that is identical to this proxy, except for the invocation timeout.- Specified by:
ice_invocationTimeout
in interfaceObjectPrx
- Specified by:
ice_invocationTimeout
in interfaceSessionPrx
- Parameters:
newTimeout
- The new invocation timeout.- Returns:
- The proxy with the new timeout.
-
ice_connectionCached
Description copied from interface:ObjectPrx
Returns a proxy that is identical to this proxy, except for connection caching.- Specified by:
ice_connectionCached
in interfaceObjectPrx
- Specified by:
ice_connectionCached
in interfaceSessionPrx
- Parameters:
newCache
-true
if the new proxy should cache connections;false
otherwise.- Returns:
- The proxy with the specified caching policy.
-
ice_endpointSelection
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 interfaceObjectPrx
- Specified by:
ice_endpointSelection
in interfaceSessionPrx
- Parameters:
newType
- The new endpoint selection policy.- Returns:
- The proxy with the specified endpoint selection policy.
- See Also:
-
ice_encodingVersion
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 interfaceObjectPrx
- Specified by:
ice_encodingVersion
in interfaceSessionPrx
- Parameters:
e
- The encoding version to use to marshal request parameters.- Returns:
- The proxy with the specified encoding version.
-
ice_router
Description copied from interface:ObjectPrx
Returns a proxy that is identical to this proxy, except for the router.- Specified by:
ice_router
in interfaceObjectPrx
- Specified by:
ice_router
in interfaceSessionPrx
- Parameters:
router
- The router for the new proxy.- Returns:
- The proxy with the specified router.
-
ice_locator
Description copied from interface:ObjectPrx
Returns a proxy that is identical to this proxy, except for the locator.- Specified by:
ice_locator
in interfaceObjectPrx
- Specified by:
ice_locator
in interfaceSessionPrx
- Parameters:
locator
- The locator for the new proxy.- Returns:
- The proxy with the specified locator.
-
ice_collocationOptimized
Description copied from interface:ObjectPrx
Returns a proxy that is identical to this proxy, except for collocation optimization.- Specified by:
ice_collocationOptimized
in interfaceObjectPrx
- Specified by:
ice_collocationOptimized
in interfaceSessionPrx
- 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 interfaceObjectPrx
- Specified by:
ice_twoway
in interfaceSessionPrx
- 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 interfaceObjectPrx
- Specified by:
ice_oneway
in interfaceSessionPrx
- 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 interfaceObjectPrx
- Specified by:
ice_batchOneway
in interfaceSessionPrx
- 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 interfaceObjectPrx
- Specified by:
ice_datagram
in interfaceSessionPrx
- 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 interfaceObjectPrx
- Specified by:
ice_batchDatagram
in interfaceSessionPrx
- Returns:
- A proxy that uses batch datagram invocations.
-
ice_compress
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 interfaceObjectPrx
- Specified by:
ice_compress
in interfaceSessionPrx
- Parameters:
co
-true
enables compression for the new proxy;false
disables compression.- Returns:
- A proxy with the specified compression setting.
-
ice_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 interfaceObjectPrx
- Specified by:
ice_connectionId
in interfaceSessionPrx
- 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
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 interfaceObjectPrx
- Specified by:
ice_fixed
in interfaceSessionPrx
- Parameters:
connection
- The fixed proxy connection.- Returns:
- A fixed proxy bound to the given connection.
-
ice_staticId
Gets the type ID of the associated Slice interface.- Returns:
- the string "::IceGrid::Session"
-