Module com.zeroc.ice
Package com.zeroc.Ice

Interface ObjectPrx

All Known Subinterfaces:
AdapterObserverPrx, AdminPrx, AdminSessionPrx, ApplicationObserverPrx, FileIteratorPrx, FileParserPrx, 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
The base interface of all Ice 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()
      Gets 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 implements the Slice interface specified by id or implements a derived interface, and false otherwise.

    • 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 request context
      Returns:
      true if the target object implements the Slice interface specified by id or implements a derived interface, and false otherwise.

    • 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 that completes with true if the target object implements the Slice interface specified by id or implements a derived interface, and false otherwise.

    • 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 request context
      Returns:
      a future that completes with true if the target object implements the Slice interface specified by id or implements a derived interface, and false otherwise.

    • 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 request context

    • ice_pingAsync

      CompletableFuture<Void> ice_pingAsync()
      Tests whether the target object of this proxy can be reached.
      Returns:
      a future that completes when the invocation completes

    • ice_pingAsync

      CompletableFuture<Void> ice_pingAsync(Map<String,String> context)
      Tests whether the target object of this proxy can be reached.
      Parameters:
      context - the request context
      Returns:
      a future that completes when the invocation completes

    • ice_ids

      String[] ice_ids()
      Returns the Slice interfaces supported by this object as a list of Slice type IDs.
      Returns:
      the Slice type IDs of the interfaces supported by this object, in alphabetical order

    • ice_ids

      String[] ice_ids(Map<String,String> context)
      Returns the Slice interfaces supported by this object as a list of Slice type IDs.
      Parameters:
      context - the request context
      Returns:
      the Slice type IDs of the interfaces supported by this object, in alphabetical order

    • ice_idsAsync

      CompletableFuture<String[]> ice_idsAsync()
      Returns the Slice interfaces supported by this object as a list of Slice type IDs.
      Returns:
      a future that completes with the Slice type IDs of the interfaces supported by this object, in alphabetical order

    • ice_idsAsync

      CompletableFuture<String[]> ice_idsAsync(Map<String,String> context)
      Returns the Slice interfaces supported by this object as a list of Slice type IDs.
      Parameters:
      context - the request context
      Returns:
      a future that completes with the Slice type IDs of the interfaces supported by this object, in alphabetical order

    • ice_id

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

    • ice_id

      String ice_id(Map<String,String> context)
      Returns the type ID of the most-derived Slice interface supported by this object.
      Parameters:
      context - the request context
      Returns:
      the Slice type ID of the most-derived interface

    • ice_idAsync

      CompletableFuture<String> ice_idAsync()
      Returns the type ID of the most-derived Slice interface supported by this object.
      Returns:
      a future that completes with the type ID of the most-derived Slice interface supported by this object

    • ice_idAsync

      CompletableFuture<String> ice_idAsync(Map<String,String> context)
      Returns the type ID of the most-derived Slice interface supported by this object.
      Parameters:
      context - the request context
      Returns:
      a future that completes with the type ID of the most-derived Slice interface supported by this object

    • ice_invoke

      Object.Ice_invokeResult ice_invoke(String operation, OperationMode mode, byte[] inParams)
      Invokes an operation.
      Parameters:
      operation - the name of the operation to invoke
      mode - the operation mode (normal or idempotent)
      inParams - an encapsulation containing the encoded in-parameters for the operation
      Returns:
      the result 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.
      Parameters:
      operation - the name of the operation to invoke
      mode - the operation mode (normal or idempotent)
      inParams - an encapsulation containing the encoded in-parameters for the operation
      context - the request context
      Returns:
      the result of the invocation
      See Also:

    • ice_invokeAsync

      CompletableFuture<Object.Ice_invokeResult> ice_invokeAsync(String operation, OperationMode mode, byte[] inParams)
      Invokes an operation asynchronously.
      Parameters:
      operation - the name of the operation to invoke
      mode - the operation mode (normal or idempotent)
      inParams - an encapsulation containing the encoded in-parameters for the operation
      Returns:
      a future that completes with the result of the invocation
      See Also:

    • ice_invokeAsync

      CompletableFuture<Object.Ice_invokeResult> ice_invokeAsync(String operation, OperationMode mode, byte[] inParams, Map<String,String> context)
      Invokes an operation asynchronously.
      Parameters:
      operation - the name of the operation to invoke
      mode - the operation mode (normal or idempotent)
      inParams - an encapsulation containing the encoded in-parameters for the operation
      context - the request context
      Returns:
      a future that completes with the result of the invocation
      See Also:

    • ice_getIdentity

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

    • ice_identity

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

    • ice_getContext

      Map<String,String> ice_getContext()
      Gets the per-proxy context for this proxy.
      Returns:
      the per-proxy context, or null if the proxy does not have a per-proxy context.

    • ice_context

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

    • ice_getFacet

      String ice_getFacet()
      Gets 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)
      Creates a proxy that is identical to this proxy, except for the facet.
      Parameters:
      newFacet - the facet for the new proxy
      Returns:
      a proxy with the new facet

    • ice_getAdapterId

      String ice_getAdapterId()
      Gets 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

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

    • ice_getEndpoints

      Endpoint[] ice_getEndpoints()
      Gets the endpoints used by this proxy.
      Returns:
      the endpoints used by this proxy

    • ice_endpoints

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

    • ice_getLocatorCacheTimeout

      Duration ice_getLocatorCacheTimeout()
      Gets the locator cache timeout of this proxy.
      Returns:
      the locator cache timeout value
      See Also:

    • ice_getInvocationTimeout

      Duration ice_getInvocationTimeout()
      Gets the invocation timeout of this proxy.
      Returns:
      the invocation timeout value

    • ice_getConnectionId

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

    • ice_fixed

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

    • ice_isFixed

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

    • ice_locatorCacheTimeout

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

    • ice_locatorCacheTimeout

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

    • ice_invocationTimeout

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

    • ice_invocationTimeout

      ObjectPrx ice_invocationTimeout(Duration newTimeout)
      Creates a proxy that is identical to this proxy, except for the invocation timeout.
      Parameters:
      newTimeout - the new invocation timeout
      Returns:
      a proxy with the new timeout

    • ice_isConnectionCached

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

    • ice_connectionCached

      ObjectPrx ice_connectionCached(boolean newCache)
      Creates 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:
      a proxy with the specified caching policy

    • ice_getEndpointSelection

      EndpointSelectionType ice_getEndpointSelection()
      Gets the endpoint selection policy for this proxy (randomly or ordered).
      Returns:
      the endpoint selection policy

    • ice_endpointSelection

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

    • ice_encodingVersion

      ObjectPrx ice_encodingVersion(EncodingVersion e)
      Creates 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:
      a proxy with the specified encoding version

    • ice_getEncodingVersion

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

    • ice_getRouter

      RouterPrx ice_getRouter()
      Gets 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

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

    • ice_getLocator

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

    • ice_locator

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

    • ice_isCollocationOptimized

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

    • ice_collocationOptimized

      ObjectPrx ice_collocationOptimized(boolean b)
      Creates 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:
      a proxy with the specified collocation optimization

    • ice_twoway

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

    • ice_isTwoway

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

    • ice_oneway

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

    • ice_isOneway

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

    • ice_batchOneway

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

    • ice_isBatchOneway

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

    • ice_datagram

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

    • ice_isDatagram

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

    • ice_batchDatagram

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

    • ice_isBatchDatagram

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

    • ice_compress

      ObjectPrx ice_compress(boolean co)
      Creates a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
      Parameters:
      co - true enables compression for the new proxy, false disables compression.
      Returns:
      a proxy with the specified compression override setting

    • ice_getCompress

      Optional<Boolean> ice_getCompress()
      Gets 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_connectionId

      ObjectPrx ice_connectionId(String connectionId)
      Creates 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()
      Gets the connection for this proxy. If the proxy does not yet have an established connection, it first attempts to create a connection.

      You can call this method to establish a connection or associate the proxy with an existing connection and ignore the return value.

      Returns:
      The Connection for this proxy.

    • 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()
      Gets the connection for this proxy asynchronously. If the proxy does not yet have an established connection, it first attempts to create a connection.
      Returns:
      a future that completes with the Connection for this proxy

    • ice_getCachedConnection

      Connection ice_getCachedConnection()
      Gets 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, or null if the proxy does not have an established connection
      See Also:

    • ice_flushBatchRequests

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

    • ice_flushBatchRequestsAsync

      CompletableFuture<Void> ice_flushBatchRequestsAsync()
      Flushes any pending batched requests for this proxy asynchronously. The call does not block.
      Returns:
      a future that completes when the flush completes

    • equals

      boolean equals(Object r)
      Determines 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()
      Gets the Slice type ID associated with this type.
      Returns:
      the Slice type ID

    • createProxy

      static ObjectPrx createProxy(Communicator communicator, String proxyString)
      Creates a new proxy that implements ObjectPrx.
      Parameters:
      communicator - the communicator of the new proxy
      proxyString - the string representation of the proxy
      Returns:
      the new proxy
      Throws:
      ParseException - if proxyString is not a valid proxy string.

    • checkedCast

      static ObjectPrx checkedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
      Parameters:
      obj - the source proxy
      Returns:
      a new proxy or null if the target object does not support this proxy's type

    • checkedCast

      static ObjectPrx 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.
      Parameters:
      obj - the source proxy
      context - the request context
      Returns:
      a new proxy or null if the target object does not support this proxy's type

    • checkedCast

      static ObjectPrx checkedCast(ObjectPrx obj, String facet)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
      Parameters:
      obj - the source proxy
      facet - a facet name
      Returns:
      a new proxy with the specified facet, or null if the target facet does not support the specified type

    • checkedCast

      static ObjectPrx 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.
      Parameters:
      obj - the source proxy
      facet - a facet name
      context - the request context
      Returns:
      a new proxy with the specified facet, or null if the target facet does not support the specified type

    • uncheckedCast

      static ObjectPrx uncheckedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - the source proxy
      Returns:
      a new proxy with the desired type or null if obj is null

    • uncheckedCast

      static ObjectPrx uncheckedCast(ObjectPrx obj, String facet)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - the source proxy
      facet - a facet name
      Returns:
      a new proxy with the desired type or null if obj is null

    • write

      static void write(OutputStream ostr, ObjectPrx v)
      Writes a proxy to the provided 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 provided stream.
      Parameters:
      istr - the source stream
      Returns:
      a new proxy from the stream or null for a null proxy