net.krotscheck.kangaroo.authz.oauth2.authn

Class O2Principal

java.lang.Object

net.krotscheck.kangaroo.authz.oauth2.authn.O2Principal

All Implemented Interfaces:

Principal

public final class O2Principal
extends Object
implements Principal

The authorization pricipal for the OAuth server.

Author:

Michael Krotscheck

Constructor Summary

Constructors

Constructor and Description
O2Principal() Create a new Principal with no authentication.
O2Principal(Client client) Create a new principal from a authClient.
O2Principal(OAuthToken token) Create a new principal from an OAuth token.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Assert equality between objects based on values.
Client	getContext() The client request context.
String	getName() Return the name of the current principal.
OAuthToken	getOAuthToken() Retrieve the OAuth token.
String	getScheme() Return the authentication scheme used for this principal.
int	hashCode() Generate a hash code for this entity.
boolean	implies(Subject subject) Implication assertion.
O2Principal	merge(Principal newPrincipal) Merge a new principal's values into this principal.
protected <T extends AbstractEntity> T	sameOrOne(T left, T right) Assert that only one entity is set, none, or that both are identical.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.security.Principal

toString

Constructor Detail

O2Principal

public O2Principal()

Create a new Principal with no authentication.

O2Principal

public O2Principal(Client client)

Create a new principal from a authClient.

Parameters:

client - A authClient.

O2Principal

public O2Principal(OAuthToken token)

Create a new principal from an OAuth token. Note that this constructor does not validate the input parameter.

Parameters:

token - The token to wrap.

Method Detail

getOAuthToken

public OAuthToken getOAuthToken()

Retrieve the OAuth token.

Returns:

The wrapped token.

sameOrOne

protected <T extends AbstractEntity> T sameOrOne(T left,
                                                 T right)

Assert that only one entity is set, none, or that both are identical.

Type Parameters:

T - Raw type of abstract entity, used to determine return type.

Parameters:

left - A left entity.

right - A right entity.

Returns:

The set entity, or null.

Throws:

RFC6749.AccessDeniedException - If both are set.

getName

public String getName()

Return the name of the current principal.

Specified by:

getName in interface Principal

Returns:

The 'name' of the current principal.

implies

public boolean implies(Subject subject)

Implication assertion. Not implemented.

Specified by:

implies in interface Principal

Parameters:

subject - The subject.

Returns:

Always returns false.

getScheme

public String getScheme()

Return the authentication scheme used for this principal.

Returns:

The principal.

getContext

public Client getContext()

The client request context.

Returns:

The client within whose context we should evaluate this request.

merge

public O2Principal merge(Principal newPrincipal)

Merge a new principal's values into this principal. This method will throw exceptions based on conflicts, or will return a new principal instance that contains the merged values.

Parameters:

newPrincipal - The new principal values to merge into the existing one.

Returns:

A new principal.

equals

public boolean equals(Object o)

Assert equality between objects based on values.

Specified by:

equals in interface Principal

Overrides:

equals in class Object

Parameters:

o - The value to check.

Returns:

True if they are equal, otherwise false.

hashCode

public int hashCode()

Generate a hash code for this entity.

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

Returns:

The generated hash code.