org.genesys.blocks.oauth.model

Class OAuthClient

java.lang.Object

org.genesys.blocks.model.EmptyModel

org.genesys.blocks.model.BasicModel

org.genesys.blocks.model.VersionedModel

org.genesys.blocks.model.AuditedVersionedModel

org.genesys.blocks.security.model.AclSid

org.genesys.blocks.oauth.model.OAuthClient

All Implemented Interfaces:

Serializable, Activatable, Copyable<OAuthClient>, EntityId, org.springframework.data.domain.Persistable<Long>, org.springframework.security.oauth2.provider.ClientDetails

@Entity
public class OAuthClient
extends AclSid
implements org.springframework.security.oauth2.provider.ClientDetails, Copyable<OAuthClient>

OAuth Client information.

Author:

Matija Obreza

See Also:

Serialized Form

Field Summary

Fields inherited from class org.genesys.blocks.model.VersionedModel

active

Fields inherited from interface org.genesys.blocks.model.Copyable

COPYABLE_FIELDS

Constructor Summary

Constructors

Constructor and Description
OAuthClient() Instantiates a new o auth client.

Method Summary

Modifier and Type	Method and Description
OAuthClient	apply(OAuthClient source)
OAuthClient	copy() Returns null.
Integer	getAccessTokenValidity() Gets the access token validity.
Integer	getAccessTokenValiditySeconds()
Map<String,Object>	getAdditionalInformation()
Set<String>	getAllowedOrigins()
Collection<org.springframework.security.core.GrantedAuthority>	getAuthorities()
Set<String>	getAuthorizedGrantTypes()
boolean	getAutoApprove() Gets the auto approve.
protected String	getAutoApproveScope() Gets the auto approve scope.
Set<String>	getAutoApproveScopes() Gets the auto approve scopes.
String	getClientId()
String	getClientSecret()
String	getDescription() Gets the description.
String	getFullName() Subclasses should override this method and return a sensible display name for the SID.
String	getGrants() Gets the grants.
String	getOrigins()
String	getRedirect() Gets the redirect.
Integer	getRefreshTokenValidity() Gets the refresh token validity.
Integer	getRefreshTokenValiditySeconds()
Set<String>	getRegisteredRedirectUri()
String	getResource() Gets the resource.
Set<String>	getResourceIds()
Collection<OAuthRole>	getRoles() Gets the roles.
Set<String>	getScope()
String	getTitle() Gets the title.
boolean	isAutoApprove(String scope)
boolean	isScoped()
boolean	isSecretRequired() Client secret is required when provided.
void	setAccessTokenValidity(Integer accessTokenValidity) Sets the access token validity.
void	setAdditionalInformation(Map<String,Object> additionalInformation) Sets the additional information.
void	setAllowedOrigins(Set<String> allowedOrigins)
void	setAutoApprove(boolean autoApprove) Sets the auto approve.
protected void	setAutoApproveScope(String autoApproveScope) Sets the auto approve scope.
void	setAutoApproveScopes(Set<String> autoApproveScopes) Sets the auto approve scopes.
void	setClientId(String clientId) Sets the client id.
void	setClientSecret(String clientSecret) Sets the client secret.
void	setDescription(String description) Sets the description.
void	setGrants(String grants) Sets the grants.
void	setGrantTypes(Set<String> grantTypes) Sets the grant types.
void	setOrigins(String origins)
void	setRedirect(String redirect) Sets the redirect.
void	setRedirectUris(Set<String> redirectUris) Sets the redirect uris.
void	setRefreshTokenValidity(Integer refreshTokenValidity) Sets the refresh token validity.
void	setResource(String resource) Sets the resource.
void	setResourceIds(Set<String> resourceIds) Sets the resource ids.
void	setRoles(Set<OAuthRole> roles) Sets the roles.
void	setScope(String scope) Sets the scope.
void	setScopes(Set<String> scopes) Sets the scopes.
void	setTitle(String title) Sets the title.

Methods inherited from class org.genesys.blocks.security.model.AclSid

getAclEntries, getObjectIdentities, getSid, isPrincipal, setAclEntries, setObjectIdentities, setPrincipal, setSid

Methods inherited from class org.genesys.blocks.model.AuditedVersionedModel

getCreatedBy, getCreatedDate, getLastModifiedBy, getLastModifiedDate, setCreatedBy, setCreatedDate, setLastModifiedBy, setLastModifiedDate

Methods inherited from class org.genesys.blocks.model.VersionedModel

equals, getVersion, hashCode, isActive, setActive, setVersion, toString

Methods inherited from class org.genesys.blocks.model.BasicModel

getId, isNew, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.genesys.blocks.model.Copyable

copyList

Constructor Detail

OAuthClient

public OAuthClient()

Instantiates a new o auth client.

Method Detail

getClientId

public String getClientId()

Specified by:

getClientId in interface org.springframework.security.oauth2.provider.ClientDetails

setClientId

public void setClientId(String clientId)

Sets the client id.

Parameters:

clientId - the new client id

getClientSecret

public String getClientSecret()

Specified by:

getClientSecret in interface org.springframework.security.oauth2.provider.ClientDetails

setClientSecret

public void setClientSecret(String clientSecret)

Sets the client secret.

Parameters:

clientSecret - the new client secret

getResource

public String getResource()

Gets the resource.

Returns:

the resource

setResource

public void setResource(String resource)

Sets the resource.

Parameters:

resource - the new resource

getGrants

public String getGrants()

Gets the grants.

Returns:

the grants

setGrants

public void setGrants(String grants)

Sets the grants.

Parameters:

grants - the new grants

getRedirect

public String getRedirect()

