Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Suspendable |
|
| 2.0;2 |
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.suspendable; | |
40 | ||
41 | import java.nio.channels.SelectionKey; | |
42 | ||
43 | /** | |
44 | * An Object representing the result of an suspendable operation like {@link SuspendableFilter@#suspend} | |
45 | * An instance of that class can be used to resume or cancel a suspended connection. | |
46 | * See {@link SuspendableFilter} for more information. | |
47 | * | |
48 | * @author Jeanfrancois Arcand | |
49 | */ | |
50 | public class Suspendable { | |
51 | ||
52 | private SuspendableFilter suspendableFilter; | |
53 | private SelectionKey key; | |
54 | 6 | private boolean isResumed = false; |
55 | ||
56 | 6 | protected Suspendable(SuspendableFilter suspendableFilter) { |
57 | 6 | this.suspendableFilter = suspendableFilter; |
58 | 6 | } |
59 | ||
60 | ||
61 | /** | |
62 | * Resume a suspended connection. If the connection has been resumed, calling | |
63 | * resume with produce an {@link IllegalStateException}. | |
64 | * @return true is resumed. | |
65 | */ | |
66 | public boolean resume() { | |
67 | 2 | if (getKey() == null){ |
68 | 0 | isResumed = true; |
69 | 0 | return isResumed; |
70 | } | |
71 | ||
72 | 2 | isResumed = suspendableFilter.resume(getKey()); |
73 | 2 | return isResumed; |
74 | } | |
75 | ||
76 | ||
77 | /** | |
78 | * Return true if the connection associated with this instance has been {@link #resumed} | |
79 | * | |
80 | * @return true if resumed. | |
81 | */ | |
82 | public boolean isResumed() { | |
83 | 0 | return isResumed; |
84 | } | |
85 | ||
86 | ||
87 | /** | |
88 | * Cancel a suspended connection. If the connection has been {@link #resumed}, calling | |
89 | * resume with produce an {@link IllegalStateException}. | |
90 | * @return true is resumed. | |
91 | */ | |
92 | public void cancel(){ | |
93 | 2 | if (isResumed) { |
94 | 0 | throw new IllegalStateException("Already cancelled"); |
95 | } | |
96 | ||
97 | 2 | if (getKey() == null){ |
98 | 0 | isResumed = true; |
99 | 0 | return; |
100 | } | |
101 | ||
102 | 2 | suspendableFilter.cancel(getKey()); |
103 | 2 | } |
104 | ||
105 | ||
106 | /** | |
107 | * Return the underlying SelectionKey representing the connection. | |
108 | * @return the underlying SelectionKey representing the connection. | |
109 | */ | |
110 | protected SelectionKey getKey() { | |
111 | 8 | return key; |
112 | } | |
113 | ||
114 | ||
115 | /** | |
116 | * Set the underlying SelectionKey. | |
117 | * @param key the underlying SelectionKey. | |
118 | */ | |
119 | protected void setKey(SelectionKey key) { | |
120 | 9 | this.key = key; |
121 | 9 | } |
122 | } |