org.sape.carbon.core.component.lifecycle
Interface Suspendable

All Known Subinterfaces:

ComponentLifecycle

All Known Implementing Classes:

AbstractTotalCache, DefaultDeploymentServiceImpl, DefaultSchedulerServiceImpl, DefaultThreadPoolImpl

public interface Suspendable

This interface should be implemented by Components that require (re)configurability. More specifically:

1. Safe reconfiguration, at the expense of interrupted service

2. The explicit ability to suspend and resume the component as a management feature

Copyright 2002 Sapient

Since:

carbon 1.0

Version:

$Revision: 1.9 $($Author: dvoet $ / $Date: 2003/05/05 21:21:13 $)

Author:

Chris Herron, January 2002

Method Summary

void	resume() Resume the component.
void	suspend() Suspend the component.

Method Detail

suspend

public void suspend()
             throws Exception

Suspend the component. This is an opportunity to 'pause' any ongoing work". Prior to calling this method, the container will block requests for service to the component.

Throws:

Exception - when there is a failure to suspend the component

resume

public void resume()
            throws Exception

Resume the component. This implies "picking-up where you left off". On return of this method, the container will resume forwarding service requests to the component.

Throws:

Exception - when there is a failure to resume the component