Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.security

Enum Class CredentialsPlacement

java.lang.Object

java.lang.Enum<CredentialsPlacement>

org.mule.runtime.extension.api.security.CredentialsPlacement

All Implemented Interfaces:

Serializable, Comparable<CredentialsPlacement>, Constable

@MinMuleVersion("4.2.1")
public enum CredentialsPlacement
extends Enum<CredentialsPlacement>

Describes the possible placements credentials can have inside a HTTP request

Since:

1.2.1

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
BASIC_AUTH_HEADER	Send credentials in a Basic Authentication header
BODY	Send credentials encoded in HTTP Body
QUERY_PARAMS	Send credentials as query parameters

Method Summary

Modifier and Type	Method	Description
static CredentialsPlacement	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CredentialsPlacement[]	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

BASIC_AUTH_HEADER

public static final CredentialsPlacement BASIC_AUTH_HEADER

Send credentials in a Basic Authentication header

BODY

public static final CredentialsPlacement BODY

Send credentials encoded in HTTP Body

QUERY_PARAMS

public static final CredentialsPlacement QUERY_PARAMS

Send credentials as query parameters

Method Details

values

public static CredentialsPlacement[] 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 CredentialsPlacement 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