com.broadleafcommerce.auth.user.autoconfigure

Class AuthorizationServerProperties.OAuth2

java.lang.Object

com.broadleafcommerce.auth.user.autoconfigure.AuthorizationServerProperties.OAuth2

Enclosing class:

AuthorizationServerProperties

public static class AuthorizationServerProperties.OAuth2
extends Object

Constructor Summary

Constructors

Constructor and Description
OAuth2()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<String>	getAdditionalAudiences() Corresponds to the aud JWT claim.
String	getEncodedPrivateKey() Base64-encoded version of the private key used to generate tokens.
String	getEncodedPublicKey() Base64-encoded version of the public key used to generate tokens.
Duration	getImpersonatedSessionDuration() The max session duration for an impersonated session.
String	getIssuer() Used in validation of JWT to ensure that the system that issued the token (this one) is the same as the one passed in the token.
Set<String>	getWhitelistedImpersonationAuthorities() The whitelist of GrantedAuthority that will be inherited when a user is impersonated by a CSR user.
int	hashCode()
void	setAdditionalAudiences(List<String> additionalAudiences) Corresponds to the aud JWT claim.
void	setEncodedPrivateKey(String encodedPrivateKey) Base64-encoded version of the private key used to generate tokens.
void	setEncodedPublicKey(String encodedPublicKey) Base64-encoded version of the public key used to generate tokens.
void	setImpersonatedSessionDuration(Duration impersonatedSessionDuration) The max session duration for an impersonated session.
void	setIssuer(String issuer) Used in validation of JWT to ensure that the system that issued the token (this one) is the same as the one passed in the token.
void	setWhitelistedImpersonationAuthorities(Set<String> whitelistedImpersonationAuthorities) The whitelist of GrantedAuthority that will be inherited when a user is impersonated by a CSR user.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2

public OAuth2()

Method Detail

getEncodedPrivateKey

public String getEncodedPrivateKey()

Base64-encoded version of the private key used to generate tokens. Used for encrypting both the JWT authorization tokens as well as stateless session cookies.

getEncodedPublicKey

public String getEncodedPublicKey()

Base64-encoded version of the public key used to generate tokens. Used for encrypting both the JWT authorization tokens as well as stateless session cookies.

getIssuer

public String getIssuer()

Used in validation of JWT to ensure that the system that issued the token (this one) is the same as the one passed in the token. Corresponds to the iss JWT claim

getAdditionalAudiences

public List<String> getAdditionalAudiences()

Corresponds to the aud JWT claim. Usually contains the iss claim

getImpersonatedSessionDuration

public Duration getImpersonatedSessionDuration()

The max session duration for an impersonated session. This controls how long a CSR will have a session authenticated as the impersonated user.

getWhitelistedImpersonationAuthorities

public Set<String> getWhitelistedImpersonationAuthorities()

The whitelist of GrantedAuthority that will be inherited when a user is impersonated by a CSR user. This set of authorities serves as a whitelist of the authorities that are inherited by the impersonated user session.

This set only restricts the authorities permitted, but it will not result in authorities being inherited that the CSR does not originally have.

See Also:

for where the impersonation is first initiated, for usage of this property to inherit authorities

setEncodedPrivateKey

public void setEncodedPrivateKey(String encodedPrivateKey)

Base64-encoded version of the private key used to generate tokens. Used for encrypting both the JWT authorization tokens as well as stateless session cookies.

setEncodedPublicKey

public void setEncodedPublicKey(String encodedPublicKey)

Base64-encoded version of the public key used to generate tokens. Used for encrypting both the JWT authorization tokens as well as stateless session cookies.

setIssuer

public void setIssuer(String issuer)

Used in validation of JWT to ensure that the system that issued the token (this one) is the same as the one passed in the token. Corresponds to the iss JWT claim

setAdditionalAudiences

public void setAdditionalAudiences(List<String> additionalAudiences)

Corresponds to the aud JWT claim. Usually contains the iss claim

setImpersonatedSessionDuration

public void setImpersonatedSessionDuration(Duration impersonatedSessionDuration)

The max session duration for an impersonated session. This controls how long a CSR will have a session authenticated as the impersonated user.

setWhitelistedImpersonationAuthorities

public void setWhitelistedImpersonationAuthorities(Set<String> whitelistedImpersonationAuthorities)

The whitelist of GrantedAuthority that will be inherited when a user is impersonated by a CSR user. This set of authorities serves as a whitelist of the authorities that are inherited by the impersonated user session.

This set only restricts the authorities permitted, but it will not result in authorities being inherited that the CSR does not originally have.

See Also:

for where the impersonation is first initiated, for usage of this property to inherit authorities

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object