org.codehaus.xfire.annotations.WebMethodAnnotation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xfire-annotations Show documentation
Annotation support for XFire
The newest version!
package org.codehaus.xfire.annotations;

import java.io.Serializable;

import org.codehaus.xfire.service.OperationInfo;

/**
 * Represents an common representation of a web method annotation. Specifies that the given method is exposed as a Web
 * Service operation, making it part of the Web Service�s public contract. A WebMethod annotation is required for each
 * method that is published by the Web Service.
 *
 * @author Arjen Poutsma
 */
public class WebMethodAnnotation implements Serializable
{
    private String action = "";
    private String operationName = "";
    private boolean exclude = false;
    
    public boolean isExclude()
    {
        return exclude;
    }

    public void setExclude(boolean exclude)
    {
        this.exclude = exclude;
    }

    /**
     * Returns the action for this operation. For SOAP bindings, this determines the value of the SOAPAction header.
     *
     * @return the action for this operation.
     */
    public String getAction()
    {
        return action;
    }

    /**
     * Sets the action for this operation. For SOAP bindings, this determines the value of the SOAPAction header.
     *
     * @param action the new action for this operation.
     */
    public void setAction(String action)
    {
        this.action = action;
    }

    /**
     * Returns the name of the wsdl:operation matching this method. By default the WSDL operation name will be the same
     * as the Java method name.
     *
     * @return the name of the wsdl:operation matching this method.
     */
    public String getOperationName()
    {
        return operationName;
    }

    /**
     * Sets the name of the wsdl:operation matching this method. By default the WSDL operation name will be the same as
     * the Java method name.
     *
     * @param operationName the new name of the wsdl:operation matching this method.
     */
    public void setOperationName(String operationName)
    {
        this.operationName = operationName;
    }

    /**
     * Populates the given operation info with the information contained in this annotation.
     *
     * @param operationInfo the operation info.
     */
    public void populate(OperationInfo operationInfo)
    {
        if (operationName.length() != 0)
        {
            operationInfo.setName(operationName);
        }
    }

    /**
     * Returns a String representation of this WebMethodAnnotation.
     *
     * @return a string representation.
     */
    public String toString()
    {
        return "WebMethodAnnotation{" +
                "action='" + action + "'" +
                ", operationName='" + operationName + "'" +
                "}";
    }
}