Package com.zeroc.IceGrid

Interface SessionPrx

All Superinterfaces:
ObjectPrx, SessionPrx
public interface SessionPrx extends SessionPrx
A session object is used by IceGrid clients to allocate and release objects. Client sessions are created either via the Registry object or via the registry client SessionManager object.
See Also:

  • Method Details

    • keepAlive

      default void keepAlive()
      Keep the session alive. Clients should call this operation regularly to prevent the server from reaping the session.
      See Also:

    • keepAlive

      default void keepAlive(Map<String,String> context)
      Keep the session alive. Clients should call this operation regularly to prevent the server from reaping the session.
      Parameters:
      context - The Context map to send with the invocation.
      See Also:

    • keepAliveAsync

      default CompletableFuture<Void> keepAliveAsync()
      Keep the session alive. Clients should call this operation regularly to prevent the server from reaping the session.
      Returns:
      A future that will be completed when the invocation completes.
      See Also:

    • keepAliveAsync

      default CompletableFuture<Void> keepAliveAsync(Map<String,String> context)
      Keep the session alive. Clients should call this operation regularly to prevent the server from reaping the session.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.
      See Also:

    • allocateObjectById

      default ObjectPrx allocateObjectById(Identity id) throws AllocationException, ObjectNotRegisteredException
      Allocate an object. Depending on the allocation timeout, this operation might hang until the object is available or until the timeout is reached.
      Parameters:
      id - The identity of the object to allocate.
      Returns:
      The proxy of the allocated object.
      Throws:
      AllocationException - Raised if the object can't be allocated.
      ObjectNotRegisteredException - Raised if the object with the given identity is not registered with the registry.
      See Also:

    • allocateObjectById

      default ObjectPrx allocateObjectById(Identity id, Map<String,String> context) throws AllocationException, ObjectNotRegisteredException
      Allocate an object. Depending on the allocation timeout, this operation might hang until the object is available or until the timeout is reached.
      Parameters:
      id - The identity of the object to allocate.
      context - The Context map to send with the invocation.
      Returns:
      The proxy of the allocated object.
      Throws:
      AllocationException - Raised if the object can't be allocated.
      ObjectNotRegisteredException - Raised if the object with the given identity is not registered with the registry.
      See Also:

    • allocateObjectByIdAsync

      default CompletableFuture<ObjectPrx> allocateObjectByIdAsync(Identity id)
      Allocate an object. Depending on the allocation timeout, this operation might hang until the object is available or until the timeout is reached.
      Parameters:
      id - The identity of the object to allocate.
      Returns:
      The proxy of the allocated object.
      See Also:

    • allocateObjectByIdAsync

      default CompletableFuture<ObjectPrx> allocateObjectByIdAsync(Identity id, Map<String,String> context)
      Allocate an object. Depending on the allocation timeout, this operation might hang until the object is available or until the timeout is reached.
      Parameters:
      id - The identity of the object to allocate.
      context - The Context map to send with the invocation.
      Returns:
      The proxy of the allocated object.
      See Also:

    • allocateObjectByType

      default ObjectPrx allocateObjectByType(String type) throws AllocationException
      Allocate an object with the given type. Depending on the allocation timeout, this operation can block until an object becomes available or until the timeout is reached.
      Parameters:
      type - The type of the object.
      Returns:
      The proxy of the allocated object.
      Throws:
      AllocationException - Raised if the object could not be allocated.
      See Also:

    • allocateObjectByType

      default ObjectPrx allocateObjectByType(String type, Map<String,String> context) throws AllocationException
      Allocate an object with the given type. Depending on the allocation timeout, this operation can block until an object becomes available or until the timeout is reached.
      Parameters:
      type - The type of the object.
      context - The Context map to send with the invocation.
      Returns:
      The proxy of the allocated object.
      Throws:
      AllocationException - Raised if the object could not be allocated.
      See Also:

    • allocateObjectByTypeAsync

      default CompletableFuture<ObjectPrx> allocateObjectByTypeAsync(String type)
      Allocate an object with the given type. Depending on the allocation timeout, this operation can block until an object becomes available or until the timeout is reached.
      Parameters:
      type - The type of the object.
      Returns:
      The proxy of the allocated object.
      See Also:

    • allocateObjectByTypeAsync

      default CompletableFuture<ObjectPrx> allocateObjectByTypeAsync(String type, Map<String,String> context)
      Allocate an object with the given type. Depending on the allocation timeout, this operation can block until an object becomes available or until the timeout is reached.
      Parameters:
      type - The type of the object.
      context - The Context map to send with the invocation.
      Returns:
      The proxy of the allocated object.
      See Also:

    • releaseObject

      default void releaseObject(Identity id) throws AllocationException, ObjectNotRegisteredException
      Release an object that was allocated using allocateObjectById or allocateObjectByType.
      Parameters:
      id - The identity of the object to release.
      Throws:
      AllocationException - Raised if the given object can't be released. This might happen if the object isn't allocatable or isn't allocated by the session.
      ObjectNotRegisteredException - Raised if the object with the given identity is not registered with the registry.

    • releaseObject

      default void releaseObject(Identity id, Map<String,String> context) throws AllocationException, ObjectNotRegisteredException
      Release an object that was allocated using allocateObjectById or allocateObjectByType.
      Parameters:
      id - The identity of the object to release.
      context - The Context map to send with the invocation.
      Throws:
      AllocationException - Raised if the given object can't be released. This might happen if the object isn't allocatable or isn't allocated by the session.
      ObjectNotRegisteredException - Raised if the object with the given identity is not registered with the registry.

    • releaseObjectAsync

      default CompletableFuture<Void> releaseObjectAsync(Identity id)
      Release an object that was allocated using allocateObjectById or allocateObjectByType.
      Parameters:
      id - The identity of the object to release.
      Returns:
      A future that will be completed when the invocation completes.

    • releaseObjectAsync

      default CompletableFuture<Void> releaseObjectAsync(Identity id, Map<String,String> context)
      Release an object that was allocated using allocateObjectById or allocateObjectByType.
      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)
      Set the allocation timeout. If no objects are available for an allocation request, a call to allocateObjectById or allocateObjectByType will block for the duration of this timeout.
      Parameters:
      timeout - The timeout in milliseconds.

    • setAllocationTimeout

      default void setAllocationTimeout(int timeout, Map<String,String> context)
      Set the allocation timeout. If no objects are available for an allocation request, a call to allocateObjectById or allocateObjectByType will block for the duration of this timeout.
      Parameters:
      timeout - The timeout in milliseconds.
      context - The Context map to send with the invocation.

    • setAllocationTimeoutAsync

      default CompletableFuture<Void> setAllocationTimeoutAsync(int timeout)
      Set the allocation timeout. If no objects are available for an allocation request, a call to allocateObjectById or allocateObjectByType will block for the duration of this timeout.
      Parameters:
      timeout - The timeout in milliseconds.
      Returns:
      A future that will be completed when the invocation completes.

    • setAllocationTimeoutAsync

      default CompletableFuture<Void> setAllocationTimeoutAsync(int timeout, Map<String,String> context)
      Set the allocation timeout. If no objects are available for an allocation request, a call to allocateObjectById or allocateObjectByType will block for the duration of this timeout.
      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.

    • checkedCast

      static SessionPrx checkedCast(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 SessionPrx checkedCast(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 SessionPrx checkedCast(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 SessionPrx checkedCast(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 SessionPrx uncheckedCast(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 SessionPrx uncheckedCast(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 SessionPrx 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 ObjectPrx
      Specified by:
      ice_context in interface SessionPrx
      Parameters:
      newContext - The context for the new proxy.
      Returns:
      A proxy with the specified per-proxy context.

    • ice_adapterId

      default SessionPrx ice_adapterId(String newAdapterId)
      Returns a proxy that is identical to this proxy, except for the adapter ID.
      Specified by:
      ice_adapterId in interface ObjectPrx
      Specified by:
      ice_adapterId in interface SessionPrx
      Parameters:
      newAdapterId - The adapter ID for the new proxy.
      Returns:
      A proxy with the specified adapter ID.

    • ice_endpoints

      default SessionPrx ice_endpoints(Endpoint[] newEndpoints)
      Returns a proxy that is identical to this proxy, except for the endpoints.
      Specified by:
      ice_endpoints in interface ObjectPrx
      Specified by:
      ice_endpoints in interface SessionPrx
      Parameters:
      newEndpoints - The endpoints for the new proxy.
      Returns:
      A proxy with the specified endpoints.

    • ice_locatorCacheTimeout

      default SessionPrx 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 ObjectPrx
      Specified by:
      ice_locatorCacheTimeout in interface SessionPrx
      Parameters:
      newTimeout - The new locator cache timeout (in seconds).
      Returns:
      A proxy with the specified locator cache timeout.
      See Also:

    • ice_invocationTimeout

      default SessionPrx ice_invocationTimeout(int newTimeout)
      Returns a proxy that is identical to this proxy, except for the invocation timeout.
      Specified by:
      ice_invocationTimeout in interface ObjectPrx
      Specified by:
      ice_invocationTimeout in interface SessionPrx
      Parameters:
      newTimeout - The new invocation timeout (in milliseconds).
      Returns:
      A proxy with the specified invocation timeout.

    • ice_connectionCached

      default SessionPrx ice_connectionCached(boolean newCache)
      Returns a proxy that is identical to this proxy, except for connection caching.
      Specified by:
      ice_connectionCached in interface ObjectPrx
      Specified by:
      ice_connectionCached in interface SessionPrx
      Parameters:
      newCache - true if the new proxy should cache connections; false otherwise.
      Returns:
      A proxy with the specified caching policy.

    • ice_endpointSelection

      default SessionPrx ice_endpointSelection(EndpointSelectionType newType)
      Returns a proxy that is identical to this proxy, except for the endpoint selection policy.
      Specified by:
      ice_endpointSelection in interface ObjectPrx
      Specified by:
      ice_endpointSelection in interface SessionPrx
      Parameters:
      newType - The new endpoint selection policy.
      Returns:
      A proxy with the specified endpoint selection policy.
      See Also:

    • ice_secure

      default SessionPrx 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 ObjectPrx
      Specified by:
      ice_secure in interface SessionPrx
      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 SessionPrx ice_encodingVersion(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 ObjectPrx
      Specified by:
      ice_encodingVersion in interface SessionPrx
      Parameters:
      e - The encoding version to use to marshal request parameters.
      Returns:
      A proxy with the specified encoding version.

    • ice_preferSecure

      default SessionPrx 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 ObjectPrx
      Specified by:
      ice_preferSecure in interface SessionPrx
      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 SessionPrx ice_router(RouterPrx router)
      Returns a proxy that is identical to this proxy, except for the router.
      Specified by:
      ice_router in interface ObjectPrx
      Specified by:
      ice_router in interface SessionPrx
      Parameters:
      router - The router for the new proxy.
      Returns:
      A proxy with the specified router.

    • ice_locator

      default SessionPrx ice_locator(LocatorPrx locator)
      Returns a proxy that is identical to this proxy, except for the locator.
      Specified by:
      ice_locator in interface ObjectPrx
      Specified by:
      ice_locator in interface SessionPrx
      Parameters:
      locator - The locator for the new proxy.
      Returns:
      A proxy with the specified locator.

    • ice_collocationOptimized

      default SessionPrx ice_collocationOptimized(boolean b)
      Returns a proxy that is identical to this proxy, except for collocation optimization.
      Specified by:
      ice_collocationOptimized in interface ObjectPrx
      Specified by:
      ice_collocationOptimized in interface SessionPrx
      Parameters:
      b - true if the new proxy enables collocation optimization; false otherwise.
      Returns:
      A proxy with the specified collocation optimization.

    • ice_twoway

      default SessionPrx ice_twoway()
      Returns a proxy that is identical to this proxy, but uses twoway invocations.
      Specified by:
      ice_twoway in interface ObjectPrx
      Specified by:
      ice_twoway in interface SessionPrx
      Returns:
      A proxy that uses twoway invocations.

    • ice_oneway

      default SessionPrx ice_oneway()
      Returns a proxy that is identical to this proxy, but uses oneway invocations.
      Specified by:
      ice_oneway in interface ObjectPrx
      Specified by:
      ice_oneway in interface SessionPrx
      Returns:
      A proxy that uses oneway invocations.

    • ice_batchOneway

      default SessionPrx ice_batchOneway()
      Returns a proxy that is identical to this proxy, but uses batch oneway invocations.
      Specified by:
      ice_batchOneway in interface ObjectPrx
      Specified by:
      ice_batchOneway in interface SessionPrx
      Returns:
      A proxy that uses batch oneway invocations.

    • ice_datagram

      default SessionPrx ice_datagram()
      Returns a proxy that is identical to this proxy, but uses datagram invocations.
      Specified by:
      ice_datagram in interface ObjectPrx
      Specified by:
      ice_datagram in interface SessionPrx
      Returns:
      A proxy that uses datagram invocations.

    • ice_batchDatagram

      default SessionPrx ice_batchDatagram()
      Returns a proxy that is identical to this proxy, but uses batch datagram invocations.
      Specified by:
      ice_batchDatagram in interface ObjectPrx
      Specified by:
      ice_batchDatagram in interface SessionPrx
      Returns:
      A proxy that uses batch datagram invocations.

    • ice_compress

      default SessionPrx ice_compress(boolean co)
      Returns a proxy that is identical to this proxy, except for compression.
      Specified by:
      ice_compress in interface ObjectPrx
      Specified by:
      ice_compress in interface SessionPrx
      Parameters:
      co - true enables compression for the new proxy; false disables compression.
      Returns:
      A proxy with the specified compression setting.

    • ice_timeout

      default SessionPrx 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 ObjectPrx
      Specified by:
      ice_timeout in interface SessionPrx
      Parameters:
      t - The connection timeout for the proxy in milliseconds.
      Returns:
      A proxy with the specified timeout.

    • ice_connectionId

      default SessionPrx ice_connectionId(String connectionId)
      Returns a proxy that is identical to this proxy, except for its connection ID.
      Specified by:
      ice_connectionId in interface ObjectPrx
      Specified by:
      ice_connectionId in interface SessionPrx
      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 SessionPrx ice_fixed(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 ObjectPrx
      Specified by:
      ice_fixed in interface SessionPrx
      Parameters:
      connection - The fixed proxy connection.
      Returns:
      A fixed proxy bound to the given connection.

    • ice_staticId

      static String ice_staticId()
      Description copied from interface: ObjectPrx
      Returns the Slice type ID associated with this type.
      Returns:
      The Slice type ID.