Interface ApiHandlePrx

  • All Superinterfaces:
    com.zeroc.Ice.ObjectPrx

    public interface ApiHandlePrx
    extends com.zeroc.Ice.ObjectPrx
    • Method Detail

      • disconnectAll

        default void disconnectAll()
      • disconnectAll

        default void disconnectAll​(Map<String,​String> context)
      • terminateApi

        default void terminateApi()
      • terminateApi

        default void terminateApi​(Map<String,​String> context)
      • checkedCast

        static ApiHandlePrx checkedCast​(com.zeroc.Ice.ObjectPrx obj)
        Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.
        Parameters:
        obj - The untyped proxy.
        Returns:
        A proxy for this type, or null if the object does not support this type.
      • checkedCast

        static ApiHandlePrx checkedCast​(com.zeroc.Ice.ObjectPrx obj,
                                        Map<String,​String> context)
        Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.
        Parameters:
        obj - The untyped proxy.
        context - The Context map to send with the invocation.
        Returns:
        A proxy for this type, or null if the object does not support this type.
      • checkedCast

        static ApiHandlePrx checkedCast​(com.zeroc.Ice.ObjectPrx obj,
                                        String facet)
        Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.
        Parameters:
        obj - The untyped proxy.
        facet - The name of the desired facet.
        Returns:
        A proxy for this type, or null if the object does not support this type.
      • checkedCast

        static ApiHandlePrx checkedCast​(com.zeroc.Ice.ObjectPrx obj,
                                        String facet,
                                        Map<String,​String> context)
        Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.
        Parameters:
        obj - The untyped proxy.
        facet - The name of the desired facet.
        context - The Context map to send with the invocation.
        Returns:
        A proxy for this type, or null if the object does not support this type.
      • uncheckedCast

        static ApiHandlePrx uncheckedCast​(com.zeroc.Ice.ObjectPrx obj)
        Downcasts the given proxy to this type without contacting the remote server.
        Parameters:
        obj - The untyped proxy.
        Returns:
        A proxy for this type.
      • uncheckedCast

        static ApiHandlePrx uncheckedCast​(com.zeroc.Ice.ObjectPrx obj,
                                          String facet)
        Downcasts the given proxy to this type without contacting the remote server.
        Parameters:
        obj - The untyped proxy.
        facet - The name of the desired facet.
        Returns:
        A proxy for this type.
      • ice_context

        default ApiHandlePrx ice_context​(Map<String,​String> newContext)
        Returns a proxy that is identical to this proxy, except for the per-proxy context.
        Specified by:
        ice_context in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        newContext - The context for the new proxy.
        Returns:
        A proxy with the specified per-proxy context.
      • ice_adapterId

        default ApiHandlePrx ice_adapterId​(String newAdapterId)
        Returns a proxy that is identical to this proxy, except for the adapter ID.
        Specified by:
        ice_adapterId in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        newAdapterId - The adapter ID for the new proxy.
        Returns:
        A proxy with the specified adapter ID.
      • ice_endpoints

        default ApiHandlePrx ice_endpoints​(com.zeroc.Ice.Endpoint[] newEndpoints)
        Returns a proxy that is identical to this proxy, except for the endpoints.
        Specified by:
        ice_endpoints in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        newEndpoints - The endpoints for the new proxy.
        Returns:
        A proxy with the specified endpoints.
      • ice_locatorCacheTimeout

        default ApiHandlePrx ice_locatorCacheTimeout​(int newTimeout)
        Returns a proxy that is identical to this proxy, except for the locator cache timeout.
        Specified by:
        ice_locatorCacheTimeout in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        newTimeout - The new locator cache timeout (in seconds).
        Returns:
        A proxy with the specified locator cache timeout.
      • ice_invocationTimeout

        default ApiHandlePrx ice_invocationTimeout​(int newTimeout)
        Returns a proxy that is identical to this proxy, except for the invocation timeout.
        Specified by:
        ice_invocationTimeout in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        newTimeout - The new invocation timeout (in seconds).
        Returns:
        A proxy with the specified invocation timeout.
      • ice_connectionCached

        default ApiHandlePrx ice_connectionCached​(boolean newCache)
        Returns a proxy that is identical to this proxy, except for connection caching.
        Specified by:
        ice_connectionCached in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        newCache - true if the new proxy should cache connections; false otherwise.
        Returns:
        A proxy with the specified caching policy.
      • ice_endpointSelection

        default ApiHandlePrx ice_endpointSelection​(com.zeroc.Ice.EndpointSelectionType newType)
        Returns a proxy that is identical to this proxy, except for the endpoint selection policy.
        Specified by:
        ice_endpointSelection in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        newType - The new endpoint selection policy.
        Returns:
        A proxy with the specified endpoint selection policy.
      • ice_secure

        default ApiHandlePrx ice_secure​(boolean b)
        Returns a proxy that is identical to this proxy, except for how it selects endpoints.
        Specified by:
        ice_secure in interface com.zeroc.Ice.ObjectPrx
        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:
        A proxy with the specified selection policy.
      • ice_encodingVersion

        default ApiHandlePrx ice_encodingVersion​(com.zeroc.Ice.EncodingVersion e)
        Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
        Specified by:
        ice_encodingVersion in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        e - The encoding version to use to marshal request parameters.
        Returns:
        A proxy with the specified encoding version.
      • ice_preferSecure

        default ApiHandlePrx ice_preferSecure​(boolean b)
        Returns a proxy that is identical to this proxy, except for its endpoint selection policy.
        Specified by:
        ice_preferSecure in interface com.zeroc.Ice.ObjectPrx
        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:
        A proxy with the specified selection policy.
      • ice_router

        default ApiHandlePrx ice_router​(com.zeroc.Ice.RouterPrx router)
        Returns a proxy that is identical to this proxy, except for the router.
        Specified by:
        ice_router in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        router - The router for the new proxy.
        Returns:
        A proxy with the specified router.
      • ice_locator

        default ApiHandlePrx ice_locator​(com.zeroc.Ice.LocatorPrx locator)
        Returns a proxy that is identical to this proxy, except for the locator.
        Specified by:
        ice_locator in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        locator - The locator for the new proxy.
        Returns:
        A proxy with the specified locator.
      • ice_collocationOptimized

        default ApiHandlePrx ice_collocationOptimized​(boolean b)
        Returns a proxy that is identical to this proxy, except for collocation optimization.
        Specified by:
        ice_collocationOptimized in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        b - true if the new proxy enables collocation optimization; false otherwise.
        Returns:
        A proxy with the specified collocation optimization.
      • ice_twoway

        default ApiHandlePrx ice_twoway()
        Returns a proxy that is identical to this proxy, but uses twoway invocations.
        Specified by:
        ice_twoway in interface com.zeroc.Ice.ObjectPrx
        Returns:
        A proxy that uses twoway invocations.
      • ice_oneway

        default ApiHandlePrx ice_oneway()
        Returns a proxy that is identical to this proxy, but uses oneway invocations.
        Specified by:
        ice_oneway in interface com.zeroc.Ice.ObjectPrx
        Returns:
        A proxy that uses oneway invocations.
      • ice_batchOneway

        default ApiHandlePrx ice_batchOneway()
        Returns a proxy that is identical to this proxy, but uses batch oneway invocations.
        Specified by:
        ice_batchOneway in interface com.zeroc.Ice.ObjectPrx
        Returns:
        A proxy that uses batch oneway invocations.
      • ice_datagram

        default ApiHandlePrx ice_datagram()
        Returns a proxy that is identical to this proxy, but uses datagram invocations.
        Specified by:
        ice_datagram in interface com.zeroc.Ice.ObjectPrx
        Returns:
        A proxy that uses datagram invocations.
      • ice_batchDatagram

        default ApiHandlePrx ice_batchDatagram()
        Returns a proxy that is identical to this proxy, but uses batch datagram invocations.
        Specified by:
        ice_batchDatagram in interface com.zeroc.Ice.ObjectPrx
        Returns:
        A proxy that uses batch datagram invocations.
      • ice_compress

        default ApiHandlePrx ice_compress​(boolean co)
        Returns a proxy that is identical to this proxy, except for compression.
        Specified by:
        ice_compress in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        co - true enables compression for the new proxy; false disables compression.
        Returns:
        A proxy with the specified compression setting.
      • ice_timeout

        default ApiHandlePrx ice_timeout​(int t)
        Returns a proxy that is identical to this proxy, except for its connection timeout setting.
        Specified by:
        ice_timeout in interface com.zeroc.Ice.ObjectPrx
        Parameters:
        t - The connection timeout for the proxy in milliseconds.
        Returns:
        A proxy with the specified timeout.
      • ice_connectionId

        default ApiHandlePrx ice_connectionId​(String connectionId)
        Returns a proxy that is identical to this proxy, except for its connection ID.
        Specified by:
        ice_connectionId in interface com.zeroc.Ice.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

        default ApiHandlePrx ice_fixed​(com.zeroc.Ice.Connection connection)
        Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy connection.
        Specified by:
        ice_fixed in interface com.zeroc.Ice.ObjectPrx
        Returns:
        A fixed proxy bound to the given connection.
      • ice_staticId

        static String ice_staticId()