Module org.mule.oauth.client.api

Package org.mule.oauth.client.api.builder

Enum ClientCredentialsLocation

java.lang.Object

java.lang.Enum<ClientCredentialsLocation>

org.mule.oauth.client.api.builder.ClientCredentialsLocation

All Implemented Interfaces:

Serializable, Comparable<ClientCredentialsLocation>

public enum ClientCredentialsLocation
extends Enum<ClientCredentialsLocation>

Enum to define where to send the client credentials in an OAuth2 Dance.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASIC_AUTH_HEADER	Send credentials in an 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 ClientCredentialsLocation	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ClientCredentialsLocation[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BASIC_AUTH_HEADER

public static final ClientCredentialsLocation BASIC_AUTH_HEADER

Send credentials in an Basic Authentication header

BODY

public static final ClientCredentialsLocation BODY

Send credentials encoded in HTTP Body

QUERY_PARAMS

public static final ClientCredentialsLocation QUERY_PARAMS

Send credentials as query parameters

Method Detail

values

public static ClientCredentialsLocation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClientCredentialsLocation c : ClientCredentialsLocation.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClientCredentialsLocation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null