Package ca.cdr.api.model.json

Class OAuth2WritableClientDetailsJson

java.lang.Object

ca.cdr.api.model.json.OAuth2WritableClientDetailsJson

All Implemented Interfaces:

IHasAuthorities, IModelJson, IModelJson, Serializable, ClientDetails

Direct Known Subclasses:

OAuth2ClientDetailsJson

public class OAuth2WritableClientDetailsJson
extends Object
implements ClientDetails, IHasAuthorities, IModelJson

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_ID
static final String	CLIENT_NAME
static final String	CLIENT_SECRET_JOINED_DELIMITER
static final String	CLIENTID_PATTERN
static final String	ENABLED
static final String	PID

Fields inherited from interface ca.uhn.fhir.model.api.IModelJson

SENSITIVE_DATA_FILTER_NAME

Constructor Summary

Constructors

Constructor	Description
OAuth2WritableClientDetailsJson()	Constructor
OAuth2WritableClientDetailsJson(OAuth2WritableClientDetailsJson theClientDetailsJson)

Method Summary

Modifier and Type	Method	Description
void	addAllowedGrantType(OAuth2AuthorizedGrantTypeEnum theGrantType)
void	addAllowedGrantType(String theName)
void	addAutoApproveScopeIfNotBlank(String theScope)
void	addAutoGrantScopeIfNotBlank(String theScope)
OAuth2ClientSecretJson	addClientSecret()
OAuth2WritableClientDetailsJson	addClientSecret(OAuth2ClientSecretJson theSecret)
OAuth2ClientSecretJson	addClientSecret(String theSecret)
OAuth2ClientSecretJson	addClientSecret(String theSecret, Date theExpiration)
void	addPermission(PermissionEnum thePermission)
void	addPermission(PermissionEnum thePermission, String theArgument)
void	addPermission(GrantedAuthorityJson thePermission)
void	addRedirectUrlIfNotBlank(String theRedirectUrl)
OAuth2WritableClientDetailsJson	addScopeIfNotBlank(String theScope)
Integer	getAccessTokenValiditySeconds()	The access token validity period for this client.
Map<String,Object>	getAdditionalInformation()	Additional information for this client, not needed by the vanilla OAuth protocol but might be useful, for example, for storing descriptive information.
TreeSet<OAuth2AuthorizedGrantTypeEnum>	getAllowedGrantTypes()
Date	getArchivedAt()
Collection<org.springframework.security.core.GrantedAuthority>	getAuthorities()	This method is a part of the Spring Security framework, and returns an unmodifiable copy of the client authorities.
Set<String>	getAuthorizedGrantTypes()	The grant types for which this client is authorized.
TreeSet<String>	getAutoApproveScopes()
String	getAutoApproveScopesSpaceSeparated()
TreeSet<String>	getAutoGrantScopes()
String	getAutoGrantScopesSpaceSeparated()
String	getClientId()	The client id.
String	getClientName()
String	getClientSecret()	The client secret.
Optional<OAuth2ClientSecretJson>	getClientSecret(Long thePid)
List<OAuth2ClientSecretJson>	getClientSecrets()
String	getJwksUrl()
List<GrantedAuthorityJson>	getPermissions()	Returns the authorities that are granted to the user/session
Long	getPid()
String	getPublicJwks()
Integer	getRefreshTokenValiditySeconds()	The refresh token validity period for this client.
TreeSet<String>	getRegisteredRedirectUri()	The pre-defined redirect URI for this client to use during the "authorization_code" access grant.
String	getRegisteredRedirectUriOnePerLine()
TreeSet<String>	getRegisteredRedirectUris()
Set<String>	getResourceIds()	The resources that this client can access.
Set<String>	getScope()	The scope of this client.
Set<String>	getScopes()
String	getScopeSpaceSeparated()
boolean	hasAutoApproveScopes()
boolean	hasAutoGrantScopes()
boolean	hasScope()
boolean	isAlwaysRequireApproval()
boolean	isAttestationAccepted()
boolean	isAutoApprove(String theScope)	Test whether client needs user approval for a particular scope.
boolean	isCanIntrospectAnyTokens()
boolean	isCanIntrospectOwnTokens()
boolean	isCanReissueTokens()
boolean	isCreatedByAppSphere()
boolean	isEnabled()
boolean	isFixedScope()
boolean	isRememberApprovedScopes()
boolean	isScoped()	Whether this client is limited to a specific scope.
boolean	isSecretClientCanChange()
boolean	isSecretRequired()	Whether a secret is required to authenticate this client.
void	removePermission(PermissionEnum thePermission, String theArgument)
void	removePermission(GrantedAuthorityJson thePermission)
void	setAccessTokenValiditySeconds(Integer theAccessTokenValiditySeconds)
void	setAllowedGrantTypes(TreeSet<OAuth2AuthorizedGrantTypeEnum> theAllowedGrantTypes)
void	setAlwaysRequireApproval(boolean theAlwaysRequireApproval)
void	setArchivedAt(Date theArchivedAt)
void	setAttestationAccepted(boolean theAttestationAccepted)
void	setAutoApproveScopes(TreeSet<String> theAutoApproveScopes)
void	setAutoGrantScopes(TreeSet<String> theAutoGrantScopes)
void	setCanIntrospectAnyTokens(boolean theCanIntrospectAnyTokens)
void	setCanIntrospectOwnTokens(boolean theCanIntrospectOwnTokens)
void	setCanReissueTokens(boolean theCanReissueTokens)
OAuth2WritableClientDetailsJson	setClientId(String theClientId)
void	setClientName(String theClientName)
void	setClientSecrets(List<OAuth2ClientSecretJson> theClientSecrets)
void	setCreatedByAppSphere(boolean theCreatedByAppSphere)
void	setEnabled(boolean theEnabled)
void	setFixedScope(boolean theFixedScope)
void	setJwksUrl(String theJwksUrl)
void	setPermissions(List<GrantedAuthorityJson> thePermissions)
OAuth2WritableClientDetailsJson	setPid(Long myPid)
void	setPublicJwks(String thePublicJwks)
void	setRefreshTokenValiditySeconds(Integer theRefreshTokenValiditySeconds)
void	setRegisteredRedirectUris(Iterable<String> theRegisteredRedirectUri)
void	setRegisteredRedirectUris(TreeSet<String> theRegisteredRedirectUris)
void	setRememberApprovedScopes(boolean theRememberApprovedScopes)
void	setScope(TreeSet<String> theScope)
void	setScopes(TreeSet<String> theScope)
void	setSecretClientCanChange(boolean theSecretClientCanChange)
void	setSecretRequired(boolean theSecretRequired)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.cdr.api.model.json.IHasAuthorities

