net.krotscheck.kangaroo.authz.common.database.entity

Enum ClientType

java.lang.Object

java.lang.Enum<ClientType>

net.krotscheck.kangaroo.authz.common.database.entity.ClientType

All Implemented Interfaces:

Serializable, Comparable<ClientType>

public enum ClientType
extends Enum<ClientType>

Different kinds of client types. See OAuth Specification

Author:

Michael Krotscheck

See Also:

https://tools.ietf.org/html/rfc6749#section-4

Enum Constant Summary

Enum Constants

Enum Constant and Description
AuthorizationGrant A Confidential client, such as a server-based web application - which uses the authorization token flow described in section 4.1 in the OAuth2 Specification.
ClientCredentials A confidential client, which attempts to authenticate itself using a client-specific userid and password.
Implicit A Public client, such as a browser javascript application, which uses the Implicit token flow described in section 4.2 of the OAuth2 Specification.
OwnerCredentials A confidential client, which attempts to authenticate using the username and password of an existing account.

Method Summary

Modifier and Type	Method and Description
Boolean	in(ClientType... types) Is the client type one of the passed in list of types?
static ClientType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClientType[]	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

AuthorizationGrant

public static final ClientType AuthorizationGrant

A Confidential client, such as a server-based web application - which uses the authorization token flow described in section 4.1 in the OAuth2 Specification. The use case met is a server-based web application which is permitted to make API calls to the authorization server on behalf of the user.

See Also:

https://tools.ietf.org/html/rfc6749#section-4.1

Implicit

public static final ClientType Implicit

A Public client, such as a browser javascript application, which uses the Implicit token flow described in section 4.2 of the OAuth2 Specification.

See Also:

https://tools.ietf.org/html/rfc6749#section-4.2

OwnerCredentials

public static final ClientType OwnerCredentials

A confidential client, which attempts to authenticate using the username and password of an existing account. Described in section 4.3 of the OAuth2 Specification. This is intended to be a migratory method, and should be used to exchange actual user credentials for an auth token.

See Also:

https://tools.ietf.org/html/rfc6749#section-4.3

ClientCredentials

public static final ClientType ClientCredentials

A confidential client, which attempts to authenticate itself using a client-specific userid and password. This is often used in cases where your server application needs to access resources on the Authorization server, and is described in section 4.4 of the OAuth2 specification.

See Also:

https://tools.ietf.org/html/rfc6749#section-4.4

Method Detail

values

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

Returns:

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

valueOf

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

in

public Boolean in(ClientType... types)

Is the client type one of the passed in list of types?

Parameters:

types - An array of types to check against.

Returns:

True if the type matches, otherwise false.