Module com.zeroc.icebox
Package com.zeroc.IceBox

Interface ServiceManagerPrx

All Superinterfaces:
ObjectPrx
public interface ServiceManagerPrx extends ObjectPrx
Administers the services of an IceBox server.

Remarks: The Slice compiler generated this proxy interface from Slice interface ::IceBox::ServiceManager.

  • Method Details

    • startService

      default void startService(String service) throws AlreadyStartedException, NoSuchServiceException
      Starts a service.
      Parameters:
      service - The service name.
      Throws:
      AlreadyStartedException - Thrown when the service is already running.
      NoSuchServiceException - Thrown when IceBox does not know a service named service.

    • startService

      default void startService(String service, Map<String,String> context) throws AlreadyStartedException, NoSuchServiceException
      Starts a service.
      Parameters:
      service - The service name.
      context - the Context map to send with the invocation
      Throws:
      AlreadyStartedException - Thrown when the service is already running.
      NoSuchServiceException - Thrown when IceBox does not know a service named service.

    • startServiceAsync

      default CompletableFuture<Void> startServiceAsync(String service)
      Starts a service.
      Parameters:
      service - The service name.
      Returns:
      a future that will be completed when the invocation completes

    • startServiceAsync

      default CompletableFuture<Void> startServiceAsync(String service, Map<String,String> context)
      Starts a service.
      Parameters:
      service - The service name.
      context - the Context map to send with the invocation
      Returns:
      a future that will be completed when the invocation completes

    • stopService

      default void stopService(String service) throws AlreadyStoppedException, NoSuchServiceException
      Stops a service.
      Parameters:
      service - The service name.
      Throws:
      AlreadyStoppedException - Thrown when the service is already stopped.
      NoSuchServiceException - Thrown when IceBox does not know a service named service.

    • stopService

      default void stopService(String service, Map<String,String> context) throws AlreadyStoppedException, NoSuchServiceException
      Stops a service.
      Parameters:
      service - The service name.
      context - the Context map to send with the invocation
      Throws:
      AlreadyStoppedException - Thrown when the service is already stopped.
      NoSuchServiceException - Thrown when IceBox does not know a service named service.

    • stopServiceAsync

      default CompletableFuture<Void> stopServiceAsync(String service)
      Stops a service.
      Parameters:
      service - The service name.
      Returns:
      a future that will be completed when the invocation completes

    • stopServiceAsync

      default CompletableFuture<Void> stopServiceAsync(String service, Map<String,String> context)
      Stops a service.
      Parameters:
      service - The service name.
      context - the Context map to send with the invocation
      Returns:
      a future that will be completed when the invocation completes

    • isServiceRunning

      default boolean isServiceRunning(String service) throws NoSuchServiceException
      Returns whether a service is running.
      Parameters:
      service - The name of the service to check.
      Returns:
      true if the service was started and not stopped; otherwise false.
      Throws:
      NoSuchServiceException - Thrown when IceBox does not know a service named service.

    • isServiceRunning

      default boolean isServiceRunning(String service, Map<String,String> context) throws NoSuchServiceException
      Returns whether a service is running.
      Parameters:
      service - The name of the service to check.
      context - the Context map to send with the invocation
      Returns:
      true if the service was started and not stopped; otherwise false.
      Throws:
      NoSuchServiceException - Thrown when IceBox does not know a service named service.

    • isServiceRunningAsync

      default CompletableFuture<Boolean> isServiceRunningAsync(String service)
      Returns whether a service is running.
      Parameters:
      service - The name of the service to check.
      Returns:
      true if the service was started and not stopped; otherwise false.

    • isServiceRunningAsync

      default CompletableFuture<Boolean> isServiceRunningAsync(String service, Map<String,String> context)
      Returns whether a service is running.
      Parameters:
      service - The name of the service to check.
      context - the Context map to send with the invocation
      Returns:
      true if the service was started and not stopped; otherwise false.

    • addObserver

      default void addObserver(ServiceObserverPrx observer)
      Registers a new observer with this service manager.
      Parameters:
      observer - The new observer.

    • addObserver

      default void addObserver(ServiceObserverPrx observer, Map<String,String> context)
      Registers a new observer with this service manager.
      Parameters:
      observer - The new observer.
      context - the Context map to send with the invocation

    • addObserverAsync

      default CompletableFuture<Void> addObserverAsync(ServiceObserverPrx observer)
      Registers a new observer with this service manager.
      Parameters:
      observer - The new observer.
      Returns:
      a future that will be completed when the invocation completes

    • addObserverAsync

      default CompletableFuture<Void> addObserverAsync(ServiceObserverPrx observer, Map<String,String> context)
      Registers a new observer with this service manager.
      Parameters:
      observer - The new observer.
      context - the Context map to send with the invocation
      Returns:
      a future that will be completed when the invocation completes

    • shutdown

      default void shutdown()
      Shuts down all services.

    • shutdown

      default void shutdown(Map<String,String> context)
      Shuts down all services.
      Parameters:
      context - the Context map to send with the invocation

    • shutdownAsync

      default CompletableFuture<Void> shutdownAsync()
      Shuts down all services.
      Returns:
      a future that will be completed when the invocation completes

    • shutdownAsync

      default CompletableFuture<Void> shutdownAsync(Map<String,String> context)
      Shuts down all services.
      Parameters:
      context - the Context map to send with the invocation
      Returns:
      a future that will be completed when the invocation completes

    • createProxy

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

    • checkedCast

      static ServiceManagerPrx 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 proxy for this type, or null if the target object does not support this type

    • checkedCast

      static ServiceManagerPrx 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 Context map to send with the invocation
      Returns:
      a new proxy for this type, or null if the target object does not support this type

    • checkedCast

      static ServiceManagerPrx 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 - 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 ServiceManagerPrx 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 - 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 target object does not support this type.

    • uncheckedCast

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

    • uncheckedCast

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

    • ice_context

      ServiceManagerPrx ice_context(Map<String,String> newContext)
      Description copied from interface: ObjectPrx
      Creates a 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

      ServiceManagerPrx ice_adapterId(String newAdapterId)
      Description copied from interface: ObjectPrx
      Creates a 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

      ServiceManagerPrx ice_endpoints(Endpoint[] newEndpoints)
      Description copied from interface: ObjectPrx
      Creates a 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

      ServiceManagerPrx ice_locatorCacheTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Creates a 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

      ServiceManagerPrx ice_invocationTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Creates 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:
      a proxy with the new timeout

    • ice_invocationTimeout

      ServiceManagerPrx ice_invocationTimeout(Duration newTimeout)
      Description copied from interface: ObjectPrx
      Creates 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:
      a proxy with the new timeout

    • ice_connectionCached

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

    • ice_endpointSelection

      ServiceManagerPrx ice_endpointSelection(EndpointSelectionType newType)
      Description copied from interface: ObjectPrx
      Creates 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:
      a proxy with the specified endpoint selection policy

    • ice_encodingVersion

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

    • ice_router

      ServiceManagerPrx ice_router(RouterPrx router)
      Description copied from interface: ObjectPrx
      Creates 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:
      a proxy with the specified router

    • ice_locator

      ServiceManagerPrx ice_locator(LocatorPrx locator)
      Description copied from interface: ObjectPrx
      Creates 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:
      a proxy with the specified locator

    • ice_collocationOptimized

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

    • ice_twoway

      ServiceManagerPrx ice_twoway()
      Description copied from interface: ObjectPrx
      Creates a 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

      ServiceManagerPrx ice_oneway()
      Description copied from interface: ObjectPrx
      Creates a 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

      ServiceManagerPrx ice_batchOneway()
      Description copied from interface: ObjectPrx
      Creates a 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

      ServiceManagerPrx ice_datagram()
      Description copied from interface: ObjectPrx
      Creates a 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

      ServiceManagerPrx ice_batchDatagram()
      Description copied from interface: ObjectPrx
      Creates a 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

      ServiceManagerPrx ice_compress(boolean co)
      Description copied from interface: ObjectPrx
      Creates 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 override setting

    • ice_connectionId

      ServiceManagerPrx ice_connectionId(String connectionId)
      Description copied from interface: ObjectPrx
      Creates 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

      ServiceManagerPrx ice_fixed(Connection connection)
      Description copied from interface: ObjectPrx
      Creates a 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 "::IceBox::ServiceManager"