Gets the redirect.

Returns:

the redirect

setRedirect

public void setRedirect(String redirect)

Sets the redirect.

Parameters:

redirect - the new redirect

getRoles

public Collection<OAuthRole> getRoles()

Gets the roles.

Returns:

the roles

setRoles

public void setRoles(Set<OAuthRole> roles)

Sets the roles.

Parameters:

roles - the new roles

setScope

public void setScope(String scope)

Sets the scope.

Parameters:

scope - the new scope

setAutoApprove

public void setAutoApprove(boolean autoApprove)

Sets the auto approve.

Parameters:

autoApprove - the new auto approve

getAutoApprove

public boolean getAutoApprove()

Gets the auto approve.

Returns:

the auto approve

getAutoApproveScope

protected String getAutoApproveScope()

Gets the auto approve scope.

Returns:

the auto approve scope

setAutoApproveScope

protected void setAutoApproveScope(String autoApproveScope)

Sets the auto approve scope.

Parameters:

autoApproveScope - the new auto approve scope

getAutoApproveScopes

public Set<String> getAutoApproveScopes()

Gets the auto approve scopes.

Returns:

the auto approve scopes

setAutoApproveScopes

public void setAutoApproveScopes(Set<String> autoApproveScopes)

Sets the auto approve scopes.

Parameters:

autoApproveScopes - the new auto approve scopes

getResourceIds

public Set<String> getResourceIds()

Specified by:

getResourceIds in interface org.springframework.security.oauth2.provider.ClientDetails

setResourceIds

public void setResourceIds(Set<String> resourceIds)

Sets the resource ids.

Parameters:

resourceIds - the new resource ids

isSecretRequired

public boolean isSecretRequired()

Client secret is required when provided.

Specified by:

isSecretRequired in interface org.springframework.security.oauth2.provider.ClientDetails

Returns:

true, if is secret required

isScoped

public boolean isScoped()

Specified by:

isScoped in interface org.springframework.security.oauth2.provider.ClientDetails

getScope

public Set<String> getScope()

Specified by:

getScope in interface org.springframework.security.oauth2.provider.ClientDetails

setScopes

public void setScopes(Set<String> scopes)

Sets the scopes.

Parameters:

scopes - the new scopes

getAuthorizedGrantTypes

public Set<String> getAuthorizedGrantTypes()

Specified by:

getAuthorizedGrantTypes in interface org.springframework.security.oauth2.provider.ClientDetails

setGrantTypes

public void setGrantTypes(Set<String> grantTypes)

Sets the grant types.

Parameters:

grantTypes - the new grant types

getRegisteredRedirectUri

public Set<String> getRegisteredRedirectUri()

Specified by:

getRegisteredRedirectUri in interface org.springframework.security.oauth2.provider.ClientDetails

setRedirectUris

public void setRedirectUris(Set<String> redirectUris)

Sets the redirect uris.

Parameters:

redirectUris - the new redirect uris

getAuthorities

public Collection<org.springframework.security.core.GrantedAuthority> getAuthorities()

Specified by:

getAuthorities in interface org.springframework.security.oauth2.provider.ClientDetails

getAccessTokenValiditySeconds

public Integer getAccessTokenValiditySeconds()

Specified by:

getAccessTokenValiditySeconds in interface org.springframework.security.oauth2.provider.ClientDetails

getAccessTokenValidity

public Integer getAccessTokenValidity()

Gets the access token validity.

Returns:

the access token validity

setAccessTokenValidity

public void setAccessTokenValidity(Integer accessTokenValidity)

Sets the access token validity.

Parameters:

accessTokenValidity - the new access token validity

getRefreshTokenValiditySeconds

public Integer getRefreshTokenValiditySeconds()

Specified by:

getRefreshTokenValiditySeconds in interface org.springframework.security.oauth2.provider.ClientDetails

getRefreshTokenValidity

public Integer getRefreshTokenValidity()

Gets the refresh token validity.

Returns:

the refresh token validity

setRefreshTokenValidity

public void setRefreshTokenValidity(Integer refreshTokenValidity)

Sets the refresh token validity.

Parameters:

refreshTokenValidity - the new refresh token validity

isAutoApprove

public boolean isAutoApprove(String scope)

Specified by:

isAutoApprove in interface org.springframework.security.oauth2.provider.ClientDetails

getAdditionalInformation

public Map<String,Object> getAdditionalInformation()

Specified by:

getAdditionalInformation in interface org.springframework.security.oauth2.provider.ClientDetails

setAdditionalInformation

public void setAdditionalInformation(Map<String,Object> additionalInformation)

Sets the additional information.

Parameters:

additionalInformation - the additional information

setTitle

public void setTitle(String title)

Sets the title.

Parameters:

title - the new title

getTitle

public String getTitle()

Gets the title.

Returns:

the title

setDescription

public void setDescription(String description)

Sets the description.

Parameters:

description - the new description

getDescription

public String getDescription()

Gets the description.

Returns:

the description

getFullName

public String getFullName()

Description copied from class: AclSid

Subclasses should override this method and return a sensible display name for the SID.

Overrides:

getFullName in class AclSid

Returns:

SID full name

copy

public OAuthClient copy()

Returns null.

Specified by:

copy in interface Copyable<OAuthClient>

Returns:

the o auth client

apply

public OAuthClient apply(OAuthClient source)

Specified by:

apply in interface Copyable<OAuthClient>

getOrigins

public String getOrigins()

setOrigins

public void setOrigins(String origins)

getAllowedOrigins

public Set<String> getAllowedOrigins()

setAllowedOrigins

public void setAllowedOrigins(Set<String> allowedOrigins)