com.sas.services
Interface QuiesceInterface

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
SessionServiceInterface
All Known Implementing Classes:
SessionService, SessionServiceProxy

public interface QuiesceInterface
extends java.rmi.Remote

The QuiesceInterface provides a mechanism for quiescing and/or resuming a service.

A service should directly implement this interface if it is remoteable and it intends to support the quiesce and resume functionality.

Since:
1.1

Method Summary
 void quiesce(UserContextInterface userContext)
          Quiesce the service.
 void resume(UserContextInterface userContext)
          Resume the service.
 

Method Detail

quiesce

void quiesce(UserContextInterface userContext)
             throws ServiceException,
                    QuiesceException,
                    java.rmi.RemoteException
Quiesce the service.

Parameters:
userContext - The user context.
Throws:
ServiceException - If a service error occurs.
QuiesceException - If an error occurs quiescing the service.
java.rmi.RemoteException - If a network anomaly is encountered.

resume

void resume(UserContextInterface userContext)
            throws ServiceException,
                   QuiesceException,
                   java.rmi.RemoteException
Resume the service.

Parameters:
userContext - The user context.
Throws:
ServiceException - If a service error occurs.
QuiesceException - If an error occurs resuming the service.
java.rmi.RemoteException - If a network anomaly is encountered.



Copyright © 2009 SAS Institute Inc. All Rights Reserved.