Interface RouterPrx

All Superinterfaces:
ObjectPrx, RouterPrx

public interface RouterPrx extends RouterPrx
The Glacier2 specialization of the RouterPrx interface.
  • Method Details

    • getCategoryForClient

      default String getCategoryForClient()
      Gets a unique category that identifies the client (caller) in the router. This category must be used in the identities of all the client's callback objects.
      Returns:
      The category. It's an empty string when Glacier2.Server.Endpoints is not configured.
    • getCategoryForClient

      default String getCategoryForClient(Map<String,String> context)
      Gets a unique category that identifies the client (caller) in the router. This category must be used in the identities of all the client's callback objects.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The category. It's an empty string when Glacier2.Server.Endpoints is not configured.
    • getCategoryForClientAsync

      default CompletableFuture<String> getCategoryForClientAsync()
      Gets a unique category that identifies the client (caller) in the router. This category must be used in the identities of all the client's callback objects.
      Returns:
      The category. It's an empty string when Glacier2.Server.Endpoints is not configured.
    • getCategoryForClientAsync

      default CompletableFuture<String> getCategoryForClientAsync(Map<String,String> context)
      Gets a unique category that identifies the client (caller) in the router. This category must be used in the identities of all the client's callback objects.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The category. It's an empty string when Glacier2.Server.Endpoints is not configured.
    • createSession

      default SessionPrx createSession(String userId, String password) throws PermissionDeniedException, CannotCreateSessionException
      Creates a session for the client (caller) with the router. If a SessionManagerPrx is configured, a proxy to a SessionPrx 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 non-null session proxy is returned, it must be configured to route through the router that created it. This occurs automatically when the router is configured as the client's default router at the time the session proxy is created in the client application; otherwise, the client must configure the session proxy explicitly.
      Parameters:
      userId - The user ID.
      password - The password.
      Returns:
      A proxy for the newly created session, or null if no SessionManagerPrx is configured.
      Throws:
      CannotCreateSessionException - Thrown when the session cannot be created.
      PermissionDeniedException - Thrown when an authentication or authorization failure occurs.
      See Also:
    • createSession

      default SessionPrx createSession(String userId, String password, Map<String,String> context) throws PermissionDeniedException, CannotCreateSessionException
      Creates a session for the client (caller) with the router. If a SessionManagerPrx is configured, a proxy to a SessionPrx 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 non-null session proxy is returned, it must be configured to route through the router that created it. This occurs automatically when the router is configured as the client's default router at the time the session proxy is created in the client application; otherwise, the client must configure the session proxy explicitly.
      Parameters:
      userId - The user ID.
      password - The password.
      context - The Context map to send with the invocation.
      Returns:
      A proxy for the newly created session, or null if no SessionManagerPrx is configured.
      Throws:
      CannotCreateSessionException - Thrown when the session cannot be created.
      PermissionDeniedException - Thrown when an authentication or authorization failure occurs.
      See Also:
    • createSessionAsync

      default CompletableFuture<SessionPrx> createSessionAsync(String userId, String password)
      Creates a session for the client (caller) with the router. If a SessionManagerPrx is configured, a proxy to a SessionPrx 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 non-null session proxy is returned, it must be configured to route through the router that created it. This occurs automatically when the router is configured as the client's default router at the time the session proxy is created in the client application; otherwise, the client must configure the session proxy explicitly.
      Parameters:
      userId - The user ID.
      password - The password.
      Returns:
      A proxy for the newly created session, or null if no SessionManagerPrx is configured.
      See Also:
    • createSessionAsync

      default CompletableFuture<SessionPrx> createSessionAsync(String userId, String password, Map<String,String> context)
      Creates a session for the client (caller) with the router. If a SessionManagerPrx is configured, a proxy to a SessionPrx 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 non-null session proxy is returned, it must be configured to route through the router that created it. This occurs automatically when the router is configured as the client's default router at the time the session proxy is created in the client application; otherwise, the client must configure the session proxy explicitly.
      Parameters:
      userId - The user ID.
      password - The password.
      context - The Context map to send with the invocation.
      Returns:
      A proxy for the newly created session, or null if no SessionManagerPrx is configured.
      See Also:
    • createSessionFromSecureConnection

      default SessionPrx createSessionFromSecureConnection() throws PermissionDeniedException, CannotCreateSessionException
      Creates a per-client session with the router. The user is authenticated through the SSL certificate(s) associated with the connection. If an SSLSessionManagerPrx is configured, a proxy to a SessionPrx 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 non-null session proxy is returned, it must be configured to route through the router that created it. This occurs automatically when the router is configured as the client's default router at the time the session proxy is created in the client application; otherwise, the client must configure the session proxy explicitly.
      Returns:
      A proxy for the newly created session, or null if no SSLSessionManagerPrx is configured.
      Throws:
      CannotCreateSessionException - Thrown when the session cannot be created.
      PermissionDeniedException - Thrown when an authentication or authorization failure occurs.
      See Also:
    • createSessionFromSecureConnection

      default SessionPrx createSessionFromSecureConnection(Map<String,String> context) throws PermissionDeniedException, CannotCreateSessionException
      Creates a per-client session with the router. The user is authenticated through the SSL certificate(s) associated with the connection. If an SSLSessionManagerPrx is configured, a proxy to a SessionPrx 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 non-null session proxy is returned, it must be configured to route through the router that created it. This occurs automatically when the router is configured as the client's default router at the time the session proxy is created in the client application; 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 SSLSessionManagerPrx is configured.
      Throws:
      CannotCreateSessionException - Thrown when the session cannot be created.
      PermissionDeniedException - Thrown when an authentication or authorization failure occurs.
      See Also:
    • createSessionFromSecureConnectionAsync

      default CompletableFuture<SessionPrx> createSessionFromSecureConnectionAsync()
      Creates a per-client session with the router. The user is authenticated through the SSL certificate(s) associated with the connection. If an SSLSessionManagerPrx is configured, a proxy to a SessionPrx 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 non-null session proxy is returned, it must be configured to route through the router that created it. This occurs automatically when the router is configured as the client's default router at the time the session proxy is created in the client application; otherwise, the client must configure the session proxy explicitly.
      Returns:
      A proxy for the newly created session, or null if no SSLSessionManagerPrx is configured.
      See Also:
    • createSessionFromSecureConnectionAsync

      default CompletableFuture<SessionPrx> createSessionFromSecureConnectionAsync(Map<String,String> context)
      Creates a per-client session with the router. The user is authenticated through the SSL certificate(s) associated with the connection. If an SSLSessionManagerPrx is configured, a proxy to a SessionPrx 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 non-null session proxy is returned, it must be configured to route through the router that created it. This occurs automatically when the router is configured as the client's default router at the time the session proxy is created in the client application; 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 SSLSessionManagerPrx is configured.
      See Also:
    • refreshSession

      default void refreshSession() throws SessionNotExistException
      Keeps the session with this router alive.
      Throws:
      SessionNotExistException - Thrown when no session exists for the caller (client).
    • refreshSession

      default void refreshSession(Map<String,String> context) throws SessionNotExistException
      Keeps the session with this router alive.
      Parameters:
      context - The Context map to send with the invocation.
      Throws:
      SessionNotExistException - Thrown when no session exists for the caller (client).
    • refreshSessionAsync

      default CompletableFuture<Void> refreshSessionAsync()
      Keeps the 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)
      Keeps the 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
      Destroys the session of the caller with this router.
      Throws:
      SessionNotExistException - Thrown when no session exists for the caller (client).
    • destroySession

      default void destroySession(Map<String,String> context) throws SessionNotExistException
      Destroys the session of the caller with this router.
      Parameters:
      context - The Context map to send with the invocation.
      Throws:
      SessionNotExistException - Thrown when no session exists for the caller (client).
    • destroySessionAsync

      default CompletableFuture<Void> destroySessionAsync()
      Destroys the session of the caller with this router.
      Returns:
      A future that will be completed when the invocation completes.
    • destroySessionAsync

      default CompletableFuture<Void> destroySessionAsync(Map<String,String> context)
      Destroys the session of the caller 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()
      Gets the idle timeout used by the server-side of the connection.
      Returns:
      The idle timeout (in seconds).
    • getSessionTimeout

      default long getSessionTimeout(Map<String,String> context)
      Gets the idle timeout used by the server-side of the connection.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The idle timeout (in seconds).
    • getSessionTimeoutAsync

      default CompletableFuture<Long> getSessionTimeoutAsync()
      Gets the idle timeout used by the server-side of the connection.
      Returns:
      The idle timeout (in seconds).
    • getSessionTimeoutAsync

      default CompletableFuture<Long> getSessionTimeoutAsync(Map<String,String> context)
      Gets the idle timeout used by the server-side of the connection.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The idle timeout (in seconds).
    • getACMTimeout

      default int getACMTimeout()
      Gets the idle timeout used by the server-side of the connection.
      Returns:
      The idle timeout (in seconds).
    • getACMTimeout

      default int getACMTimeout(Map<String,String> context)
      Gets the idle timeout used by the server-side of the connection.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The idle timeout (in seconds).
    • getACMTimeoutAsync

      default CompletableFuture<Integer> getACMTimeoutAsync()
      Gets the idle timeout used by the server-side of the connection.
      Returns:
      The idle timeout (in seconds).
    • getACMTimeoutAsync

      default CompletableFuture<Integer> getACMTimeoutAsync(Map<String,String> context)
      Gets the idle timeout used by the server-side of the connection.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The idle timeout (in seconds).
    • createProxy

      static RouterPrx createProxy(Communicator communicator, String proxyString)
      Creates a new proxy that implements RouterPrx.
      Parameters:
      communicator - The communicator of the new proxy.
      proxyString - The string representation of the proxy.
      Returns:
      The new proxy.
    • checkedCast

      static RouterPrx 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 RouterPrx 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 RouterPrx 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 RouterPrx 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 RouterPrx 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 RouterPrx 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

      RouterPrx 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
      Specified by:
      ice_context in interface RouterPrx
      Parameters:
      newContext - The context for the new proxy.
      Returns:
      A proxy with the new per-proxy context.
    • ice_adapterId

      RouterPrx 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
      Specified by:
      ice_adapterId in interface RouterPrx
      Parameters:
      newAdapterId - The adapter ID for the new proxy.
      Returns:
      A proxy with the new adapter ID.
    • ice_endpoints

      RouterPrx 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
      Specified by:
      ice_endpoints in interface RouterPrx
      Parameters:
      newEndpoints - The endpoints for the new proxy.
      Returns:
      A proxy with the new endpoints.
    • ice_locatorCacheTimeout

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

      RouterPrx 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
      Specified by:
      ice_invocationTimeout in interface RouterPrx
      Parameters:
      newTimeout - The new invocation timeout (in milliseconds).
      Returns:
      The proxy with the new timeout.
    • ice_invocationTimeout

      RouterPrx 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
      Specified by:
      ice_invocationTimeout in interface RouterPrx
      Parameters:
      newTimeout - The new invocation timeout.
      Returns:
      The proxy with the new timeout.
    • ice_connectionCached

      RouterPrx 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
      Specified by:
      ice_connectionCached in interface RouterPrx
      Parameters:
      newCache - true if the new proxy should cache connections; false otherwise.
      Returns:
      The proxy with the specified caching policy.
    • ice_endpointSelection

      RouterPrx 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
      Specified by:
      ice_endpointSelection in interface RouterPrx
      Parameters:
      newType - The new endpoint selection policy.
      Returns:
      The proxy with the specified endpoint selection policy.
      See Also:
    • ice_encodingVersion

      RouterPrx 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
      Specified by:
      ice_encodingVersion in interface RouterPrx
      Parameters:
      e - The encoding version to use to marshal request parameters.
      Returns:
      The proxy with the specified encoding version.
    • ice_router

      RouterPrx 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
      Specified by:
      ice_router in interface RouterPrx
      Parameters:
      router - The router for the new proxy.
      Returns:
      The proxy with the specified router.
    • ice_locator

      RouterPrx 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
      Specified by:
      ice_locator in interface RouterPrx
      Parameters:
      locator - The locator for the new proxy.
      Returns:
      The proxy with the specified locator.
    • ice_collocationOptimized

      RouterPrx 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
      Specified by:
      ice_collocationOptimized in interface RouterPrx
      Parameters:
      b - true if the new proxy enables collocation optimization; false otherwise.
      Returns:
      The proxy with the specified collocation optimization.
    • ice_twoway

      RouterPrx 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
      Specified by:
      ice_twoway in interface RouterPrx
      Returns:
      A proxy that uses twoway invocations.
    • ice_oneway

      RouterPrx 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
      Specified by:
      ice_oneway in interface RouterPrx
      Returns:
      A proxy that uses oneway invocations.
    • ice_batchOneway

      RouterPrx 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
      Specified by:
      ice_batchOneway in interface RouterPrx
      Returns:
      A proxy that uses batch oneway invocations.
    • ice_datagram

      RouterPrx 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
      Specified by:
      ice_datagram in interface RouterPrx
      Returns:
      A proxy that uses datagram invocations.
    • ice_batchDatagram

      RouterPrx 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
      Specified by:
      ice_batchDatagram in interface RouterPrx
      Returns:
      A proxy that uses batch datagram invocations.
    • ice_compress

      RouterPrx 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
      Specified by:
      ice_compress in interface RouterPrx
      Parameters:
      co - true enables compression for the new proxy; false disables compression.
      Returns:
      A proxy with the specified compression setting.
    • ice_connectionId

      RouterPrx 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
      Specified by:
      ice_connectionId in interface 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

      RouterPrx 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
      Specified by:
      ice_fixed in interface RouterPrx
      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::Router"