01: /**
02: * Copyright 2006 Webmedia Group Ltd.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: **/package org.araneaframework.framework;
16:
17: import java.io.Serializable;
18: import org.araneaframework.Service;
19:
20: /**
21: * This context allows to abort the current execution flow and pass control to a provided continuation service. The continuation service will
22: * be rendered on the current and subsequent request until it explicitly passes control back using {@link org.araneaframework.framework.ContinuationContext#finish()}. This
23: * will end the continuation and restore control back.
24: *
25: * @author "Toomas Römer" <toomas@webmedia.ee>
26: * @author Jevgeni Kabanov (ekabanov <i>at</i> araneaframework <i>dot</i> org)
27: */
28: public interface ContinuationManagerContext extends Serializable {
29: /**
30: * Returns whether a continuation is already registered during this request and is ready to run. In such a case it is unsafe
31: * to override the continuation using {@link #start(Service)}.
32: */
33: public boolean isRunning();
34:
35: /**
36: * Starts the continuation (by registering it and then throwing and exception, thus passing control to the continuation manager).
37: */
38: public void start(Service continuation);
39:
40: /**
41: * Does same as {@link #start(Service)}, however after the first request passes through the continuation will return control
42: * back to the starting component.
43: */
44: public void runOnce(Service continuation);
45: }
|