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

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
alanb@368 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.xml.internal.ws.api;
ohair@286 27
alanb@368 28 import com.sun.xml.internal.ws.api.server.Container;
alanb@368 29 import com.sun.xml.internal.ws.api.server.WSEndpoint;
alanb@368 30 import com.sun.xml.internal.ws.client.Stub;
ohair@286 31 import javax.xml.ws.WebServiceFeature;
ohair@286 32
ohair@286 33 /**
ohair@286 34 * Allows registration of a {@link Component} against the {@link ComponentRegistry} implementations
ohair@286 35 * of the {@link Container}, {@link WSEndpoint}, {@link WSService}, or {@link Stub}. The
ohair@286 36 * registration is guaranteed to occur early in the initialization of these objects prior to tubeline creation
ohair@286 37 * (applicable to endpoint and stub only).
ohair@286 38 * <p>
ohair@286 39 * Because the Container is shared among all Stubs created from a common WSService object, this feature must
ohair@286 40 * be passed during WSService initialization in order to register a Component against the client-side Container.
ohair@286 41 * <p>
ohair@286 42 * IllegalArgumentException will be thrown if the feature is used with an inappropriate target, e.g. stub target
ohair@286 43 * used during WSEndpoint initialization.
ohair@286 44 *
ohair@286 45 * @since 2.2.6
ohair@286 46 */
ohair@286 47 public class ComponentFeature extends WebServiceFeature implements ServiceSharedFeatureMarker {
ohair@286 48 /**
ohair@286 49 * Targets the object on which the Component will be registered
ohair@286 50 *
ohair@286 51 */
ohair@286 52 public static enum Target {
ohair@286 53 CONTAINER, ENDPOINT, SERVICE, STUB
ohair@286 54 }
ohair@286 55
ohair@286 56 private final Component component;
ohair@286 57 private final Target target;
ohair@286 58
ohair@286 59 /**
ohair@286 60 * Constructs ComponentFeature with indicated component and that is targeted at the Container.
ohair@286 61 * @param component component
ohair@286 62 */
ohair@286 63 public ComponentFeature(Component component) {
ohair@286 64 this(component, Target.CONTAINER);
ohair@286 65 }
ohair@286 66
ohair@286 67 /**
ohair@286 68 * Constructs ComponentFeature with indicated component and target
ohair@286 69 * @param component component
ohair@286 70 * @param target target
ohair@286 71 */
ohair@286 72 public ComponentFeature(Component component, Target target) {
ohair@286 73 this.enabled = true;
ohair@286 74 this.component = component;
ohair@286 75 this.target = target;
ohair@286 76 }
ohair@286 77
ohair@286 78 @Override
ohair@286 79 public String getID() {
ohair@286 80 return ComponentFeature.class.getName();
ohair@286 81 }
ohair@286 82
ohair@286 83 /**
ohair@286 84 * Retrieves component
ohair@286 85 * @return component
ohair@286 86 */
ohair@286 87 public Component getComponent() {
ohair@286 88 return component;
ohair@286 89 }
ohair@286 90
ohair@286 91 /**
ohair@286 92 * Retrieves target
ohair@286 93 * @return target
ohair@286 94 */
ohair@286 95 public Target getTarget() {
ohair@286 96 return target;
ohair@286 97 }
ohair@286 98 }

mercurial