Module org.mule.sdk.api

Package org.mule.sdk.api.runtime.parameter

Enum Class HttpParameterPlacement

java.lang.Object

java.lang.Enum<HttpParameterPlacement>

org.mule.sdk.api.runtime.parameter.HttpParameterPlacement

All Implemented Interfaces:

Serializable, Comparable<HttpParameterPlacement>, Constable

@MinMuleVersion("4.5.0")
public enum HttpParameterPlacement
extends Enum<HttpParameterPlacement>

Describes the possible placements a parameter can have inside a HTTP request

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BODY	The parameter will be added as part of an application/x-www-form-urlencoded Http request body
HEADERS	The parameter will be sent as a header
QUERY_PARAMS	The parameter will be sent as a query parameter

Method Summary

Modifier and Type	Method	Description
static HttpParameterPlacement	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HttpParameterPlacement[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

QUERY_PARAMS

@MinMuleVersion("4.5.0")
public static final HttpParameterPlacement QUERY_PARAMS

The parameter will be sent as a query parameter

HEADERS

@MinMuleVersion("4.5.0")
public static final HttpParameterPlacement HEADERS

The parameter will be sent as a header

BODY

@MinMuleVersion("4.5.0")
public static final HttpParameterPlacement BODY

The parameter will be added as part of an application/x-www-form-urlencoded Http request body

Method Details

values

public static HttpParameterPlacement[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static HttpParameterPlacement valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null