addAuthority, addAuthority, addAuthority, hasArgumentsForAuthority, hasAuthority

Field Details

CLIENTID_PATTERN

public static final String CLIENTID_PATTERN

See Also:

• Constant Field Values

CLIENT_ID

public static final String CLIENT_ID

See Also:

• Constant Field Values

CLIENT_NAME

public static final String CLIENT_NAME

See Also:

• Constant Field Values

ENABLED

public static final String ENABLED

See Also:

• Constant Field Values

PID

public static final String PID

See Also:

• Constant Field Values

CLIENT_SECRET_JOINED_DELIMITER

public static final String CLIENT_SECRET_JOINED_DELIMITER

See Also:

• Constant Field Values

Constructor Details

OAuth2WritableClientDetailsJson

public OAuth2WritableClientDetailsJson()

Constructor

OAuth2WritableClientDetailsJson

public OAuth2WritableClientDetailsJson(OAuth2WritableClientDetailsJson theClientDetailsJson)

Method Details

getJwksUrl

public String getJwksUrl()

setJwksUrl

public void setJwksUrl(String theJwksUrl)

getPublicJwks

public String getPublicJwks()

setPublicJwks

public void setPublicJwks(String thePublicJwks)

getPermissions

public List<GrantedAuthorityJson> getPermissions()

Description copied from interface: IHasAuthorities

Returns the authorities that are granted to the user/session

Specified by:

getPermissions in interface IHasAuthorities

setPermissions

public void setPermissions(List<GrantedAuthorityJson> thePermissions)

addAllowedGrantType

public void addAllowedGrantType(String theName)

addAllowedGrantType

public void addAllowedGrantType(@Nonnull
 OAuth2AuthorizedGrantTypeEnum theGrantType)

addAutoApproveScopeIfNotBlank

public void addAutoApproveScopeIfNotBlank(String theScope)

addRedirectUrlIfNotBlank

public void addRedirectUrlIfNotBlank(String theRedirectUrl)

addScopeIfNotBlank

public OAuth2WritableClientDetailsJson addScopeIfNotBlank(String theScope)

