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