aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.ws.api;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.ws.api.server.Container;
aoqi@0: import com.sun.xml.internal.ws.api.server.WSEndpoint;
aoqi@0: import com.sun.xml.internal.ws.client.Stub;
aoqi@0: import javax.xml.ws.WebServiceFeature;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Allows registration of a {@link Component} against the {@link ComponentRegistry} implementations
aoqi@0:  * of the {@link Container}, {@link WSEndpoint}, {@link WSService}, or {@link Stub}.  The
aoqi@0:  * registration is guaranteed to occur early in the initialization of these objects prior to tubeline creation
aoqi@0:  * (applicable to endpoint and stub only).
aoqi@0:  * <p>
aoqi@0:  * Because the Container is shared among all Stubs created from a common WSService object, this feature must
aoqi@0:  * be passed during WSService initialization in order to register a Component against the client-side Container.
aoqi@0:  * <p>
aoqi@0:  * IllegalArgumentException will be thrown if the feature is used with an inappropriate target, e.g. stub target
aoqi@0:  * used during WSEndpoint initialization.
aoqi@0:  *
aoqi@0:  * @since 2.2.6
aoqi@0:  */
aoqi@0: public class ComponentFeature extends WebServiceFeature implements ServiceSharedFeatureMarker {
aoqi@0:     /**
aoqi@0:      * Targets the object on which the Component will be registered
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public static enum Target {
aoqi@0:         CONTAINER, ENDPOINT, SERVICE, STUB
aoqi@0:     }
aoqi@0: 
aoqi@0:     private final Component component;
aoqi@0:     private final Target target;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Constructs ComponentFeature with indicated component and that is targeted at the Container.
aoqi@0:      * @param component component
aoqi@0:      */
aoqi@0:     public ComponentFeature(Component component) {
aoqi@0:         this(component, Target.CONTAINER);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Constructs ComponentFeature with indicated component and target
aoqi@0:      * @param component component
aoqi@0:      * @param target target
aoqi@0:      */
aoqi@0:     public ComponentFeature(Component component, Target target) {
aoqi@0:         this.enabled = true;
aoqi@0:         this.component = component;
aoqi@0:         this.target = target;
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public String getID() {
aoqi@0:         return ComponentFeature.class.getName();
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Retrieves component
aoqi@0:      * @return component
aoqi@0:      */
aoqi@0:     public Component getComponent() {
aoqi@0:         return component;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Retrieves target
aoqi@0:      * @return target
aoqi@0:      */
aoqi@0:     public Target getTarget() {
aoqi@0:         return target;
aoqi@0:     }
aoqi@0: }