com.sun.tools.ws.wsdl.document.Operation Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-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 com.sun.tools.ws.wsdl.document;
import com.sun.codemodel.JClass;
import com.sun.tools.ws.api.wsdl.TWSDLExtensible;
import com.sun.tools.ws.api.wsdl.TWSDLExtension;
import com.sun.tools.ws.api.wsdl.TWSDLOperation;
import com.sun.tools.ws.wsdl.framework.Entity;
import com.sun.tools.ws.wsdl.framework.EntityAction;
import com.sun.tools.ws.wsdl.framework.ExtensibilityHelper;
import org.xml.sax.Locator;
import javax.xml.namespace.QName;
import java.util.*;
/**
* Entity corresponding to the "operation" child element of a "portType" WSDL element.
*
* @author WS Development Team
*/
public class Operation extends Entity implements TWSDLOperation {
public Operation(Locator locator) {
super(locator);
_faults = new ArrayList();
_helper = new ExtensibilityHelper();
}
public String getName() {
return _name;
}
public void setName(String name) {
_name = name;
}
public String getUniqueKey() {
if (_uniqueKey == null) {
StringBuffer sb = new StringBuffer();
sb.append(_name);
sb.append(' ');
if (_input != null) {
sb.append(_input.getName());
} else {
sb.append(_name);
if (_style == OperationStyle.REQUEST_RESPONSE) {
sb.append("Request");
} else if (_style == OperationStyle.SOLICIT_RESPONSE) {
sb.append("Response");
}
}
sb.append(' ');
if (_output != null) {
sb.append(_output.getName());
} else {
sb.append(_name);
if (_style == OperationStyle.SOLICIT_RESPONSE) {
sb.append("Solicit");
} else if (_style == OperationStyle.REQUEST_RESPONSE) {
sb.append("Response");
}
}
_uniqueKey = sb.toString();
}
return _uniqueKey;
}
public OperationStyle getStyle() {
return _style;
}
public void setStyle(OperationStyle s) {
_style = s;
}
public Input getInput() {
return _input;
}
public void setInput(Input i) {
_input = i;
}
public Output getOutput() {
return _output;
}
public void setOutput(Output o) {
_output = o;
}
public void addFault(Fault f) {
_faults.add(f);
}
public Iterable faults() {
return _faults;
}
public String getParameterOrder() {
return _parameterOrder;
}
public void setParameterOrder(String s) {
_parameterOrder = s;
}
public QName getElementName() {
return WSDLConstants.QNAME_OPERATION;
}
public Documentation getDocumentation() {
return _documentation;
}
public void setDocumentation(Documentation d) {
_documentation = d;
}
public void withAllSubEntitiesDo(EntityAction action) {
super.withAllSubEntitiesDo(action);
if (_input != null) {
action.perform(_input);
}
if (_output != null) {
action.perform(_output);
}
for (Fault _fault : _faults) {
action.perform(_fault);
}
_helper.withAllSubEntitiesDo(action);
}
public void accept(WSDLDocumentVisitor visitor) throws Exception {
visitor.preVisit(this);
if (_input != null) {
_input.accept(visitor);
}
if (_output != null) {
_output.accept(visitor);
}
for (Fault _fault : _faults) {
_fault.accept(visitor);
}
visitor.postVisit(this);
}
public void validateThis() {
if (_name == null) {
failValidation("validation.missingRequiredAttribute", "name");
}
if (_style == null) {
failValidation("validation.missingRequiredProperty", "style");
}
// verify operation style
if (_style == OperationStyle.ONE_WAY) {
if (_input == null) {
failValidation("validation.missingRequiredSubEntity", "input");
}
if (_output != null) {
failValidation("validation.invalidSubEntity", "output");
}
if (_faults != null && _faults.size() != 0) {
failValidation("validation.invalidSubEntity", "fault");
}
} else if (_style == OperationStyle.NOTIFICATION) {
if (_parameterOrder != null) {
failValidation("validation.invalidAttribute", "parameterOrder");
}
}
}
public String getNameValue() {
return getName();
}
public String getNamespaceURI() {
return parent.getNamespaceURI();
}
public QName getWSDLElementName() {
return getElementName();
}
/* (non-Javadoc)
* @see TWSDLExtensible#addExtension(ExtensionImpl)
*/
public void addExtension(TWSDLExtension e) {
_helper.addExtension(e);
}
/* (non-Javadoc)
* @see TWSDLExtensible#extensions()
*/
public Iterable extensions() {
return _helper.extensions();
}
public TWSDLExtensible getParent() {
return parent;
}
public void setParent(TWSDLExtensible parent) {
this.parent = parent;
}
public Map getFaults() {
return unmodifiableFaultClassMap;
}
public void putFault(String faultName, JClass exception){
faultClassMap.put(faultName, exception);
}
private TWSDLExtensible parent;
private Documentation _documentation;
private String _name;
private Input _input;
private Output _output;
private List _faults;
private OperationStyle _style;
private String _parameterOrder;
private String _uniqueKey;
private ExtensibilityHelper _helper;
private final Map faultClassMap = new HashMap();
private final Map unmodifiableFaultClassMap = Collections.unmodifiableMap(faultClassMap);
}