1 /*
2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package com.sun.xml.internal.ws.developer;
27 
28 import javax.xml.ws.spi.WebServiceFeatureAnnotation;
29 import javax.xml.bind.JAXBContext;
30 import java.lang.annotation.Documented;
31 import java.lang.annotation.ElementType;
32 import java.lang.annotation.Retention;
33 import java.lang.annotation.RetentionPolicy;
34 import java.lang.annotation.Target;
35 
36 /**
37  * This feature instructs that the specified {@link JAXBContextFactory} be used for performing
38  * data-binding for the SEI.
39  *
40  * <p>
41  * For example,
42  * <pre>
43  * &#64;WebService
44  * &#64;UsesJAXBContext(MyJAXBContextFactory.class)
45  * public class HelloService {
46  *   ...
47  * }
48  * </pre>
49  *
50  * <p>
51  * If your {@link JAXBContextFactory} needs to carry some state from your calling application,
52  * you can use {@link UsesJAXBContextFeature} to pass in an instance of {@link JAXBContextFactory},
53  * instead of using this to specify the type.
54  *
55  * @author Kohsuke Kawaguchi
56  * @since 2.1.5
57  */
58 @Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
59 @Retention(RetentionPolicy.RUNTIME)
60 @Documented
61 @WebServiceFeatureAnnotation(id=UsesJAXBContextFeature.ID,bean=UsesJAXBContextFeature.class)
62 public @interface UsesJAXBContext {
63     /**
64      * Designates the {@link JAXBContextFactory} to be used to create the {@link JAXBContext} object,
65      * which in turn will be used by the JAX-WS runtime to marshal/unmarshal parameters and return
66      * values to/from XML.
67      */
value()68     Class<? extends JAXBContextFactory> value();
69 }
70