Class AADB2CProperties
- java.lang.Object
-
- com.azure.spring.autoconfigure.b2c.AADB2CProperties
-
- All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean
@Validated @ConfigurationProperties(prefix="azure.activedirectory.b2c") public class AADB2CProperties extends Object implements org.springframework.beans.factory.InitializingBean
Configuration properties for Azure Active Directory B2C.
-
-
Field Summary
Fields Modifier and Type Field Description protected static StringDEFAULT_KEY_PASSWORD_RESETThe default user flow key 'password-reset'.protected static StringDEFAULT_KEY_SIGN_UP_OR_SIGN_INThe default user flow key 'sign-up-or-sign-in'.static StringDEFAULT_LOGOUT_SUCCESS_URLDefault logout success URLstatic StringPREFIXPrefix
-
Constructor Summary
Constructors Constructor Description AADB2CProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidafterPropertiesSet()StringgetAppIdUri()Gets the app ID URI.Map<String,Object>getAuthenticateAdditionalParameters()Gets the additional authenticate parameters.Map<String,AuthorizationClientProperties>getAuthorizationClients()Gets the authorization clients.StringgetBaseUri()Gets the base URI.StringgetClientId()Gets the client ID.StringgetClientSecret()Gets the client secret.intgetJwtConnectTimeout()Gets the JWT connect timeout.intgetJwtReadTimeout()Get the JWT read timeout.intgetJwtSizeLimit()Gets the JWT size limit.StringgetLoginFlow()Gets the login flow.StringgetLogoutSuccessUrl()Gets the logout success URL.protected StringgetPasswordReset()Gets the password reset.StringgetReplyUrl()Gets the reply URL.StringgetTenant()Get tenant name for TelemetryStringgetTenantId()Gets the tenant ID.Map<String,String>getUserFlows()Gets the user flows.StringgetUserNameAttributeName()Gets the username attribute name.booleanisAllowTelemetry()Deprecated.Determined by HTTP header User-Agent insteadvoidsetAllowTelemetry(boolean allowTelemetry)Sets whether telemetry is allowed.voidsetAppIdUri(String appIdUri)Sets the app ID URI.voidsetAuthenticateAdditionalParameters(Map<String,Object> authenticateAdditionalParameters)Sets the additional authenticate parameters.voidsetAuthorizationClients(Map<String,AuthorizationClientProperties> authorizationClients)Sets the authorization clients.voidsetBaseUri(String baseUri)Sets the base URI.voidsetClientId(String clientId)Sets the client ID.voidsetClientSecret(String clientSecret)Sets the client secret.voidsetJwtConnectTimeout(int jwtConnectTimeout)Sets the JWT connect timeout.voidsetJwtReadTimeout(int jwtReadTimeout)Sets the JWT read timeout.voidsetJwtSizeLimit(int jwtSizeLimit)Sets the JWT size limit.voidsetLoginFlow(String loginFlow)Sets the login flow.voidsetLogoutSuccessUrl(String logoutSuccessUrl)Sets the logout success URL.voidsetReplyUrl(String replyUrl)Sets the reply URL.voidsetTenant(String tenant)Sets the tenant.voidsetTenantId(String tenantId)Sets the tenant ID.voidsetUserFlows(Map<String,String> userFlows)Sets the user flows.voidsetUserNameAttributeName(String userNameAttributeName)Sets the username attribute name.
-
-
-
Field Detail
-
DEFAULT_LOGOUT_SUCCESS_URL
public static final String DEFAULT_LOGOUT_SUCCESS_URL
Default logout success URL- See Also:
- Constant Field Values
-
PREFIX
public static final String PREFIX
Prefix- See Also:
- Constant Field Values
-
DEFAULT_KEY_SIGN_UP_OR_SIGN_IN
protected static final String DEFAULT_KEY_SIGN_UP_OR_SIGN_IN
The default user flow key 'sign-up-or-sign-in'.- See Also:
- Constant Field Values
-
DEFAULT_KEY_PASSWORD_RESET
protected static final String DEFAULT_KEY_PASSWORD_RESET
The default user flow key 'password-reset'.- See Also:
- Constant Field Values
-
-
Method Detail
-
afterPropertiesSet
public void afterPropertiesSet()
- Specified by:
afterPropertiesSetin interfaceorg.springframework.beans.factory.InitializingBean
-
getPasswordReset
protected String getPasswordReset()
Gets the password reset.- Returns:
- the password reset
-
getBaseUri
public String getBaseUri()
Gets the base URI.- Returns:
- the base URI
-
setBaseUri
public void setBaseUri(String baseUri)
Sets the base URI.- Parameters:
baseUri- the base URI
-
setTenant
public void setTenant(String tenant)
Sets the tenant.- Parameters:
tenant- the tenant
-
getTenant
@DeprecatedConfigurationProperty(reason="Configuration updated to baseUri", replacement="azure.activedirectory.b2c.base-uri") public String getTenant()Get tenant name for Telemetry- Returns:
- tenant name
- Throws:
AADB2CConfigurationException- resolve tenant name failed
-
setUserFlows
public void setUserFlows(Map<String,String> userFlows)
Sets the user flows.- Parameters:
userFlows- the user flows
-
getLoginFlow
public String getLoginFlow()
Gets the login flow.- Returns:
- the login flow
-
setLoginFlow
public void setLoginFlow(String loginFlow)
Sets the login flow.- Parameters:
loginFlow- the login flow
-
getClientId
public String getClientId()
Gets the client ID.- Returns:
- the client ID
-
setClientId
public void setClientId(String clientId)
Sets the client ID.- Parameters:
clientId- the client ID
-
getClientSecret
public String getClientSecret()
Gets the client secret.- Returns:
- the client secret
-
setClientSecret
public void setClientSecret(String clientSecret)
Sets the client secret.- Parameters:
clientSecret- the client secret
-
getLogoutSuccessUrl
public String getLogoutSuccessUrl()
Gets the logout success URL.- Returns:
- the logout success URL
-
setLogoutSuccessUrl
public void setLogoutSuccessUrl(String logoutSuccessUrl)
Sets the logout success URL.- Parameters:
logoutSuccessUrl- the logout success URL
-
getAuthenticateAdditionalParameters
public Map<String,Object> getAuthenticateAdditionalParameters()
Gets the additional authenticate parameters.- Returns:
- the additional authenticate parameters
-
setAuthenticateAdditionalParameters
public void setAuthenticateAdditionalParameters(Map<String,Object> authenticateAdditionalParameters)
Sets the additional authenticate parameters.- Parameters:
authenticateAdditionalParameters- the additional authenticate parameters
-
isAllowTelemetry
@Deprecated @DeprecatedConfigurationProperty(reason="Deprecate the telemetry endpoint and use HTTP header User Agent instead.") public boolean isAllowTelemetry()
Deprecated.Determined by HTTP header User-Agent insteadWhether telemetry is allowed.- Returns:
- whether telemetry is allowed
-
setAllowTelemetry
public void setAllowTelemetry(boolean allowTelemetry)
Sets whether telemetry is allowed.- Parameters:
allowTelemetry- whether telemetry is allowed
-
getUserNameAttributeName
public String getUserNameAttributeName()
Gets the username attribute name.- Returns:
- the username attribute name
-
setUserNameAttributeName
public void setUserNameAttributeName(String userNameAttributeName)
Sets the username attribute name.- Parameters:
userNameAttributeName- the username attribute name
-
getReplyUrl
public String getReplyUrl()
Gets the reply URL.- Returns:
- the reply URL
-
setReplyUrl
public void setReplyUrl(String replyUrl)
Sets the reply URL.- Parameters:
replyUrl- the reply URL
-
getAppIdUri
public String getAppIdUri()
Gets the app ID URI.- Returns:
- the app ID URI
-
setAppIdUri
public void setAppIdUri(String appIdUri)
Sets the app ID URI.- Parameters:
appIdUri- the app ID URI.
-
getJwtConnectTimeout
public int getJwtConnectTimeout()
Gets the JWT connect timeout.- Returns:
- the JWT connect timeout
-
setJwtConnectTimeout
public void setJwtConnectTimeout(int jwtConnectTimeout)
Sets the JWT connect timeout.- Parameters:
jwtConnectTimeout- the JWT connect timeout
-
getJwtReadTimeout
public int getJwtReadTimeout()
Get the JWT read timeout.- Returns:
- the JWT read timeout
-
setJwtReadTimeout
public void setJwtReadTimeout(int jwtReadTimeout)
Sets the JWT read timeout.- Parameters:
jwtReadTimeout- the JWT read timeout
-
getJwtSizeLimit
public int getJwtSizeLimit()
Gets the JWT size limit.- Returns:
- the JWT size limit
-
setJwtSizeLimit
public void setJwtSizeLimit(int jwtSizeLimit)
Sets the JWT size limit.- Parameters:
jwtSizeLimit- the JWT size limit
-
getTenantId
public String getTenantId()
Gets the tenant ID.- Returns:
- the tenant ID
-
setTenantId
public void setTenantId(String tenantId)
Sets the tenant ID.- Parameters:
tenantId- the tenant ID
-
getAuthorizationClients
public Map<String,AuthorizationClientProperties> getAuthorizationClients()
Gets the authorization clients.- Returns:
- the authorization clients
-
setAuthorizationClients
public void setAuthorizationClients(Map<String,AuthorizationClientProperties> authorizationClients)
Sets the authorization clients.- Parameters:
authorizationClients- the authorization clients
-
-