Package org.refcodes.net

Enum OauthField

java.lang.Object

java.lang.Enum<OauthField>

org.refcodes.net.OauthField

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OauthField>, org.refcodes.mixin.PathAccessor, HeaderFieldAccessor

public enum OauthField
extends java.lang.Enum<OauthField>
implements org.refcodes.mixin.PathAccessor, HeaderFieldAccessor

The Enum OauthField.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.net.HeaderFieldAccessor

HeaderFieldAccessor.HeaderFieldBuilder<B extends HeaderFieldAccessor.HeaderFieldBuilder<B>>, HeaderFieldAccessor.HeaderFieldMutator, HeaderFieldAccessor.HeaderFieldProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.PathAccessor

org.refcodes.mixin.PathAccessor.PathBuilder<B extends org.refcodes.mixin.PathAccessor.PathBuilder<?>>, org.refcodes.mixin.PathAccessor.PathMutator, org.refcodes.mixin.PathAccessor.PathProperty

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCESS_TOKEN	The access token, see also TokenType.
EXPIRES_IN
REFRESH_TOKEN
SCOPE	OAuth scopes let you specify exactly how your application needs to access a user's resource.
TOKEN_TYPE

Method Summary

Modifier and Type	Method	Description
static OauthField	fromHeaderField(HeaderField aHeaderField)
static OauthField	fromPath(java.lang.String aPath)
HeaderField	getHeaderField()	Retrieves the HeaderField from the HeaderField property.
java.lang.String	getPath()
static OauthField	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static OauthField[]	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

SCOPE

public static final OauthField SCOPE

OAuth scopes let you specify exactly how your application needs to access a user's resource. Scope is specified on either the authorization or token endpoints using the parameter scope. Scope is expressed as a set of case-sensitive and space-delimited strings. The authorization server may override the scope request, in this case it must include scope in its response to inform a client of their actual scope. When a scope is not specified, the server may either fallback to a well-documented default, or fail the request.

EXPIRES_IN

public static final OauthField EXPIRES_IN

REFRESH_TOKEN

public static final OauthField REFRESH_TOKEN

TOKEN_TYPE

public static final OauthField TOKEN_TYPE

ACCESS_TOKEN

public static final OauthField ACCESS_TOKEN

The access token, see also TokenType.

Method Detail

values

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

Returns:

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

valueOf

public static OauthField 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

getHeaderField

public HeaderField getHeaderField()

Retrieves the HeaderField from the HeaderField property.

Specified by:

getHeaderField in interface HeaderFieldAccessor

Returns:

The HeaderField stored by the HeaderField property.

getPath

public java.lang.String getPath()

Specified by:

getPath in interface org.refcodes.mixin.PathAccessor

fromPath

public static OauthField fromPath(java.lang.String aPath)

fromHeaderField

public static OauthField fromHeaderField(HeaderField aHeaderField)