javax.xml.ws.WebServiceFeature Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.ws;
/**
* A WebServiceFeature is used to represent a feature that can be
* enabled or disabled for a web service.
*
* The JAX-WS specification will define some standard features and
* JAX-WS implementors are free to define additional features if
* necessary. Vendor specific features may not be portable so
* caution should be used when using them. Each Feature definition
* MUST define a {@code public static final String ID}
* that can be used in the Feature annotation to refer
* to the feature. This ID MUST be unique across all features
* of all vendors. When defining a vendor specific feature ID,
* use a vendor specific namespace in the ID string.
*
* @see javax.xml.ws.RespectBindingFeature
* @see javax.xml.ws.soap.AddressingFeature
* @see javax.xml.ws.soap.MTOMFeature
*
* @since 1.6, JAX-WS 2.1
*/
public abstract class WebServiceFeature {
/**
* Each Feature definition MUST define a public static final
* String ID that can be used in the Feature annotation to refer
* to the feature.
*/
// public static final String ID = "some unique feature Identifier";
/**
* Get the unique identifier for this WebServiceFeature.
*
* @return the unique identifier for this feature.
*/
public abstract String getID();
/**
* Specifies if the feature is enabled or disabled
*/
protected boolean enabled = false;
/**
* Default constructor.
*/
protected WebServiceFeature() {}
/**
* Returns {@code true} if this feature is enabled.
*
* @return {@code true} if and only if the feature is enabled .
*/
public boolean isEnabled() {
return enabled;
}
}