net.krotscheck.kangaroo.authz.oauth2.authn

Enum O2AuthScheme

java.lang.Object

java.lang.Enum<O2AuthScheme>

net.krotscheck.kangaroo.authz.oauth2.authn.O2AuthScheme

All Implemented Interfaces:

Serializable, Comparable<O2AuthScheme>

public enum O2AuthScheme
extends Enum<O2AuthScheme>

A list of authentication methods which are valid for incoming OAuth2 Requests.

Author:

Michael Krotscheck

Enum Constant Summary

Enum Constants

Enum Constant and Description
BearerToken This request was authorized via a bearer token.
ClientPrivate This request was authorized via a private client, i.e.
ClientPublic This request was authorized via a public client, i.e.
None No authentication was included.

Method Summary

Modifier and Type	Method and Description
Boolean	isAuth() Is this an authentication scheme?
static O2AuthScheme	valueOf(String name) Returns the enum constant of this type with the specified name.
static O2AuthScheme[]	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

ClientPublic

public static final O2AuthScheme ClientPublic

This request was authorized via a public client, i.e. a client which does not have an attached secret.

ClientPrivate

public static final O2AuthScheme ClientPrivate

This request was authorized via a private client, i.e. a client with a valid paired client secret.

BearerToken

public static final O2AuthScheme BearerToken

This request was authorized via a bearer token.

None

public static final O2AuthScheme None

No authentication was included.

Method Detail

values

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

Returns:

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

valueOf

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

isAuth

public Boolean isAuth()

Is this an authentication scheme?

Returns:

True if so, otherwise false.