getAccessTokenValiditySeconds

public Integer getAccessTokenValiditySeconds()

Description copied from interface: ClientDetails

The access token validity period for this client. Null if not set explicitly (implementations might use that fact to provide a default value for instance).

Specified by:

getAccessTokenValiditySeconds in interface ClientDetails

Returns:

the access token validity period

setAccessTokenValiditySeconds

public void setAccessTokenValiditySeconds(Integer theAccessTokenValiditySeconds)

getAdditionalInformation

public Map<String,Object> getAdditionalInformation()

Description copied from interface: ClientDetails

Additional information for this client, not needed by the vanilla OAuth protocol but might be useful, for example, for storing descriptive information.

Specified by:

getAdditionalInformation in interface ClientDetails

Returns:

a map of additional information

getAllowedGrantTypes

public TreeSet<OAuth2AuthorizedGrantTypeEnum> getAllowedGrantTypes()

setAllowedGrantTypes

public void setAllowedGrantTypes(TreeSet<OAuth2AuthorizedGrantTypeEnum> theAllowedGrantTypes)

getAuthorities

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

This method is a part of the Spring Security framework, and returns an unmodifiable copy of the client authorities. Use getPermissions() if you want to modify the actual values.

Specified by:

getAuthorities in interface ClientDetails

Returns:

the authorities (never null)

getAuthorizedGrantTypes

public Set<String> getAuthorizedGrantTypes()

Description copied from interface: ClientDetails

The grant types for which this client is authorized.

Specified by:

getAuthorizedGrantTypes in interface ClientDetails

Returns:

The grant types for which this client is authorized.

hasAutoApproveScopes

public boolean hasAutoApproveScopes()

hasAutoGrantScopes

public boolean hasAutoGrantScopes()

getAutoApproveScopes

@Nonnull
public TreeSet<String> getAutoApproveScopes()

setAutoApproveScopes

public void setAutoApproveScopes(TreeSet<String> theAutoApproveScopes)

getAutoGrantScopes

@Nonnull
public TreeSet<String> getAutoGrantScopes()

setAutoGrantScopes

public void setAutoGrantScopes(TreeSet<String> theAutoGrantScopes)

getAutoApproveScopesSpaceSeparated

public String getAutoApproveScopesSpaceSeparated()

getAutoGrantScopesSpaceSeparated

public String getAutoGrantScopesSpaceSeparated()

getClientId

public String getClientId()

Description copied from interface: ClientDetails

The client id.

Specified by:

getClientId in interface ClientDetails

Returns:

The client id.

setClientId

public OAuth2WritableClientDetailsJson setClientId(String theClientId)

getClientName

public String getClientName()

setClientName

public void setClientName(String theClientName)

getClientSecret

public String getClientSecret()

Description copied from interface: ClientDetails

The client secret. Ignored if the secret isn't required.

Specified by:

getClientSecret in interface ClientDetails

Returns:

The client secret.

getClientSecrets

public List<OAuth2ClientSecretJson> getClientSecrets()

setClientSecrets

public void setClientSecrets(List<OAuth2ClientSecretJson> theClientSecrets)

getPid

public Long getPid()

setPid

public OAuth2WritableClientDetailsJson setPid(Long myPid)

getRefreshTokenValiditySeconds

public Integer getRefreshTokenValiditySeconds()

Description copied from interface: ClientDetails

The refresh token validity period for this client. Null for default value set by token service, and zero or negative for non-expiring tokens.

Specified by:

getRefreshTokenValiditySeconds in interface ClientDetails

Returns:

the refresh token validity period

setRefreshTokenValiditySeconds

public void setRefreshTokenValiditySeconds(Integer theRefreshTokenValiditySeconds)

getRegisteredRedirectUri

@Nonnull
public TreeSet<String> getRegisteredRedirectUri()

Description copied from interface: ClientDetails

The pre-defined redirect URI for this client to use during the "authorization_code" access grant. See OAuth spec, section 4.1.1.

Specified by:

getRegisteredRedirectUri in interface ClientDetails

Returns:

The pre-defined redirect URI for this client.

getRegisteredRedirectUris

public TreeSet<String> getRegisteredRedirectUris()

setRegisteredRedirectUris

public void setRegisteredRedirectUris(TreeSet<String> theRegisteredRedirectUris)

setRegisteredRedirectUris

public void setRegisteredRedirectUris(Iterable<String> theRegisteredRedirectUri)

