Package com.zeroc.Ice

Interface ObjectPrx

All Known Subinterfaces:
AdapterObserverPrx, AdminPrx, AdminSessionPrx, ApplicationObserverPrx, FileIteratorPrx, FileParserPrx, FileServerPrx, FinderPrx, IdentitySetPrx, LocatorFinderPrx, LocatorPrx, LocatorPrx, LocatorRegistryPrx, LoggerAdminPrx, MetricsAdminPrx, NodeObserverPrx, ObjectObserverPrx, PermissionsVerifierPrx, ProcessPrx, PropertiesAdminPrx, QueryPrx, RegistryObserverPrx, RegistryPrx, RemoteLoggerPrx, RouterFinderPrx, RouterPrx, RouterPrx, ServiceManagerPrx, ServiceObserverPrx, SessionControlPrx, SessionManagerPrx, SessionPrx, SessionPrx, SSLPermissionsVerifierPrx, SSLSessionManagerPrx, StringSetPrx, TopicManagerPrx, TopicPrx, UserAccountMapperPrx
public interface ObjectPrx
Base interface of all object proxies.

  • Field Details

    • ice_staticId

      static final String ice_staticId
      The type ID of the target's interface: "::Ice::Object".
      See Also:

    • noExplicitContext

      static final Map<String,String> noExplicitContext
      A special empty context that is indistinguishable from the absence of a context parameter. For example, prx.op(noExplicitContext) is the same as prx.op() and does not override the current implicit context (if any).

  • Method Details

    • ice_getCommunicator

      Communicator ice_getCommunicator()
      Returns the communicator that created this proxy.
      Returns:
      The communicator that created this proxy.

    • ice_isA

      boolean ice_isA(String id)
      Tests whether this object supports a specific Slice interface.
      Parameters:
      id - The type ID of the Slice interface to test against.
      Returns:
      true if the target object has the interface specified by id or derives from the interface specified by id.

    • ice_isA

      boolean ice_isA(String id, Map<String,String> context)
      Tests whether this object supports a specific Slice interface.
      Parameters:
      id - The type ID of the Slice interface to test against.
      context - The context map for the invocation.
      Returns:
      true if the target object has the interface specified by id or derives from the interface specified by id.

    • ice_isAAsync

      CompletableFuture<Boolean> ice_isAAsync(String id)
      Tests whether this object supports a specific Slice interface.
      Parameters:
      id - The type ID of the Slice interface to test against.
      Returns:
      A future for the completion of the request.

    • ice_isAAsync

      CompletableFuture<Boolean> ice_isAAsync(String id, Map<String,String> context)
      Tests whether this object supports a specific Slice interface.
      Parameters:
      id - The type ID of the Slice interface to test against.
      context - The context map for the invocation.
      Returns:
      A future for the completion of the request.

    • ice_ping

      void ice_ping()
      Tests whether the target object of this proxy can be reached.

    • ice_ping

      void ice_ping(Map<String,String> context)
      Tests whether the target object of this proxy can be reached.
      Parameters:
      context - The context map for the invocation.

    • ice_pingAsync

      CompletableFuture<Void> ice_pingAsync()
      Tests whether the target object of this proxy can be reached.
      Returns:
      A future for the completion of the request.

    • ice_pingAsync

      CompletableFuture<Void> ice_pingAsync(Map<String,String> context)
      Tests whether the target object of this proxy can be reached.
      Parameters:
      context - The context map for the invocation.
      Returns:
      A future for the completion of the request.

    • ice_ids

      String[] ice_ids()
      Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
      Returns:
      The Slice type IDs of the interfaces supported by the target object, in base-to-derived order. The first element of the returned array is always ::Ice::Object.

    • ice_ids

      String[] ice_ids(Map<String,String> context)
      Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
      Parameters:
      context - The context map for the invocation.
      Returns:
      The Slice type IDs of the interfaces supported by the target object, in base-to-derived order. The first element of the returned array is always ::Ice::Object.

    • ice_idsAsync

      CompletableFuture<String[]> ice_idsAsync()
      Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
      Returns:
      A future for the completion of the request.

    • ice_idsAsync

      CompletableFuture<String[]> ice_idsAsync(Map<String,String> context)
      Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
      Parameters:
      context - The context map for the invocation.
      Returns:
      A future for the completion of the request.

    • ice_id

      String ice_id()
      Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
      Returns:
      The Slice type ID of the most-derived interface.

    • ice_id

      String ice_id(Map<String,String> context)
      Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
      Parameters:
      context - The context map for the invocation.
      Returns:
      The Slice type ID of the most-derived interface.

    • ice_idAsync

      CompletableFuture<String> ice_idAsync()
      Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
      Returns:
      A future for the completion of the request.

    • ice_idAsync

      CompletableFuture<String> ice_idAsync(Map<String,String> context)
      Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
      Parameters:
      context - The context map for the invocation.
      Returns:
      A future for the completion of the request.

    • ice_invoke

      Object.Ice_invokeResult ice_invoke(String operation, OperationMode mode, byte[] inParams)
      Invokes an operation dynamically.
      Parameters:
      operation - The name of the operation to invoke.
      mode - The operation mode (normal or idempotent).
      inParams - The encoded in-parameters for the operation.
      Returns:
      The results of the invocation.
      See Also:

    • ice_invoke

      Object.Ice_invokeResult ice_invoke(String operation, OperationMode mode, byte[] inParams, Map<String,String> context)
      Invokes an operation dynamically.
      Parameters:
      operation - The name of the operation to invoke.
      mode - The operation mode (normal or idempotent).
      inParams - The encoded in-parameters for the operation.
      context - The context map for the invocation.
      Returns:
      The results of the invocation.
      See Also:

    • ice_invokeAsync

      CompletableFuture<Object.Ice_invokeResult> ice_invokeAsync(String operation, OperationMode mode, byte[] inParams)
      Invokes an operation dynamically and asynchronously.
      Parameters:
      operation - The name of the operation to invoke.
      mode - The operation mode (normal or idempotent).
      inParams - The encoded in-parameters for the operation.
      Returns:
      A future for the completion of the request.
      See Also:

    • ice_invokeAsync

      CompletableFuture<Object.Ice_invokeResult> ice_invokeAsync(String operation, OperationMode mode, byte[] inParams, Map<String,String> context)
      Invokes an operation dynamically and asynchronously.
      Parameters:
      operation - The name of the operation to invoke.
      mode - The operation mode (normal or idempotent).
      inParams - The encoded in-parameters for the operation. for the operation. The return value follows any out-parameters.
      context - The context map for the invocation.
      Returns:
      A future for the completion of the request.
      See Also:

    • ice_getIdentity

      Identity ice_getIdentity()
      Returns the identity embedded in this proxy.
      Returns:
      The identity of the target object.

    • ice_identity

      ObjectPrx ice_identity(Identity newIdentity)
      Returns a proxy that is identical to this proxy, except for the identity.
      Parameters:
      newIdentity - The identity for the new proxy.
      Returns:
      The proxy with the new identity.

    • ice_getContext

      Map<String,String> ice_getContext()
      Returns the per-proxy context for this proxy.
      Returns:
      The per-proxy context. If the proxy does not have a per-proxy (implicit) context, the return value is null.

    • ice_context

      default ObjectPrx ice_context(Map<String,String> newContext)
      Returns a proxy that is identical to this proxy, except for the per-proxy context.
      Parameters:
      newContext - The context for the new proxy.
      Returns:
      The proxy with the new per-proxy context.

    • ice_getFacet

      String ice_getFacet()
      Returns the facet for this proxy.
      Returns:
      The facet for this proxy. If the proxy uses the default facet, the return value is the empty string.

    • ice_facet

      ObjectPrx ice_facet(String newFacet)
      Returns a proxy that is identical to this proxy, except for the facet.
      Parameters:
      newFacet - The facet for the new proxy.
      Returns:
      The proxy with the new facet.

    • ice_getAdapterId

      String ice_getAdapterId()
      Returns the adapter ID for this proxy.
      Returns:
      The adapter ID. If the proxy does not have an adapter ID, the return value is the empty string.

    • ice_adapterId

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

    • ice_getEndpoints

      Endpoint[] ice_getEndpoints()
      Returns the endpoints used by this proxy.
      Returns:
      The endpoints used by this proxy.
      See Also:

    • ice_endpoints

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

    • ice_getLocatorCacheTimeout

      int ice_getLocatorCacheTimeout()
      Returns the locator cache timeout of this proxy.
      Returns:
      The locator cache timeout value (in seconds).
      See Also:

    • ice_getInvocationTimeout

      int ice_getInvocationTimeout()
      Returns the invocation timeout of this proxy.
      Returns:
      The invocation timeout value (in milliseconds).

    • ice_getConnectionId

      String ice_getConnectionId()
      Returns the connection id of this proxy.
      Returns:
      The connection id.

    • ice_fixed

      default ObjectPrx ice_fixed(Connection connection)
      Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.
      Parameters:
      connection - The fixed proxy connection.
      Returns:
      A fixed proxy bound to the given connection.

    • ice_isFixed

      boolean ice_isFixed()
      Returns whether this proxy is a fixed proxy.
      Returns:
      true if this is a fixed proxy, false otherwise.

    • ice_locatorCacheTimeout

      default ObjectPrx ice_locatorCacheTimeout(int newTimeout)
      Returns a proxy that is identical to this proxy, except for the locator cache timeout.
      Parameters:
      newTimeout - The new locator cache timeout (in seconds).
      Returns:
      The proxy with the new timeout.
      See Also:

    • ice_invocationTimeout

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

    • ice_isConnectionCached

      boolean ice_isConnectionCached()
      Returns whether this proxy caches connections.
      Returns:
      true if this proxy caches connections; false otherwise.

    • ice_connectionCached

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

    • ice_getEndpointSelection

      EndpointSelectionType ice_getEndpointSelection()
      Returns how this proxy selects endpoints (randomly or ordered).
      Returns:
      The endpoint selection policy.
      See Also:

    • ice_endpointSelection

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

    • ice_isSecure

      boolean ice_isSecure()
      Returns whether this proxy uses only secure endpoints.
      Returns:
      True if this proxy communicates only via secure endpoints; false otherwise.

    • ice_secure

      default ObjectPrx ice_secure(boolean b)
      Returns a proxy that is identical to this proxy, except for how it selects endpoints.
      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:
      The proxy with the specified selection policy.

    • ice_encodingVersion

      default ObjectPrx ice_encodingVersion(EncodingVersion e)
      Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
      Parameters:
      e - The encoding version to use to marshal request parameters.
      Returns:
      The proxy with the specified encoding version.

    • ice_getEncodingVersion

      EncodingVersion ice_getEncodingVersion()
      Returns the encoding version used to marshal request parameters.
      Returns:
      The encoding version.

    • ice_isPreferSecure

      boolean ice_isPreferSecure()
      Returns whether this proxy prefers secure endpoints.
      Returns:
      true if the proxy always attempts to invoke via secure endpoints before it attempts to use insecure endpoints; false otherwise.

    • ice_preferSecure

      default ObjectPrx ice_preferSecure(boolean b)
      Returns a proxy that is identical to this proxy, except for its endpoint selection policy.
      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:
      The proxy with the specified selection policy.

    • ice_getRouter

      RouterPrx ice_getRouter()
      Returns the router for this proxy.
      Returns:
      The router for the proxy. If no router is configured for the proxy, the return value is null.

    • ice_router

      default ObjectPrx ice_router(RouterPrx router)
      Returns a proxy that is identical to this proxy, except for the router.
      Parameters:
      router - The router for the new proxy.
      Returns:
      The proxy with the specified router.

    • ice_getLocator

      LocatorPrx ice_getLocator()
      Returns the locator for this proxy.
      Returns:
      The locator for this proxy. If no locator is configured, the return value is null.

    • ice_locator

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

    • ice_isCollocationOptimized

      boolean ice_isCollocationOptimized()
      Returns whether this proxy uses collocation optimization.
      Returns:
      true if the proxy uses collocation optimization; false otherwise.

    • ice_collocationOptimized

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

    • ice_twoway

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

    • ice_isTwoway

      boolean ice_isTwoway()
      Returns whether this proxy uses twoway invocations.
      Returns:
      true if this proxy uses twoway invocations; false otherwise.

    • ice_oneway

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

    • ice_isOneway

      boolean ice_isOneway()
      Returns whether this proxy uses oneway invocations.
      Returns:
      true if this proxy uses oneway invocations; false otherwise.

    • ice_batchOneway

      default ObjectPrx ice_batchOneway()
      Returns a proxy that is identical to this proxy, but uses batch oneway invocations.
      Returns:
      A new proxy that uses batch oneway invocations.

    • ice_isBatchOneway

      boolean ice_isBatchOneway()
      Returns whether this proxy uses batch oneway invocations.
      Returns:
      true if this proxy uses batch oneway invocations; false otherwise.

    • ice_datagram

      default ObjectPrx ice_datagram()
      Returns a proxy that is identical to this proxy, but uses datagram invocations.
      Returns:
      A new proxy that uses datagram invocations.

    • ice_isDatagram

      boolean ice_isDatagram()
      Returns whether this proxy uses datagram invocations.
      Returns:
      true if this proxy uses datagram invocations; false otherwise.

    • ice_batchDatagram

      default ObjectPrx ice_batchDatagram()
      Returns a proxy that is identical to this proxy, but uses batch datagram invocations.
      Returns:
      A new proxy that uses batch datagram invocations.

    • ice_isBatchDatagram

      boolean ice_isBatchDatagram()
      Returns whether this proxy uses batch datagram invocations.
      Returns:
      true if this proxy uses batch datagram invocations; false otherwise.

    • ice_compress

      default ObjectPrx 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.
      Parameters:
      co - true enables compression for the new proxy; false disables compression.
      Returns:
      A proxy with the specified compression setting.

    • ice_getCompress

      Optional<Boolean> ice_getCompress()
      Obtains the compression override setting of this proxy.
      Returns:
      The compression override setting. If no optional value is present, no override is set. Otherwise, true if compression is enabled, false otherwise.

    • ice_timeout

      default ObjectPrx ice_timeout(int t)
      Returns a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints.
      Parameters:
      t - The connection timeout for the proxy in milliseconds.
      Returns:
      A proxy with the specified timeout.

    • ice_getTimeout

      OptionalInt ice_getTimeout()
      Obtains the timeout override of this proxy.
      Returns:
      The timeout override. If no optional value is present, no override is set. Otherwise, returns the timeout override value.

    • ice_connectionId

      default ObjectPrx ice_connectionId(String connectionId)
      Returns a proxy that is identical to this proxy, except for its connection ID.
      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_getConnection

      Connection ice_getConnection()
      Returns the Connection for this proxy. If the proxy does not yet have an established connection, it first attempts to create a connection.
      Returns:
      The Connection for this proxy.
      Throws:
      CollocationOptimizationException - If the proxy uses collocation optimization and denotes a collocated object.
      See Also:

    • ice_executor

      default Executor ice_executor()
      Returns an executor object that uses the Ice thread pool.
      Returns:
      The Executor object.

    • ice_getConnectionAsync

      CompletableFuture<Connection> ice_getConnectionAsync()
      Asynchronously gets the connection for this proxy. The call does not block.
      Returns:
      A future for the completion of the request.

    • ice_getCachedConnection

      Connection ice_getCachedConnection()
      Returns the cached Connection for this proxy. If the proxy does not yet have an established connection, it does not attempt to create a connection.
      Returns:
      The cached Connection for this proxy (null if the proxy does not have an established connection).
      Throws:
      CollocationOptimizationException - If the proxy uses collocation optimization and denotes a collocated object.
      See Also:

    • ice_flushBatchRequests

      void ice_flushBatchRequests()
      Flushes any pending batched requests for this communicator. The call blocks until the flush is complete.

    • ice_flushBatchRequestsAsync

      CompletableFuture<Void> ice_flushBatchRequestsAsync()
      Asynchronously flushes any pending batched requests for this communicator. The call does not block.
      Returns:
      A future for the completion of the request.

    • equals

      boolean equals(Object r)
      Returns whether this proxy equals the passed object. Two proxies are equal if they are equal in all respects, that is, if their object identity, endpoints timeout settings, and so on are all equal.
      Overrides:
      equals in class Object
      Parameters:
      r - The object to compare this proxy with.
      Returns:
      true if this proxy is equal to r; false otherwise.

    • ice_staticId

      static String ice_staticId()
      Returns the Slice type ID associated with this type.
      Returns:
      The Slice type ID.

    • checkedCast

      static ObjectPrx checkedCast(ObjectPrx obj)
      Casts a proxy to ObjectPrx. For user-defined types, this call contacts the server and will throw an Ice run-time exception if the target object does not exist or the server cannot be reached.
      Parameters:
      obj - The proxy to cast to @{link ObjectPrx}.
      Returns:
      obj.

    • checkedCast

      static ObjectPrx checkedCast(ObjectPrx obj, Map<String,String> context)
      Casts a proxy to ObjectPrx. For user-defined types, this call contacts the server and throws an Ice run-time exception if the target object does not exist or the server cannot be reached.
      Parameters:
      obj - The proxy to cast to ObjectPrx.
      context - The Context map for the invocation.
      Returns:
      obj.

    • checkedCast

      static ObjectPrx checkedCast(ObjectPrx obj, String facet)
      Creates a new proxy that is identical to the passed proxy, except for its facet. This call contacts the server and throws an Ice run-time exception if the target object does not exist, the specified facet does not exist, or the server cannot be reached.
      Parameters:
      obj - The proxy to cast to ObjectPrx.
      facet - The facet for the new proxy.
      Returns:
      The new proxy with the specified facet.

    • checkedCast

      static ObjectPrx checkedCast(ObjectPrx obj, String facet, Map<String,String> context)
      Creates a new proxy that is identical to the passed proxy, except for its facet. This call contacts the server and throws an Ice run-time exception if the target object does not exist, the specified facet does not exist, or the server cannot be reached.
      Parameters:
      obj - The proxy to cast to ObjectPrx.
      facet - The facet for the new proxy.
      context - The Context map for the invocation.
      Returns:
      The new proxy with the specified facet.

    • uncheckedCast

      static ObjectPrx uncheckedCast(ObjectPrx obj)
      Casts a proxy to ObjectPrx. This call does not contact the server and always succeeds.
      Parameters:
      obj - The proxy to cast to ObjectPrx.
      Returns:
      obj.

    • uncheckedCast

      static ObjectPrx uncheckedCast(ObjectPrx obj, String facet)
      Creates a new proxy that is identical to the passed proxy, except for its facet. This call does not contact the server and always succeeds.
      Parameters:
      obj - The proxy to cast to ObjectPrx.
      facet - The facet for the new proxy.
      Returns:
      The new proxy with the specified facet.

    • write

      static void write(OutputStream ostr, ObjectPrx v)
      Writes a proxy to the stream.
      Parameters:
      ostr - The destination stream.
      v - The proxy to write to the stream.

    • read

      static ObjectPrx read(InputStream istr)
      Reads a proxy from the stream.
      Parameters:
      istr - The source stream.
      Returns:
      A new proxy or null for a nil proxy.