net.krotscheck.kangaroo.authz.common.authenticator

Enum AuthenticatorType

java.lang.Object

java.lang.Enum<AuthenticatorType>

net.krotscheck.kangaroo.authz.common.authenticator.AuthenticatorType

All Implemented Interfaces:

Serializable, Comparable<AuthenticatorType>

public enum AuthenticatorType
extends Enum<AuthenticatorType>

An enumeration of authenticator types, to be used for injection and access in the database.

Author:

Michael Krotscheck

Enum Constant Summary

Enum Constants

Enum Constant and Description
Facebook This authenticator uses Facebook's OAuth2 protocol as a simple IdP, discarding the received tokens after use.
Google This authenticator uses Google's OAuth2 protocol as a simple IdP, discarding the received tokens after use.
Password This type describes the password authenticator, which drives our Owner Credentials flow.
Test The test authenticator type, used mostly for our test harness.

Method Summary

Modifier and Type	Method and Description
Boolean	in(AuthenticatorType... types) Return true if the current type is in a list of types.
Boolean	isPrivate() Is this a private authenticator or not?
static AuthenticatorType	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthenticatorType[]	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

Facebook

public static final AuthenticatorType Facebook

This authenticator uses Facebook's OAuth2 protocol as a simple IdP, discarding the received tokens after use.

Google

public static final AuthenticatorType Google

This authenticator uses Google's OAuth2 protocol as a simple IdP, discarding the received tokens after use.

Password

public static final AuthenticatorType Password

This type describes the password authenticator, which drives our Owner Credentials flow. It is considered a private authenticator type, and should not be permitted to be manually set via the admin API.

Test

public static final AuthenticatorType Test

The test authenticator type, used mostly for our test harness. Also a private type, and should not be permitted to be attached to a client.

Method Detail

values

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

Returns:

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

valueOf

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

isPrivate

public Boolean isPrivate()

Is this a private authenticator or not?

Returns:

Boolean if it is private, otherwise false.

in

public Boolean in(AuthenticatorType... types)

Return true if the current type is in a list of types.

Parameters:

types - The list of types to check.

Returns:

True if the type is found, otherwise false.