Module com.zeroc.icegrid
Package com.zeroc.IceGrid

Interface RegistryPrx

All Superinterfaces:
ObjectPrx
public interface RegistryPrx extends ObjectPrx
Represents the main entry point into the IceGrid registry service. It provides operations to create sessions with the registry.

  • Method Details

    • createSession

      default SessionPrx createSession(String userId, String password) throws PermissionDeniedException
      Creates a client session.
      Parameters:
      userId - The user ID.
      password - The password for the given user.
      Returns:
      A proxy to the newly created session. This proxy is never null.
      Throws:
      PermissionDeniedException - Thrown when authentication or authorization fails.

    • createSession

      default SessionPrx createSession(String userId, String password, Map<String,String> context) throws PermissionDeniedException
      Creates a client session.
      Parameters:
      userId - The user ID.
      password - The password for the given user.
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the newly created session. This proxy is never null.
      Throws:
      PermissionDeniedException - Thrown when authentication or authorization fails.

    • createSessionAsync

      default CompletableFuture<SessionPrx> createSessionAsync(String userId, String password)
      Creates a client session.
      Parameters:
      userId - The user ID.
      password - The password for the given user.
      Returns:
      A proxy to the newly created session. This proxy is never null.

    • createSessionAsync

      default CompletableFuture<SessionPrx> createSessionAsync(String userId, String password, Map<String,String> context)
      Creates a client session.
      Parameters:
      userId - The user ID.
      password - The password for the given user.
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the newly created session. This proxy is never null.

    • createAdminSession

      default AdminSessionPrx createAdminSession(String userId, String password) throws PermissionDeniedException
      Creates an administrative session.
      Parameters:
      userId - The user ID.
      password - The password for the given user.
      Returns:
      A proxy to the newly created session. This proxy is never null.
      Throws:
      PermissionDeniedException - Thrown when authentication or authorization fails.

    • createAdminSession

      default AdminSessionPrx createAdminSession(String userId, String password, Map<String,String> context) throws PermissionDeniedException
      Creates an administrative session.
      Parameters:
      userId - The user ID.
      password - The password for the given user.
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the newly created session. This proxy is never null.
      Throws:
      PermissionDeniedException - Thrown when authentication or authorization fails.

    • createAdminSessionAsync

      default CompletableFuture<AdminSessionPrx> createAdminSessionAsync(String userId, String password)
      Creates an administrative session.
      Parameters:
      userId - The user ID.
      password - The password for the given user.
      Returns:
      A proxy to the newly created session. This proxy is never null.

    • createAdminSessionAsync

      default CompletableFuture<AdminSessionPrx> createAdminSessionAsync(String userId, String password, Map<String,String> context)
      Creates an administrative session.
      Parameters:
      userId - The user ID.
      password - The password for the given user.
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the newly created session. This proxy is never null.

    • createSessionFromSecureConnection

      default SessionPrx createSessionFromSecureConnection() throws PermissionDeniedException
      Creates a client session from a secure connection.
      Returns:
      A proxy to the newly created session. This proxy is never null.
      Throws:
      PermissionDeniedException - Thrown when authentication or authorization fails.

    • createSessionFromSecureConnection

      default SessionPrx createSessionFromSecureConnection(Map<String,String> context) throws PermissionDeniedException
      Creates a client session from a secure connection.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the newly created session. This proxy is never null.
      Throws:
      PermissionDeniedException - Thrown when authentication or authorization fails.

    • createSessionFromSecureConnectionAsync

      default CompletableFuture<SessionPrx> createSessionFromSecureConnectionAsync()
      Creates a client session from a secure connection.
      Returns:
      A proxy to the newly created session. This proxy is never null.

    • createSessionFromSecureConnectionAsync

      default CompletableFuture<SessionPrx> createSessionFromSecureConnectionAsync(Map<String,String> context)
      Creates a client session from a secure connection.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the newly created session. This proxy is never null.

    • createAdminSessionFromSecureConnection

      default AdminSessionPrx createAdminSessionFromSecureConnection() throws PermissionDeniedException
      Creates an administrative session from a secure connection.
      Returns:
      A proxy to the newly created session. This proxy is never null.
      Throws:
      PermissionDeniedException - Thrown when authentication or authorization fails.

    • createAdminSessionFromSecureConnection

      default AdminSessionPrx createAdminSessionFromSecureConnection(Map<String,String> context) throws PermissionDeniedException
      Creates an administrative session from a secure connection.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the newly created session. This proxy is never null.
      Throws:
      PermissionDeniedException - Thrown when authentication or authorization fails.

    • createAdminSessionFromSecureConnectionAsync

      default CompletableFuture<AdminSessionPrx> createAdminSessionFromSecureConnectionAsync()
      Creates an administrative session from a secure connection.
      Returns:
      A proxy to the newly created session. This proxy is never null.

    • createAdminSessionFromSecureConnectionAsync

      default CompletableFuture<AdminSessionPrx> createAdminSessionFromSecureConnectionAsync(Map<String,String> context)
      Creates an administrative session from a secure connection.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to the newly created session. This proxy is never null.

    • getSessionTimeout

      default int getSessionTimeout()
      Gets the session timeout. An Ice 3.7 or earlier client can use this value to determine how often it needs to send heartbeats (using ACM) or call SessionPrx.keepAlive() (resp. AdminSessionPrx.keepAlive()) to keep a session alive in the IceGrid registry.
      Returns:
      The session timeout (in seconds).

    • getSessionTimeout

      default int getSessionTimeout(Map<String,String> context)
      Gets the session timeout. An Ice 3.7 or earlier client can use this value to determine how often it needs to send heartbeats (using ACM) or call SessionPrx.keepAlive() (resp. AdminSessionPrx.keepAlive()) to keep a session alive in the IceGrid registry.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The session timeout (in seconds).

    • getSessionTimeoutAsync

      default CompletableFuture<Integer> getSessionTimeoutAsync()
      Gets the session timeout. An Ice 3.7 or earlier client can use this value to determine how often it needs to send heartbeats (using ACM) or call SessionPrx.keepAlive() (resp. AdminSessionPrx.keepAlive()) to keep a session alive in the IceGrid registry.
      Returns:
      The session timeout (in seconds).

    • getSessionTimeoutAsync

      default CompletableFuture<Integer> getSessionTimeoutAsync(Map<String,String> context)
      Gets the session timeout. An Ice 3.7 or earlier client can use this value to determine how often it needs to send heartbeats (using ACM) or call SessionPrx.keepAlive() (resp. AdminSessionPrx.keepAlive()) to keep a session alive in the IceGrid registry.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The session timeout (in seconds).

    • createProxy

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

    • checkedCast

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

      RegistryPrx ice_context(Map<String,String> newContext)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the per-proxy context.
      Specified by:
      ice_context in interface ObjectPrx
      Parameters:
      newContext - The context for the new proxy.
      Returns:
      A proxy with the new per-proxy context.

    • ice_adapterId

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

    • ice_endpoints

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

    • ice_locatorCacheTimeout

      RegistryPrx ice_locatorCacheTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the locator cache timeout.
      Specified by:
      ice_locatorCacheTimeout in interface ObjectPrx
      Parameters:
      newTimeout - The new locator cache timeout (in seconds).
      Returns:
      A proxy with the new timeout.
      See Also:

    • ice_invocationTimeout

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

    • ice_invocationTimeout

      RegistryPrx ice_invocationTimeout(Duration newTimeout)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the invocation timeout.
      Specified by:
      ice_invocationTimeout in interface ObjectPrx
      Parameters:
      newTimeout - The new invocation timeout.
      Returns:
      The proxy with the new timeout.

    • ice_connectionCached

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

    • ice_endpointSelection

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

    • ice_encodingVersion

      RegistryPrx ice_encodingVersion(EncodingVersion e)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
      Specified by:
      ice_encodingVersion in interface ObjectPrx
      Parameters:
      e - The encoding version to use to marshal request parameters.
      Returns:
      The proxy with the specified encoding version.

    • ice_router

      RegistryPrx ice_router(RouterPrx router)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the router.
      Specified by:
      ice_router in interface ObjectPrx
      Parameters:
      router - The router for the new proxy.
      Returns:
      The proxy with the specified router.

    • ice_locator

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

    • ice_collocationOptimized

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

    • ice_twoway

      RegistryPrx ice_twoway()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses twoway invocations.
      Specified by:
      ice_twoway in interface ObjectPrx
      Returns:
      A proxy that uses twoway invocations.

    • ice_oneway

      RegistryPrx ice_oneway()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses oneway invocations.
      Specified by:
      ice_oneway in interface ObjectPrx
      Returns:
      A proxy that uses oneway invocations.

    • ice_batchOneway

      RegistryPrx ice_batchOneway()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses batch oneway invocations.
      Specified by:
      ice_batchOneway in interface ObjectPrx
      Returns:
      A proxy that uses batch oneway invocations.

    • ice_datagram

      RegistryPrx ice_datagram()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses datagram invocations.
      Specified by:
      ice_datagram in interface ObjectPrx
      Returns:
      A proxy that uses datagram invocations.

    • ice_batchDatagram

      RegistryPrx ice_batchDatagram()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses batch datagram invocations.
      Specified by:
      ice_batchDatagram in interface ObjectPrx
      Returns:
      A proxy that uses batch datagram invocations.

    • ice_compress

      RegistryPrx ice_compress(boolean co)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
      Specified by:
      ice_compress in interface ObjectPrx
      Parameters:
      co - true enables compression for the new proxy; false disables compression.
      Returns:
      A proxy with the specified compression setting.

    • ice_connectionId

      RegistryPrx ice_connectionId(String connectionId)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for its connection ID.
      Specified by:
      ice_connectionId in interface ObjectPrx
      Parameters:
      connectionId - The connection ID for the new proxy. An empty string removes the connection ID.
      Returns:
      A proxy with the specified connection ID.

    • ice_fixed

      RegistryPrx ice_fixed(Connection connection)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
      Specified by:
      ice_fixed in interface ObjectPrx
      Parameters:
      connection - The fixed proxy connection.
      Returns:
      A fixed proxy bound to the given connection.

    • ice_staticId

      static String ice_staticId()
      Gets the type ID of the associated Slice interface.
      Returns:
      the string "::IceGrid::Registry"