View Javadoc

1   /*
2    * Copyright 1999-2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
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   */
16  package org.apache.struts.flow.core;
17  
18  /***
19   * ContinuationsDisposer declares the contract for the clean-up of specfic 
20   * continuations.
21   * <p>
22   * Typically a {@link Interpreter} implementation that produces continuation 
23   * objects which require proper clean up will implement this interface to get
24   * a call-back in the event of the ContinuationsManager deciding to invalidate 
25   * a WebContinuation. 
26   */
27  public interface ContinuationsDisposer {
28      /***
29       * Disposes the passed continuation object.
30       * <p>
31       * This method is called from the ContinuationsManager in the event of
32       * the invalidation of a continuation upon the {@link ContinuationsDisposer}
33       * object passed during the creation of the WebContinuation.
34       * 
35       * @param webContinuation the {@link WebContinuation} value representing the  
36       * continuation object. 
37       */
38      public void disposeContinuation(WebContinuation webContinuation);
39  }