|
1 /* |
|
2 * Copyright (c) 1997, 2010, 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.api.server; |
|
27 |
|
28 import com.sun.istack.internal.NotNull; |
|
29 import com.sun.xml.internal.ws.server.DefaultResourceInjector; |
|
30 |
|
31 import javax.annotation.PostConstruct; |
|
32 import javax.xml.ws.WebServiceContext; |
|
33 import javax.xml.ws.WebServiceException; |
|
34 |
|
35 /** |
|
36 * Represents a functionality of the container to inject resources |
|
37 * to application service endpoint object (usually but not necessarily as per JavaEE spec.) |
|
38 * |
|
39 * <p> |
|
40 * If {@link Container#getSPI(Class)} returns a valid instance of {@link ResourceInjector}, |
|
41 * The JAX-WS RI will call the {@link #inject} method for each service endpoint |
|
42 * instance that it manages. |
|
43 * |
|
44 * <p> |
|
45 * The JAX-WS RI will be responsible for calling {@link PostConstruct} callback, |
|
46 * so implementations of this class need not do so. |
|
47 * |
|
48 * @author Kohsuke Kawaguchi |
|
49 * @see Container |
|
50 */ |
|
51 public abstract class ResourceInjector { |
|
52 /** |
|
53 * Performs resource injection. |
|
54 * |
|
55 * @param context |
|
56 * {@link WebServiceContext} implementation to be injected into the instance. |
|
57 * @param instance |
|
58 * Instance of the service endpoint class to which resources will be injected. |
|
59 * |
|
60 * @throws WebServiceException |
|
61 * If the resource injection fails. |
|
62 */ |
|
63 public abstract void inject(@NotNull WSWebServiceContext context, @NotNull Object instance); |
|
64 |
|
65 /** |
|
66 * Fallback {@link ResourceInjector} implementation used when the {@link Container} |
|
67 * doesn't provide one. |
|
68 * |
|
69 * <p> |
|
70 * Just inject {@link WSWebServiceContext} and done. |
|
71 */ |
|
72 public static final ResourceInjector STANDALONE = new DefaultResourceInjector(); |
|
73 } |