diff options
Diffstat (limited to 'java/src/Ice/ObjectPrx.java')
| -rw-r--r-- | java/src/Ice/ObjectPrx.java | 423 |
1 files changed, 422 insertions, 1 deletions
diff --git a/java/src/Ice/ObjectPrx.java b/java/src/Ice/ObjectPrx.java index ad428f74551..7d467544e14 100644 --- a/java/src/Ice/ObjectPrx.java +++ b/java/src/Ice/ObjectPrx.java @@ -9,6 +9,9 @@ package Ice; +/** + * Base interface of all object proxies. + **/ public interface ObjectPrx { /** @@ -16,90 +19,508 @@ public interface ObjectPrx **/ int ice_getHash(); + /** + * Returns the communicator that created this proxy. + * + * @return The communicator that created this proxy. + **/ Communicator ice_getCommunicator(); + /** + * Returns the stringified form of this proxy. + * + * @return The stringified proxy. + **/ String ice_toString(); + /** + * Tests whether this object supports a specific Slice interface. + * + * @param __id The type ID of the Slice interface to test against. + * @return <code>true</code> if the target object has the interface + * specified by <code>__id</code> or derives from the interface + * specified by <code>__id</code>. + **/ boolean ice_isA(String __id); + + /** + * Tests whether this object supports a specific Slice interface. + * + * @param __id The type ID of the Slice interface to test against. + * @param __context The context map for the invocation. + * @return <code>true</code> if the target object has the interface + * specified by <code>__id</code> or derives from the interface + * specified by <code>__id</code>. + **/ boolean ice_isA(String __id, java.util.Map<String, String> __context); + /** + * Tests whether the target object of this proxy can be reached. + **/ void ice_ping(); + + /** + * Tests whether the target object of this proxy can be reached. + * + * @param __context The context map for the invocation. + **/ void ice_ping(java.util.Map<String, String> __context); + /** + * Returns the Slice type IDs of the interfaces supported by the target object of this proxy. + * + * @return The Slice type Ids of the interfaces supported by the target object, in base-to-derived + * order. The first element of the return array is always <code>::Ice::Object</code>. + **/ String[] ice_ids(); + + /** + * Returns the Slice type IDs of the interfaces supported by the target object of this proxy. + * + * @return The Slice type Ids of the interfaces supported by the target object, in base-to-derived + * order. The first element of the return array is always <code>::Ice::Object</code>. + * + * @param __context The context map for the invocation. + **/ String[] ice_ids(java.util.Map<String, String> __context); + /** + * Returns the Slice type ID of the most-derived interface supported by the target object of this proxy. + * + * @return The Slice type ID of the most-derived interface. + **/ String ice_id(); + + /** + * Returns the Slice type ID of the most-derived interface supported by the target object of this proxy. + * + * @param __context The context map for the invocation. + * @return The Slice type ID of the most-derived interface. + **/ String ice_id(java.util.Map<String, String> __context); - // Returns true if ok, false if user exception. + /** + * Invoke an operation dynamically. + * + * @param operation The name of the operation to invoke. + * @param mode The operation mode (normal or idempotent). + * @param inParams The encoded in-parameters for the operation. + * @param outParams The encoded out-paramaters and return value + * for the operation. The return value follows any out-parameters. + * @return If the operation completed successfully, the return value + * is <code>true</code>. If the operation raises a user exception, + * the return value is <code>false</code>; in this case, <code>outParams</code> + * contains the encoded user exception. If the operation raised an + * it throws it directly. + * + * @see Blobject + * @see OperationMode + **/ boolean ice_invoke(String operation, OperationMode mode, byte[] inParams, ByteSeqHolder outParams); + + /** + * Invoke an operation dynamically. + * + * @param operation The name of the operation to invoke. + * @param mode The operation mode (normal or idempotent). + * @param inParams The encoded in-parameters for the operation. + * @param outParams The encoded out-paramaters and return value + * for the operation. The return value follows any out-parameters. + * @param __context The context map for the invocation. + * @return If the operation was invoked synchronously (because there + * was no need to queue the request, the return value is <code>true</code>; + * otherwise, if the invocation was queued, the return value is <code>false</code>. + * + * @see Blobject + * @see OperationMode + **/ boolean ice_invoke(String operation, OperationMode mode, byte[] inParams, ByteSeqHolder outParams, java.util.Map<String, String> __context); + /** + * Invokes an operation dynamically and asynchronously. + * + * @param cb The callback object to notify when the operation completes. + * @param operation The name of the operation to invoke. + * @param mode The operation mode (normal or idempotent). + * @param inParams The encoded in-parameters for the operation. + * @return If the operation completed successfully, the return value + * is <code>true</code>. If the operation raises a user exception, + * the return value is <code>false</code>; in this case, <code>outParams</code> + * contains the encoded user exception. If the operation raised an + * it throws it directly. + * + * @see AMI_Object_ice_invoke + * @see OperationMode + **/ boolean ice_invoke_async(AMI_Object_ice_invoke cb, String operation, OperationMode mode, byte[] inParams); + + /** + * Invokes an operation dynamically and asynchronously. + * + * @param cb The callback object to notify when the operation completes. + * @param operation The name of the operation to invoke. + * @param mode The operation mode (normal or idempotent). + * @param inParams The encoded in-parameters for the operation. + * @param __context The context map for the invocation. + * @return If the operation completed successfully, the return value + * is <code>true</code>. If the operation raises a user exception, + * the return value is <code>false</code>; in this case, <code>outParams</code> + * contains the encoded user exception. If the operation raised an + * it throws it directly. + * + * @see AMI_Object_ice_invoke + * @see OperationMode + **/ boolean ice_invoke_async(AMI_Object_ice_invoke cb, String operation, OperationMode mode, byte[] inParams, java.util.Map<String, String> context); + /** + * Returns the identity embedded in this proxy. + * + * @return The identity of the target object. + **/ Identity ice_getIdentity(); + + /** + * Creates a new proxy that is identical to this proxy, except for the identity. + * + * @param newIdentity The identity for the new proxy. + * @return The proxy with the new identity. + **/ ObjectPrx ice_identity(Identity newIdentity); + /** + * Returns the per-proxy context for this proxy. + * + * @return The per-proxy context. If the proxy does not have a per-proxy (implicit) context, the return value + * is <code>null</code>. + **/ java.util.Map<String, String> ice_getContext(); + + /** + * Creates a new proxy that is identical to this proxy, except for the per-proxy context. + * + * @param newContext The context for the new proxy. + * @return The proxy with the new per-proxy context. + **/ ObjectPrx ice_context(java.util.Map<String, String> newContext); + /** + * Returns the facet for this proxy. + * + * @return The facet for this proxy. If the proxy uses the default facet, the return value is the empty string. + **/ String ice_getFacet(); + + /** + * Creates a new proxy that is identical to this proxy, except for the facet. + * + * @param newFacet The facet for the new proxy. + * @return The proxy with the new facet. + **/ ObjectPrx ice_facet(String newFacet); + /** + * Returns the adapter ID for this proxy. + * + * @return The adapter ID. If the proxy does not have an adapter ID, the return value is the empty string. + **/ String ice_getAdapterId(); + + /** + * Creates a new proxy that is identical to this proxy, except for the adapter ID. + * + * @param newAdapterId The adapter ID for the new proxy. + * @return The proxy with the new adapter ID. + **/ ObjectPrx ice_adapterId(String newAdapterId); + /** + * Returns the endpoints used by this proxy. + * + * @return The endpoints used by this proxy. + * + * @see Endpoint + **/ Endpoint[] ice_getEndpoints(); + + /** + * Creates a new proxy that is identical to this proxy, except for the endpoints. + * + * @param newEndpoints The endpoints for the new proxy. + * @return The proxy with the new endpoints. + **/ ObjectPrx ice_endpoints(Endpoint[] newEndpoints); + /** + * Returns the locator cache timeout of this proxy. + * + * @return The locator cache timeout value (in seconds). + * + * @see Locator + **/ int ice_getLocatorCacheTimeout(); + + /** + * Creates a new proxy that is identical to this proxy, except for the locator cache timeout. + * + * @param newTimeout The new locator cache timeout (in seconds). + * + * @see Locator + **/ ObjectPrx ice_locatorCacheTimeout(int newTimeout); + /** + * Returns whether this proxy caches connections. + * + * @return <code>true</code> if this proxy caches connections; <code>false</code>, otherwise. + **/ boolean ice_isConnectionCached(); + + /** + * Creates a new proxy that is identical to this proxy, except for connection caching. + * + * @param newCache <code>true</code> if the new proxy should cache connections; <code>false</code>, otherwise. + * @return The new proxy with the specified caching policy. + **/ ObjectPrx ice_connectionCached(boolean newCache); + /** + * Returns how this proxy selects endpoints (randomly or ordered). + * + * @return The endpoint selection policy. + * + * @see EndpointSelectionType + **/ EndpointSelectionType ice_getEndpointSelection(); + + /** + * Creates a new proxy that is identical to this proxy, except for the endpoint selection policy. + * + * @param newType The new endpoint selection policy. + * @return The new proxy with the specified endpoint selection policy. + * + * @see EndpointSelectionType + **/ ObjectPrx ice_endpointSelection(EndpointSelectionType newType); + /** + * Returns whether this proxy uses only secure endpoints. + * + * @return <code>true</code> if all endpoints for this proxy are secure; <code>false</code>, otherwise. + **/ boolean ice_isSecure(); + + /** + * Creates a new proxy that is identical to this proxy, except for its endpoints. + * + * @param If <code>b</code> is <code>true</code>, only endpoints that use a secure transport are + * retained for the new proxy. If <code>b</code> is false, the returned proxy is identical to this proxy. + * @return The new proxy with possible different endpoints.k + **/ ObjectPrx ice_secure(boolean b); + /** + * Returns whether this proxy prefers secure endpoints. + * + * @return <code>true</code> if the proxy always attempts to invoke via secure endpoints before it + * attempts to use insecure endpoints; <code>false</code>, otherwise; + **/ boolean ice_isPreferSecure(); + + /** + * Creates a new proxy that is identical to this proxy, except for its endpoint selection policy. + * + * @param b If <code>b</code> is <code>true</code>, the new proxy will use secure endpoints for invocations + * and only use insecure endpoints if an invocation cannot be made via secure endpoints. If <code>b</code> is + * <code>false</code>, the proxy prefers insecure endpoints to secure ones. + * @return The new proxy with the new endpoint selection policy. + **/ ObjectPrx ice_preferSecure(boolean b); + /** + * Returns the router for this proxy. + * + * @return The router for the proxy. If no router is configured for the proxy, the return value + * is <code>null</code>. + **/ Ice.RouterPrx ice_getRouter(); + + /** + * Creates a new proxy that is identical to this proxy, except for the router. + * + * @param router The router for the new proxy. + * @return The new proxy with the specified router. + **/ ObjectPrx ice_router(Ice.RouterPrx router); + /** + * Returns the locator for this proxy. + * + * @return The locator for this proxy. If no locator is configured, the return value is <code>null</code>. + **/ Ice.LocatorPrx ice_getLocator(); + + /** + * Creates a new proxy that is identical to this proxy, except for the locator. + * + * @param The locator for the new proxy. + * @return The new proxy with the specified locator. + **/ ObjectPrx ice_locator(Ice.LocatorPrx locator); + /** + * Returns whether this proxy uses collocation optimization. + * + * @return <code>true</code> if the proxy uses collocation optimization; <code>false</code>, otherwise. + **/ boolean ice_isCollocationOptimized(); + + /** + * Creates a new proxy that is identical to this proxy, except for collocation optimization. + * + * @param b <code>true</code> if the new proxy enables collocation optimization; <code>false</code>, otherwise. + * @return The new proxy the specified collocation optimization. + **/ ObjectPrx ice_collocationOptimized(boolean b); + /** + * Creates a new proxy that is identical to this proxy, but uses twoway invocations. + * + * @return A new proxy that uses twoway invocations. + **/ ObjectPrx ice_twoway(); + + /** + * Returns whether this proxy uses twoway invocations. + * @return <code>true</code> if this proxy uses twoway invocations; <code>false</code>, otherwise. + **/ boolean ice_isTwoway(); + + /** + * Creates a new proxy that is identical to this proxy, but uses oneway invocations. + * + * @return A new proxy that uses oneway invocations. + **/ ObjectPrx ice_oneway(); + + /** + * Returns whether this proxy uses oneway invocations. + * @return <code>true</code> if this proxy uses oneway invocations; <code>false</code>, otherwise. + **/ boolean ice_isOneway(); + + /** + * Creates a new proxy that is identical to this proxy, but uses batch oneway invocations. + * + * @return A new proxy that uses batch oneway invocations. + **/ ObjectPrx ice_batchOneway(); + + /** + * Returns whether this proxy uses batch oneway invocations. + * @return <code>true</code> if this proxy uses batch oneway invocations; <code>false</code>, otherwise. + **/ boolean ice_isBatchOneway(); + + /** + * Creates a new proxy that is identical to this proxy, but uses datagram invocations. + * + * @return A new proxy that uses datagram invocations. + **/ ObjectPrx ice_datagram(); + + /** + * Returns whether this proxy uses datagram invocations. + * @return <code>true</code> if this proxy uses datagram invocations; <code>false</code>, otherwise. + **/ boolean ice_isDatagram(); + + /** + * Creates a new proxy that is identical to this proxy, but uses batch datagram invocations. + * + * @return A new proxy that uses batch datagram invocations. + **/ ObjectPrx ice_batchDatagram(); + + /** + * Returns whether this proxy uses batch datagram invocations. + * @return <code>true</code> if this proxy uses batch datagram invocations; <code>false</code>, otherwise. + **/ boolean ice_isBatchDatagram(); + /** + * Creates a new proxy that is identical to this proxy, except for compression. + * + * @param co <code>true</code> enables compression for the new proxy; <code>false</code>disables compression. + * @return A new proxy with the specified compression setting. + **/ ObjectPrx ice_compress(boolean co); + + /** + * Creates a new proxy that is identical to this proxy, except for its timeout setting. + * + * @param t The timeout for the new proxy in milliseconds. + * @return A new proxy with the specified timeout. + **/ ObjectPrx ice_timeout(int t); + + /** + * Creates a new proxy that is identical to this proxy, except for its connection ID. + * + * @param connectionId The connection ID for the new proxy. An empty string removes the + * connection ID. + * + * @return A new proxy with the specified connection ID. + **/ ObjectPrx ice_connectionId(String connectionId); + /** + * Returns the <code>Connection</code> for this proxy. If the proxy does not yet have an established connection, + * it first attempts to create a connection. + * + * @return The <code>Connection</code> for this proxy. + * @throws CollocationOptimizationException If the proxy uses collocation optimization and denotes a + * collocated object. + * + * @see Connection + **/ Connection ice_getConnection(); + + /** + * Returns the cached <code>Connection</code> for this proxy. If the proxy does not yet have an established + * connection, it does not attempt to create a connection. + * + * @return The cached <code>Connection</code> for this proxy (<code>null</code> if the proxy does not have + * an established connection). + * @throws CollocationOptimizationException If the proxy uses collocation optimization and denotes a + * collocated object. + * + * @see Connection + **/ Connection ice_getCachedConnection(); + /** + * Flushes any pending batched requests for this communicator. The call blocks until the flush is complete. + **/ void ice_flushBatchRequests(); + + /** + * Asynchronously flushes any pending batched requests for this communicator. The call does not block. + * + * @param cb The callback object to notify the application when the flush is complete. + * @return <code>true</code> if the requests were flushed immediately without blocking; <code>false</code> + * if the requests could not be flushed immediately. + **/ boolean ice_flushBatchRequests_async(AMI_Object_ice_flushBatchRequests cb); + /** + * 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. + * + * @param r The object to compare this proxy with. + * @return <code>true</code> if this proxy is equal to <code>r</code>; <code>false</code>, otherwise. + **/ boolean equals(java.lang.Object r); } |