src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/ResourceInjector.java

changeset 286
f50545b5e2f1
child 368
0989ad8c0860
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/ResourceInjector.java	Tue Mar 06 16:09:35 2012 -0800
     1.3 @@ -0,0 +1,73 @@
     1.4 +/*
     1.5 + * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.xml.internal.ws.api.server;
    1.30 +
    1.31 +import com.sun.istack.internal.NotNull;
    1.32 +import com.sun.xml.internal.ws.server.DefaultResourceInjector;
    1.33 +
    1.34 +import javax.annotation.PostConstruct;
    1.35 +import javax.xml.ws.WebServiceContext;
    1.36 +import javax.xml.ws.WebServiceException;
    1.37 +
    1.38 +/**
    1.39 + * Represents a functionality of the container to inject resources
    1.40 + * to application service endpoint object (usually but not necessarily as per JavaEE spec.)
    1.41 + *
    1.42 + * <p>
    1.43 + * If {@link Container#getSPI(Class)} returns a valid instance of {@link ResourceInjector},
    1.44 + * The JAX-WS RI will call the {@link #inject} method for each service endpoint
    1.45 + * instance that it manages.
    1.46 + *
    1.47 + * <p>
    1.48 + * The JAX-WS RI will be responsible for calling {@link PostConstruct} callback,
    1.49 + * so implementations of this class need not do so.
    1.50 + *
    1.51 + * @author Kohsuke Kawaguchi
    1.52 + * @see Container
    1.53 + */
    1.54 +public abstract class ResourceInjector {
    1.55 +    /**
    1.56 +     * Performs resource injection.
    1.57 +     *
    1.58 +     * @param context
    1.59 +     *      {@link WebServiceContext} implementation to be injected into the instance.
    1.60 +     * @param instance
    1.61 +     *      Instance of the service endpoint class to which resources will be injected.
    1.62 +     *
    1.63 +     * @throws WebServiceException
    1.64 +     *      If the resource injection fails.
    1.65 +     */
    1.66 +    public abstract void inject(@NotNull WSWebServiceContext context, @NotNull Object instance);
    1.67 +
    1.68 +    /**
    1.69 +     * Fallback {@link ResourceInjector} implementation used when the {@link Container}
    1.70 +     * doesn't provide one.
    1.71 +     *
    1.72 +     * <p>
    1.73 +     * Just inject {@link WSWebServiceContext} and done.
    1.74 +     */
    1.75 +    public static final ResourceInjector STANDALONE = new DefaultResourceInjector();
    1.76 +}

mercurial