getRegisteredRedirectUriOnePerLine

public String getRegisteredRedirectUriOnePerLine()

getResourceIds

public Set<String> getResourceIds()

Description copied from interface: ClientDetails

The resources that this client can access. Can be ignored by callers if empty.

Specified by:

getResourceIds in interface ClientDetails

Returns:

The resources of this client.

hasScope

public boolean hasScope()

getScope

@Nonnull
public Set<String> getScope()

Description copied from interface: ClientDetails

The scope of this client. Empty if the client isn't scoped.

Specified by:

getScope in interface ClientDetails

Returns:

The scope of this client.

setScope

public void setScope(TreeSet<String> theScope)

getScopes

public Set<String> getScopes()

setScopes

public void setScopes(TreeSet<String> theScope)

getScopeSpaceSeparated

public String getScopeSpaceSeparated()

isAlwaysRequireApproval

public boolean isAlwaysRequireApproval()

setAlwaysRequireApproval

public void setAlwaysRequireApproval(boolean theAlwaysRequireApproval)

isAutoApprove

public boolean isAutoApprove(String theScope)

Description copied from interface: ClientDetails

Test whether client needs user approval for a particular scope.

Specified by:

isAutoApprove in interface ClientDetails

Parameters:

theScope - the scope to consider

Returns:

true if this client does not need user approval

isCanIntrospectAnyTokens

public boolean isCanIntrospectAnyTokens()

setCanIntrospectAnyTokens

public void setCanIntrospectAnyTokens(boolean theCanIntrospectAnyTokens)

isCanIntrospectOwnTokens

public boolean isCanIntrospectOwnTokens()

setCanIntrospectOwnTokens

public void setCanIntrospectOwnTokens(boolean theCanIntrospectOwnTokens)

isFixedScope

public boolean isFixedScope()

setFixedScope

public void setFixedScope(boolean theFixedScope)

isScoped

public boolean isScoped()

Description copied from interface: ClientDetails

Whether this client is limited to a specific scope. If false, the scope of the authentication request will be ignored.

Specified by:

isScoped in interface ClientDetails

Returns:

Whether this client is limited to a specific scope.

isSecretRequired

public boolean isSecretRequired()

Description copied from interface: ClientDetails

Whether a secret is required to authenticate this client.

Specified by:

isSecretRequired in interface ClientDetails

Returns:

Whether a secret is required to authenticate this client.

setSecretRequired

public void setSecretRequired(boolean theSecretRequired)

isSecretClientCanChange

public boolean isSecretClientCanChange()

setSecretClientCanChange

public void setSecretClientCanChange(boolean theSecretClientCanChange)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean theEnabled)

getClientSecret

public Optional<OAuth2ClientSecretJson> getClientSecret(Long thePid)

addClientSecret

public OAuth2WritableClientDetailsJson addClientSecret(OAuth2ClientSecretJson theSecret)

addClientSecret

public OAuth2ClientSecretJson addClientSecret(String theSecret)

addClientSecret

public OAuth2ClientSecretJson addClientSecret()

addClientSecret

public OAuth2ClientSecretJson addClientSecret(String theSecret,
 Date theExpiration)

isCanReissueTokens

public boolean isCanReissueTokens()

setCanReissueTokens

public void setCanReissueTokens(boolean theCanReissueTokens)

addAutoGrantScopeIfNotBlank

public void addAutoGrantScopeIfNotBlank(String theScope)

addPermission

public void addPermission(GrantedAuthorityJson thePermission)

addPermission

public void addPermission(PermissionEnum thePermission,
 String theArgument)

addPermission

public void addPermission(PermissionEnum thePermission)

removePermission

public void removePermission(PermissionEnum thePermission,
 String theArgument)

removePermission

public void removePermission(GrantedAuthorityJson thePermission)

isRememberApprovedScopes

public boolean isRememberApprovedScopes()

setRememberApprovedScopes

public void setRememberApprovedScopes(boolean theRememberApprovedScopes)

isAttestationAccepted

public boolean isAttestationAccepted()

setAttestationAccepted

public void setAttestationAccepted(boolean theAttestationAccepted)

getArchivedAt

public Date getArchivedAt()

setArchivedAt

public void setArchivedAt(Date theArchivedAt)

isCreatedByAppSphere

public boolean isCreatedByAppSphere()

setCreatedByAppSphere

public void setCreatedByAppSphere(boolean theCreatedByAppSphere)