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