com.dtflys.forest.extensions

Enum OAuth2.TokenAt

java.lang.Object

java.lang.Enum<OAuth2.TokenAt>

com.dtflys.forest.extensions.OAuth2.TokenAt

All Implemented Interfaces:

Serializable, Comparable<OAuth2.TokenAt>

Enclosing class:

OAuth2

public static enum OAuth2.TokenAt
extends Enum<OAuth2.TokenAt>

Token 信息位置

Since:

1.5.0-BETA9

Author:

HouKunLin

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEADER 请求头
URL 请求内容

Method Summary

Modifier and Type	Method and Description
String	getTokenPrefix()
String	getTokenValue(String defaultPrefix, String token) 获得 Token 值
String	getTokenVariable()
String	getTokenVariable(String defaultTokenVariable) 获取变量名
static OAuth2.TokenAt	valueOf(String name) Returns the enum constant of this type with the specified name.
static OAuth2.TokenAt[]	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

HEADER

public static final OAuth2.TokenAt HEADER

请求头

URL

public static final OAuth2.TokenAt URL

请求内容

Method Detail

values

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

Returns:

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

valueOf

public static OAuth2.TokenAt 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

getTokenVariable

public String getTokenVariable()

getTokenPrefix

public String getTokenPrefix()

getTokenVariable

public String getTokenVariable(String defaultTokenVariable)

获取变量名

Parameters:

defaultTokenVariable - 默认的变量名，这个参数传入的应该为 @OAuth2.tokenVariable 的值

Returns:

变量名

getTokenValue

public String getTokenValue(String defaultPrefix,
                            String token)

获得 Token 值

Parameters:

defaultPrefix - 默认的前缀，这个参数传入的应该为 @OAuth2.tokenPrefix 的值

token - 实际的 Token 值

Returns:

Token 值