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

Interface AsyncServiceManager

All Superinterfaces:
Object
public interface AsyncServiceManager extends Object
Administers the services of an IceBox server.

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

  • Method Details

    • startServiceAsync

      CompletionStage<Void> startServiceAsync(String service, Current current) throws AlreadyStartedException, NoSuchServiceException
      Starts a service.
      Parameters:
      service - The service name.
      current - the Current object of the incoming request
      Returns:
      a completion stage that the servant will complete when the invocation completes
      Throws:
      AlreadyStartedException - Thrown when the service is already running.
      NoSuchServiceException - Thrown when IceBox does not know a service named service.

    • stopServiceAsync

      CompletionStage<Void> stopServiceAsync(String service, Current current) throws AlreadyStoppedException, NoSuchServiceException
      Stops a service.
      Parameters:
      service - The service name.
      current - the Current object of the incoming request
      Returns:
      a completion stage that the servant will complete when the invocation completes
      Throws:
      AlreadyStoppedException - Thrown when the service is already stopped.
      NoSuchServiceException - Thrown when IceBox does not know a service named service.

    • isServiceRunningAsync

      CompletionStage<Boolean> isServiceRunningAsync(String service, Current current) throws NoSuchServiceException
      Returns whether a service is running.
      Parameters:
      service - The name of the service to check.
      current - the Current object of the incoming request
      Returns:
      true if the service was started and not stopped; otherwise false.
      Throws:
      NoSuchServiceException - Thrown when IceBox does not know a service named service.

    • addObserverAsync

      CompletionStage<Void> addObserverAsync(ServiceObserverPrx observer, Current current)
      Registers a new observer with this service manager.
      Parameters:
      observer - The new observer.
      current - the Current object of the incoming request
      Returns:
      a completion stage that the servant will complete when the invocation completes

    • shutdownAsync

      CompletionStage<Void> shutdownAsync(Current current)
      Shuts down all services.
      Parameters:
      current - the Current object of the incoming request
      Returns:
      a completion stage that the servant will complete when the invocation completes

    • ice_staticId

      static String ice_staticId()
      Gets the type ID of the associated Slice interface.
      Returns:
      the string "::IceBox::ServiceManager"

    • dispatch

      default CompletionStage<OutgoingResponse> dispatch(IncomingRequest request) throws UserException
      Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.
      Specified by:
      dispatch in interface Object
      Parameters:
      request - the incoming request
      Returns:
      the outgoing response
      Throws:
      UserException - if a UserException is thrown, Ice will marshal it as the response payload.