Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ProtocolFilter |
|
| 1.0;1 |
1 | /* | |
2 | * | |
3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | |
4 | * | |
5 | * Copyright 2007-2008 Sun Microsystems, Inc. All rights reserved. | |
6 | * | |
7 | * The contents of this file are subject to the terms of either the GNU | |
8 | * General Public License Version 2 only ("GPL") or the Common Development | |
9 | * and Distribution License("CDDL") (collectively, the "License"). You | |
10 | * may not use this file except in compliance with the License. You can obtain | |
11 | * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html | |
12 | * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific | |
13 | * language governing permissions and limitations under the License. | |
14 | * | |
15 | * When distributing the software, include this License Header Notice in each | |
16 | * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt. | |
17 | * Sun designates this particular file as subject to the "Classpath" exception | |
18 | * as provided by Sun in the GPL Version 2 section of the License file that | |
19 | * accompanied this code. If applicable, add the following below the License | |
20 | * Header, with the fields enclosed by brackets [] replaced by your own | |
21 | * identifying information: "Portions Copyrighted [year] | |
22 | * [name of copyright owner]" | |
23 | * | |
24 | * Contributor(s): | |
25 | * | |
26 | * If you wish your version of this file to be governed by only the CDDL or | |
27 | * only the GPL Version 2, indicate your decision by adding "[Contributor] | |
28 | * elects to include this software in this distribution under the [CDDL or GPL | |
29 | * Version 2] license." If you don't indicate a single choice of license, a | |
30 | * recipient has the option to distribute your version of this file under | |
31 | * either the CDDL, the GPL Version 2 or to extend the choice of license to | |
32 | * its licensees as provided above. However, if you add GPL Version 2 code | |
33 | * and therefore, elected the GPL Version 2 license, then the option applies | |
34 | * only if the new code is made subject to such option by the copyright | |
35 | * holder. | |
36 | * | |
37 | */ | |
38 | ||
39 | package com.sun.grizzly; | |
40 | ||
41 | import java.io.IOException; | |
42 | ||
43 | /** | |
44 | * A ProtocolFilter encapsulates a unit of processing work to be performed, | |
45 | * whose purpose is to examine and/or modify the state of a transaction that is | |
46 | * represented by a ProtocolContext. Individual ProtocolFilter can be assembled | |
47 | * into a ProtocolChain, which allows them to either complete the required | |
48 | * processing or delegate further processing to the next ProtocolFilter in the | |
49 | * ProtocolChain. | |
50 | * | |
51 | * ProtocolFilter implementations should be designed in a thread-safe manner, | |
52 | * suitable for inclusion in multiple ProtocolChains that might be processed by | |
53 | * different threads simultaneously. In general, this implies that ProtocolFilter | |
54 | * classes should not maintain state information in instance variables. | |
55 | * Instead, state information should be maintained via suitable modifications to | |
56 | * the attributes of the ProtocolContext that is passed to the execute() and | |
57 | * postExecute() methods. | |
58 | * | |
59 | * ProtocolFilter implementations typically retrieve and store state information | |
60 | * in the ProtocolContext instance that is passed as a parameter to the | |
61 | * execute() and postExecute method, using particular keys into the Map that can | |
62 | * be acquired via ProtocolContext.getAttributes(). | |
63 | * | |
64 | * @author Jeanfrancois Arcand | |
65 | */ | |
66 | public interface ProtocolFilter { | |
67 | ||
68 | ||
69 | public final static String SUCCESSFUL_READ = "succes_read"; | |
70 | ||
71 | ||
72 | /** | |
73 | * Execute a unit of processing work to be performed. This ProtocolFilter | |
74 | * may either complete the required processing and return false, | |
75 | * or delegate remaining processing to the next ProtocolFilter in a | |
76 | * ProtocolChain containing this ProtocolFilter by returning true. | |
77 | * @param ctx {@link Context} | |
78 | * @return | |
79 | * @throws java.io.IOException | |
80 | */ | |
81 | public boolean execute(Context ctx) throws IOException; | |
82 | ||
83 | ||
84 | /** | |
85 | * Execute any cleanup activities, such as releasing resources that were | |
86 | * acquired during the execute() method of this ProtocolFilter instance. | |
87 | * @param ctx {@link Context} | |
88 | * @return | |
89 | * @throws java.io.IOException | |
90 | */ | |
91 | public boolean postExecute(Context ctx) throws IOException; | |
92 | } |