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/ComponentFeature.java Tue Mar 06 16:09:35 2012 -0800
1.3 @@ -0,0 +1,95 @@
1.4 +/*
1.5 + * Copyright (c) 1997, 2011, 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;
1.30 +
1.31 +import javax.xml.ws.WebServiceFeature;
1.32 +
1.33 +/**
1.34 + * Allows registration of a {@link Component} against the {@link ComponentRegistry} implementations
1.35 + * of the {@link Container}, {@link WSEndpoint}, {@link WSService}, or {@link Stub}. The
1.36 + * registration is guaranteed to occur early in the initialization of these objects prior to tubeline creation
1.37 + * (applicable to endpoint and stub only).
1.38 + * <p>
1.39 + * Because the Container is shared among all Stubs created from a common WSService object, this feature must
1.40 + * be passed during WSService initialization in order to register a Component against the client-side Container.
1.41 + * <p>
1.42 + * IllegalArgumentException will be thrown if the feature is used with an inappropriate target, e.g. stub target
1.43 + * used during WSEndpoint initialization.
1.44 + *
1.45 + * @since 2.2.6
1.46 + */
1.47 +public class ComponentFeature extends WebServiceFeature implements ServiceSharedFeatureMarker {
1.48 + /**
1.49 + * Targets the object on which the Component will be registered
1.50 + *
1.51 + */
1.52 + public static enum Target {
1.53 + CONTAINER, ENDPOINT, SERVICE, STUB
1.54 + }
1.55 +
1.56 + private final Component component;
1.57 + private final Target target;
1.58 +
1.59 + /**
1.60 + * Constructs ComponentFeature with indicated component and that is targeted at the Container.
1.61 + * @param component component
1.62 + */
1.63 + public ComponentFeature(Component component) {
1.64 + this(component, Target.CONTAINER);
1.65 + }
1.66 +
1.67 + /**
1.68 + * Constructs ComponentFeature with indicated component and target
1.69 + * @param component component
1.70 + * @param target target
1.71 + */
1.72 + public ComponentFeature(Component component, Target target) {
1.73 + this.enabled = true;
1.74 + this.component = component;
1.75 + this.target = target;
1.76 + }
1.77 +
1.78 + @Override
1.79 + public String getID() {
1.80 + return ComponentFeature.class.getName();
1.81 + }
1.82 +
1.83 + /**
1.84 + * Retrieves component
1.85 + * @return component
1.86 + */
1.87 + public Component getComponent() {
1.88 + return component;
1.89 + }
1.90 +
1.91 + /**
1.92 + * Retrieves target
1.93 + * @return target
1.94 + */
1.95 + public Target getTarget() {
1.96 + return target;
1.97 + }
1.98 +}
