org.springframework.social.oauth2

Enum TokenStrategy

java.lang.Object

java.lang.Enum<TokenStrategy>

org.springframework.social.oauth2.TokenStrategy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TokenStrategy>

public enum TokenStrategy
extends java.lang.Enum<TokenStrategy>

Strategy enumeration where each value carries an interceptor defining how an access token is carried on API requests.

Author:

Craig Walls

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESS_TOKEN_PARAMETER Indicates that the access token should be carried as a query parameter named "access_token".
AUTHORIZATION_HEADER Indicates that the access token should be carried in the Authorization header as an OAuth2 Bearer token.
OAUTH_TOKEN_PARAMETER Indicates that the access token should be carried as a query parameter named "oauth_token".

Method Summary

Methods

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

AUTHORIZATION_HEADER

public static final TokenStrategy AUTHORIZATION_HEADER

Indicates that the access token should be carried in the Authorization header as an OAuth2 Bearer token.

ACCESS_TOKEN_PARAMETER

public static final TokenStrategy ACCESS_TOKEN_PARAMETER

Indicates that the access token should be carried as a query parameter named "access_token".

OAUTH_TOKEN_PARAMETER

public static final TokenStrategy OAUTH_TOKEN_PARAMETER

Indicates that the access token should be carried as a query parameter named "oauth_token".

Method Detail

values

public static TokenStrategy[] 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 (TokenStrategy c : TokenStrategy.values())
    System.out.println(c);

Returns:

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

valueOf

public static TokenStrategy valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null