org.mule.module.cxf.CxfPayloadToArguments Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mule-module-cxf Show documentation
A Mule module for web service connectivity using CXF.
There is a newer version: 3.9.0
/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.module.cxf;

import org.mule.api.endpoint.OutboundEndpoint;
import org.mule.transport.NullPayload;

/**
 * This enum defines the strategies to convert a Payload to an array of arguments
 * that will be used to call the webservice in
 * {@link CxfOutboundMessageProcessor#doSendWithClient(org.mule.api.MuleEvent)} and in
 * {@link CxfOutboundMessageProcessor#doSendWithProxy(org.mule.api.MuleEvent)}.
 */
public enum CxfPayloadToArguments
{
    /**
     * In this strategy, if the payload is of type {@link NullPayload} it will be
     * send as a parameter just like any other object.
     */
    NULL_PAYLOAD_AS_PARAMETER(CxfConstants.PAYLOAD_TO_ARGUMENTS_NULL_PAYLOAD_AS_PARAMETER)
    {

    },
    /**
     * In this strategy, if the payload is of type {@link NullPayload} it will not be
     * send as a parameter. The array of arguments in this case will be empty. For
     * the rest of the objects it behaves just like
     * {@link #NULL_PAYLOAD_AS_PARAMETER} (it will delegate to
     * {@link CxfPayloadToArguments#payloadToArrayOfArguments(Object)}).
     */
    NULL_PAYLOAD_AS_VOID(CxfConstants.PAYLOAD_TO_ARGUMENTS_NULL_PAYLOAD_AS_VOID)
    {
        @Override
        public Object[] payloadToArrayOfArguments(Object payload)
        {
            if (payload instanceof NullPayload)
            {
                return new Object[]{};
            }
            else
            {
                return super.payloadToArrayOfArguments(payload);
            }
        }
    };

    /**
     * This is the value that is needed to be configured in the endpoint under
     * property {@link CxfConstants#PAYLOAD_TO_ARGUMENTS} so this
     * {@link CxfPayloadToArguments} is selected on method
     * {@link #getPayloadToArgumentsForEndpoint(OutboundEndpoint)}.
     */
    private final String payloadToArgumentsParameterValue;

    private CxfPayloadToArguments(String payloadToArgumentsParameterValue)
    {
        this.payloadToArgumentsParameterValue = payloadToArgumentsParameterValue;
    }

    /**
     * This method is the one that converts the payload in an array of arguments. In
     * this default implementation if the payload is already an array of
     * {@link Object objects} that array will be returned. Otherwise, an array with
     * one element, the payload, will be returned.
     * 
     * @param payload the payload to convert to array of arguments.
     * @return the array of arguments
     */
    public Object[] payloadToArrayOfArguments(Object payload)
    {
        Object[] args;
        if (payload instanceof Object[])
        {
            args = (Object[]) payload;
        }
        else
        {
            args = new Object[]{payload};
        }
        return args;
    }

    public String getPayloadToArgumentsParameterValue()
    {
        return payloadToArgumentsParameterValue;
    }
}