com.ibm.wsdl.OperationImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of libre-wsdl4j Show documentation

Open and Free WSDL library: Web Services Description Language. Libre-wsdl4j is a fork of WSDL4J 1.6.3. WSL4j is a Java stub generator for WSDL. Many software projects still depends on WSL4j, so the idea is that libre-wsdl4j should be an actively maintained version of this software on GitHub. "WSDL, that's an anchronym i haven't heard in almost ten years." Still big in the enterprise world" - comments on the Internet.

The newest version!

/*
 * (c) Copyright IBM Corp 2001, 2006 
 */

package com.ibm.wsdl;

import java.util.*;
import javax.wsdl.*;

/**
 * This class represents a WSDL operation. It includes information on input, output and fault messages associated with usage of the operation.
 *
 * @author Paul Fremantle ([email protected])
 * @author Nirmal Mukhi ([email protected])
 * @author Matthew J. Duftler ([email protected])
 */
public class OperationImpl extends AbstractWSDLElement implements Operation {
  protected String name = null;
  protected Input input = null;
  protected Output output = null;
  private final Map faults = new HashMap<>();
  private OperationType style = null;
  private List parameterOrder = null;
  private final List nativeAttributeNames = Arrays.asList(Constants.OPERATION_ATTR_NAMES);
  protected boolean isUndefined = true;

  public static final long serialVersionUID = 1;

  /**
   * Set the name of this operation.
   *
   * @param name
   *          the desired name
   */
  @Override
  public void setName(String name) {
    this.name = name;
  }

  /**
   * Get the name of this operation.
   *
   * @return the operation name
   */
  @Override
  public String getName() {
    return name;
  }

  /**
   * Set the input message specification for this operation.
   *
   * @param input
   *          the new input message
   */
  @Override
  public void setInput(Input input) {
    this.input = input;
  }

  /**
   * Get the input message specification for this operation.
   *
   * @return the input message
   */
  @Override
  public Input getInput() {
    return input;
  }

  /**
   * Set the output message specification for this operation.
   *
   * @param output
   *          the new output message
   */
  @Override
  public void setOutput(Output output) {
    this.output = output;
  }

  /**
   * Get the output message specification for this operation.
   *
   * @return the output message specification for the operation
   */
  @Override
  public Output getOutput() {
    return output;
  }

  /**
   * Add a fault message that must be associated with this operation.
   *
   * @param fault
   *          the new fault message
   */
  @Override
  public void addFault(Fault fault) {
    faults.put(fault.getName(), fault);
  }

  /**
   * Get the specified fault message.
   *
   * @param name
   *          the name of the desired fault message.
   * @return the corresponding fault message, or null if there wasn't any matching message
   */
  @Override
  public Fault getFault(String name) {
    return faults.get(name);
  }

  /**
   * Remove the specified fault message.
   *
   * @param name
   *          the name of the fault message to be removed
   * @return the fault message which was removed.
   */
  @Override
  public Fault removeFault(String name) {
    return faults.remove(name);
  }

  /**
   * Get all the fault messages associated with this operation.
   *
   * @return names of fault messages
   */
  @Override
  public Map getFaults() {
    return faults;
  }

  /**
   * Set the style for this operation (request-response, one way, solicit-response or notification).
   *
   * @param style
   *          the new operation style
   */
  @Override
  public void setStyle(OperationType style) {
    this.style = style;
  }

  /**
   * Get the operation type.
   *
   * @return the operation type
   */
  @Override
  public OperationType getStyle() {
    return style;
  }

  /**
   * Set the parameter ordering for a request-response, or solicit-response operation.
   *
   * @param parameterOrder
   *          a list of named parameters containing the part names to reflect the desired order of parameters for RPC-style operations
   */
  @Override
  public void setParameterOrdering(List parameterOrder) {
    this.parameterOrder = parameterOrder;
  }

  /**
   * Get the parameter ordering for this operation.
   *
   * @return the parameter ordering, a list consisting of message part names
   */
  @Override
  public List getParameterOrdering() {
    return parameterOrder;
  }

  @Override
  public void setUndefined(boolean isUndefined) {
    this.isUndefined = isUndefined;
  }

  @Override
  public boolean isUndefined() {
    return isUndefined;
  }

  @Override
  public String toString() {
    StringBuilder strBuf = new StringBuilder();

    strBuf.append("Operation: name=" + name);

    if (parameterOrder != null) {
      strBuf.append("\nparameterOrder=" + parameterOrder);
    }

    if (style != null) {
      strBuf.append("\nstyle=" + style);
    }

    if (input != null) {
      strBuf.append("\n" + input);
    }

    if (output != null) {
      strBuf.append("\n" + output);
    }

    if (faults != null) {
      Iterator faultIterator = faults.values().iterator();

      while (faultIterator.hasNext()) {
        strBuf.append("\n" + faultIterator.next());
      }
    }

    String superString = super.toString();
    if (!superString.equals("")) {
      strBuf.append("\n");
      strBuf.append(superString);
    }

    return strBuf.toString();
  }

  /**
   * Get the list of local attribute names defined for this element in the WSDL specification.
   *
   * @return a List of Strings, one for each local attribute name
   */
  public List getNativeAttributeNames() {
    return nativeAttributeNames;
  }
}