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

Class Client

java.lang.Object

net.krotscheck.kangaroo.common.hibernate.entity.AbstractEntity

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

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

All Implemented Interfaces:

Cloneable, ICreatedDateEntity, IModifiedDateEntity

@Entity
 @Indexed(index="clients")
 @Analyzer(definition="entity_analyzer")
public final class Client
extends AbstractAuthzEntity

This represents a registered client, as well as it's connection metadata, for a specific application. Multiple different clients may exist per application.

Author:

Michael Krotscheck

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Client.Deserializer Deserialize a reference to an User.

Constructor Summary

Constructors

Constructor and Description
Client()

Method Summary

Modifier and Type	Method and Description
Integer	getAccessTokenExpireIn() Extract the access token expiration time (in seconds) for this client.
Application	getApplication() Get the application this client belongs to.
List<Authenticator>	getAuthenticators() The list of authenticators active in this client.
Integer	getAuthorizationCodeExpiresIn() Extract the authorization code expiration time (in seconds) for this client.
String	getClientSecret() Retrieve the client secret.
Map<String,String>	getConfiguration() Retrieve configuration for this client.
String	getName() Get the name for this client.
User	getOwner() The owner of this entity.
List<ClientRedirect>	getRedirects() Get the valid redirect URI's.
List<ClientReferrer>	getReferrers() Get the list of valid referrers.
Integer	getRefreshTokenExpireIn() Extract the refresh token expiration time (in seconds) for this client.
List<OAuthToken>	getTokens() Get all the tokens issued under this client.
ClientType	getType() Get the client type.
Boolean	isPrivate() Whether this client is private.
Boolean	isPublic() Whether this client is public.
void	setApplication(Application application) Set the application which this client belongs to.
void	setAuthenticators(List<Authenticator> authenticators) Set the authenticators.
void	setClientSecret(String clientSecret) Set the client secret.
void	setConfiguration(Map<String,String> configuration) Set the configuration for this client.
void	setName(String name) Set the client's name.
void	setRedirects(List<ClientRedirect> redirects) Set the list of redirects.
void	setReferrers(List<ClientReferrer> referrers) Update the set of valid referrers.
void	setTokens(List<OAuthToken> tokens) Set the list of tokens for this client.
void	setType(ClientType type) Set the client type.

Methods inherited from class net.krotscheck.kangaroo.common.hibernate.entity.AbstractEntity

clone, equals, getCreatedDate, getId, getModifiedDate, hashCode, setCreatedDate, setId, setModifiedDate, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Client

public Client()

Method Detail

getApplication

public Application getApplication()

Get the application this client belongs to.

Returns:

The application.

setApplication

public void setApplication(Application application)

Set the application which this client belongs to.

Parameters:

application - The new application.

getName

public String getName()

Get the name for this client.

Returns:

The client's human-readable name.

setName

public void setName(String name)

Set the client's name.

Parameters:

name - The name to use, should be human-readable.

getClientSecret

public String getClientSecret()

Retrieve the client secret.

Returns:

The client secret.

setClientSecret

public void setClientSecret(String clientSecret)

Set the client secret.

Parameters:

clientSecret - A new client secret.

getReferrers

public List<ClientReferrer> getReferrers()

Get the list of valid referrers.

Returns:

This client's list of valid referrers.

setReferrers

public void setReferrers(List<ClientReferrer> referrers)

Update the set of valid referrers.

Parameters:

referrers - A new set of referrers.

getRedirects

public List<ClientRedirect> getRedirects()

Get the valid redirect URI's.

Returns:

The valid redirect url's.

setRedirects

public void setRedirects(List<ClientRedirect> redirects)

Set the list of redirects.

Parameters:

redirects - The redirects.

getAuthenticators

public List<Authenticator> getAuthenticators()

The list of authenticators active in this client.

Returns:

The list of authenticators.

setAuthenticators

public void setAuthenticators(List<Authenticator> authenticators)

Set the authenticators.

Parameters:

authenticators - New list of authenticators.

getTokens

public List<OAuthToken> getTokens()

Get all the tokens issued under this client.

Returns:

A list of all tokens (lazy loaded)

setTokens

public void setTokens(List<OAuthToken> tokens)

Set the list of tokens for this client.

Parameters:

tokens - A new list of tokens.

getType

public ClientType getType()

Get the client type.

Returns:

The client type.

setType

public void setType(ClientType type)

Set the client type.

Parameters:

type - The client type!

getConfiguration

public Map<String,String> getConfiguration()

Retrieve configuration for this client.

Returns:

A set of configuration elements, such as token expiry.

setConfiguration

public void setConfiguration(Map<String,String> configuration)

Set the configuration for this client.

Parameters:

configuration - The new configuration.

getAuthorizationCodeExpiresIn

public Integer getAuthorizationCodeExpiresIn()

Extract the authorization code expiration time (in seconds) for this client. This value is derived from the default configuration values, or from a default, if such exists.

Returns:

The expiration horizon of an access token, in seconds.

getAccessTokenExpireIn

public Integer getAccessTokenExpireIn()

Extract the access token expiration time (in seconds) for this client. This value is derived from the default configuration values, or from a default, if such exists.

Returns:

The expiration horizon of an access token, in seconds.

getRefreshTokenExpireIn

public Integer getRefreshTokenExpireIn()

Extract the refresh token expiration time (in seconds) for this client. This value is derived from the default configuration values, or from a default, if such exists.

Returns:

The expiration horizon of an access token, in seconds.

getOwner

public User getOwner()

The owner of this entity.

Specified by:

getOwner in class AbstractAuthzEntity

Returns:

This entity's owner, if it exists.

isPrivate

public Boolean isPrivate()

Whether this client is private.

Returns:

true, if this is a private client, otherwise false.

isPublic

public Boolean isPublic()

Whether this client is public.

Returns:

true, if this is a public client, otherwise false.