- 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.
Remarks:
The Slice compiler generated this proxy interface from Slice interface ::IceGrid::Session.
-
Field Summary
Fields inherited from interface com.zeroc.Ice.ObjectPrx
ice_staticId, noExplicitContext -
Method Summary
Modifier and TypeMethodDescriptiondefault ObjectPrxAllocates an object.default ObjectPrxallocateObjectById(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 ObjectPrxallocateObjectByType(String type) Allocates an object with the given type.default ObjectPrxallocateObjectByType(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 SessionPrxcheckedCast(ObjectPrx obj) Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.static SessionPrxcheckedCast(ObjectPrx obj, String facet) Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.static SessionPrxCreates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.static SessionPrxcheckedCast(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 SessionPrxcreateProxy(Communicator communicator, String proxyString) Creates a new proxy that implementsSessionPrx.ice_adapterId(String newAdapterId) Creates a proxy that is identical to this proxy, except for the adapter ID.Creates a proxy that is identical to this proxy, but uses batch datagram invocations.Creates a proxy that is identical to this proxy, but uses batch oneway invocations.ice_collocationOptimized(boolean b) Creates a proxy that is identical to this proxy, except for collocation optimization.ice_compress(boolean co) Creates 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) Creates a proxy that is identical to this proxy, except for connection caching.ice_connectionId(String connectionId) Creates a proxy that is identical to this proxy, except for its connection ID.ice_context(Map<String, String> newContext) Creates a proxy that is identical to this proxy, except for the per-proxy context.Creates a proxy that is identical to this proxy, but uses datagram invocations.Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.ice_endpoints(Endpoint[] newEndpoints) Creates a proxy that is identical to this proxy, except for the endpoints.Creates a proxy that is identical to this proxy, except for the endpoint selection policy.ice_fixed(Connection connection) Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.ice_invocationTimeout(int newTimeout) Creates a proxy that is identical to this proxy, except for the invocation timeout.ice_invocationTimeout(Duration newTimeout) Creates a proxy that is identical to this proxy, except for the invocation timeout.ice_locator(LocatorPrx locator) Creates a proxy that is identical to this proxy, except for the locator.ice_locatorCacheTimeout(int newTimeout) Creates a proxy that is identical to this proxy, except for the locator cache timeout.Creates a proxy that is identical to this proxy, but uses oneway invocations.ice_router(RouterPrx router) Creates a proxy that is identical to this proxy, except for the router.static StringGets the type ID of the associated Slice interface.Creates a proxy that is identical to this proxy, but uses twoway invocations.default voidKeeps the session alive.default voidKeeps the session alive.default CompletableFuture<Void>Keeps the session alive.default CompletableFuture<Void>keepAliveAsync(Map<String, String> context) Keeps the session alive.default voidReleases an object that was allocated usingallocateObjectById(com.zeroc.Ice.Identity)orallocateObjectByType(java.lang.String).default voidreleaseObject(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 voidsetAllocationTimeout(int timeout) Sets the allocation timeout.default voidsetAllocationTimeout(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 SessionPrxuncheckedCast(ObjectPrx obj) Creates a new proxy from an existing proxy.static SessionPrxuncheckedCast(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_pingAsyncMethods 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 proxyproxyString- 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.- Parameters:
obj- the source proxy- Returns:
- a proxy for this type, or
nullif the target 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.- Parameters:
obj- the source proxycontext- the Context map to send with the invocation- Returns:
- a new proxy for this type, or
nullif the target 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.- Parameters:
obj- the source proxyfacet- the name of the desired facet- Returns:
- a new proxy for this type, or
nullif 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.- Parameters:
obj- the source proxyfacet- the name of the desired facetcontext- the Context map to send with the invocation- Returns:
- a new proxy for this type, or
nullif the target object does not support this type.
-
uncheckedCast
Creates a new proxy from an existing proxy.- Parameters:
obj- the source proxy- Returns:
- a new proxy with this type or
nullifobjisnull
-
uncheckedCast
Creates a new proxy from an existing proxy.- Parameters:
obj- the source proxyfacet- the name of the desired facet- Returns:
- a new proxy with this type or
nullifobjisnull
-
ice_context
Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, except for the per-proxy context.- Specified by:
ice_contextin interfaceObjectPrx- Specified by:
ice_contextin interfaceSessionPrx- Parameters:
newContext- the context for the new proxy- Returns:
- a proxy with the new per-proxy context
-
ice_adapterId
Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, except for the adapter ID.- Specified by:
ice_adapterIdin interfaceObjectPrx- Specified by:
ice_adapterIdin interfaceSessionPrx- Parameters:
newAdapterId- the adapter ID for the new proxy- Returns:
- a proxy with the new adapter ID
-
ice_endpoints
Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, except for the endpoints.- Specified by:
ice_endpointsin interfaceObjectPrx- Specified by:
ice_endpointsin interfaceSessionPrx- Parameters:
newEndpoints- the endpoints for the new proxy- Returns:
- a proxy with the new endpoints
-
ice_locatorCacheTimeout
Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, except for the locator cache timeout.- Specified by:
ice_locatorCacheTimeoutin interfaceObjectPrx- Specified by:
ice_locatorCacheTimeoutin 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:ObjectPrxCreates a proxy that is identical to this proxy, except for the invocation timeout.- Specified by:
ice_invocationTimeoutin interfaceObjectPrx- Specified by:
ice_invocationTimeoutin interfaceSessionPrx- Parameters:
newTimeout- the new invocation timeout (in milliseconds)- Returns:
- a proxy with the new timeout
-
ice_invocationTimeout
Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, except for the invocation timeout.- Specified by:
ice_invocationTimeoutin interfaceObjectPrx- Specified by:
ice_invocationTimeoutin interfaceSessionPrx- Parameters:
newTimeout- the new invocation timeout- Returns:
- a proxy with the new timeout
-
ice_connectionCached
Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, except for connection caching.- Specified by:
ice_connectionCachedin interfaceObjectPrx- Specified by:
ice_connectionCachedin interfaceSessionPrx- Parameters:
newCache-trueif the new proxy should cache connections,falseotherwise- Returns:
- a proxy with the specified caching policy
-
ice_endpointSelection
Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, except for the endpoint selection policy.- Specified by:
ice_endpointSelectionin interfaceObjectPrx- Specified by:
ice_endpointSelectionin interfaceSessionPrx- Parameters:
newType- the new endpoint selection policy- Returns:
- a proxy with the specified endpoint selection policy
-
ice_encodingVersion
Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.- Specified by:
ice_encodingVersionin interfaceObjectPrx- Specified by:
ice_encodingVersionin interfaceSessionPrx- Parameters:
e- the encoding version to use to marshal request parameters- Returns:
- a proxy with the specified encoding version
-
ice_router
Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, except for the router.- Specified by:
ice_routerin interfaceObjectPrx- Specified by:
ice_routerin interfaceSessionPrx- Parameters:
router- the router for the new proxy- Returns:
- a proxy with the specified router
-
ice_locator
Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, except for the locator.- Specified by:
ice_locatorin interfaceObjectPrx- Specified by:
ice_locatorin interfaceSessionPrx- Parameters:
locator- the locator for the new proxy- Returns:
- a proxy with the specified locator
-
ice_collocationOptimized
Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, except for collocation optimization.- Specified by:
ice_collocationOptimizedin interfaceObjectPrx- Specified by:
ice_collocationOptimizedin interfaceSessionPrx- Parameters:
b-trueif the new proxy enables collocation optimization,falseotherwise- Returns:
- a proxy with the specified collocation optimization
-
ice_twoway
SessionPrx ice_twoway()Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, but uses twoway invocations.- Specified by:
ice_twowayin interfaceObjectPrx- Specified by:
ice_twowayin interfaceSessionPrx- Returns:
- a proxy that uses twoway invocations
-
ice_oneway
SessionPrx ice_oneway()Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, but uses oneway invocations.- Specified by:
ice_onewayin interfaceObjectPrx- Specified by:
ice_onewayin interfaceSessionPrx- Returns:
- a proxy that uses oneway invocations
-
ice_batchOneway
SessionPrx ice_batchOneway()Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, but uses batch oneway invocations.- Specified by:
ice_batchOnewayin interfaceObjectPrx- Specified by:
ice_batchOnewayin interfaceSessionPrx- Returns:
- a proxy that uses batch oneway invocations
-
ice_datagram
SessionPrx ice_datagram()Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, but uses datagram invocations.- Specified by:
ice_datagramin interfaceObjectPrx- Specified by:
ice_datagramin interfaceSessionPrx- Returns:
- a proxy that uses datagram invocations
-
ice_batchDatagram
SessionPrx ice_batchDatagram()Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, but uses batch datagram invocations.- Specified by:
ice_batchDatagramin interfaceObjectPrx- Specified by:
ice_batchDatagramin interfaceSessionPrx- Returns:
- a proxy that uses batch datagram invocations
-
ice_compress
Description copied from interface:ObjectPrxCreates 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_compressin interfaceObjectPrx- Specified by:
ice_compressin interfaceSessionPrx- Parameters:
co-trueenables compression for the new proxy,falsedisables compression.- Returns:
- a proxy with the specified compression override setting
-
ice_connectionId
Description copied from interface:ObjectPrxCreates a proxy that is identical to this proxy, except for its connection ID.- Specified by:
ice_connectionIdin interfaceObjectPrx- Specified by:
ice_connectionIdin 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:ObjectPrxCreates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.- Specified by:
ice_fixedin interfaceObjectPrx- Specified by:
ice_fixedin 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"
-