01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.developer.servlet;
38:
39: import com.sun.xml.ws.api.server.InstanceResolverAnnotation;
40: import com.sun.xml.ws.server.servlet.HttpSessionInstanceResolver;
41:
42: import javax.jws.WebService;
43: import javax.servlet.http.HttpSession;
44: import javax.xml.ws.spi.WebServiceFeatureAnnotation;
45: import java.lang.annotation.Documented;
46: import static java.lang.annotation.ElementType.TYPE;
47: import java.lang.annotation.Retention;
48: import static java.lang.annotation.RetentionPolicy.RUNTIME;
49: import java.lang.annotation.Target;
50:
51: /**
52: * Designates a service class that should be tied to {@link HttpSession} scope.
53: *
54: * <p>
55: * When a service class is annotated with this annotation like the following,
56: * the JAX-WS RI runtime will instanciate a new instance of the service class for
57: * each {@link HttpSession}.
58: *
59: * <pre>
60: * @{@link WebService}
61: * @{@link HttpSessionScope}
62: * class CounterService {
63: * protected int count = 0;
64: *
65: * public CounterService() {}
66: *
67: * public int inc() {
68: * return count++;
69: * }
70: * }
71: * </pre>
72: *
73: * <p>
74: * This allows you to use instance fields for storing per-session state
75: * (in the above example, it will create a separate counter for each client.)
76: *
77: * <p>
78: * The service instance will be GCed when the corresponding {@link HttpSession}
79: * is GCed. Refer to servlet documentation for how to configure the timeout behavior.
80: *
81: * @author Kohsuke Kawaguchi
82: * @since JAX-WS 2.1
83: */
84: @Retention(RUNTIME)
85: @Target(TYPE)
86: @Documented
87: @WebServiceFeatureAnnotation(id=HttpSessionScopeFeature.ID,bean=HttpSessionScopeFeature.class)
88: @InstanceResolverAnnotation(HttpSessionInstanceResolver.class)
89: public @interface HttpSessionScope {
90: }
|