Class AadAuthenticationProperties
- java.lang.Object
-
- com.azure.spring.cloud.autoconfigure.aad.properties.AadAuthenticationProperties
-
- All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean
public class AadAuthenticationProperties extends Object implements org.springframework.beans.factory.InitializingBean
Configuration properties for Azure Active Directory Authentication.- See Also:
InitializingBean
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAadAuthenticationProperties.UserGroupPropertiesProperties dedicated to changing the behavior of how the groups are mapped from the Azure AD response.
-
Constructor Summary
Constructors Constructor Description AadAuthenticationProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidafterPropertiesSet()Set after properties.StringgetAppIdUri()Gets the App ID URI.AadApplicationTypegetApplicationType()Gets the AADApplicationType.Map<String,Object>getAuthenticateAdditionalParameters()Gets the additional authenticate parameters.Map<String,AuthorizationClientProperties>getAuthorizationClients()Gets the authorization clients.AadCredentialPropertiesgetCredential()StringgetGraphMembershipUri()DurationgetJwkSetCacheLifespan()Gets the JWK set cache lifespan.DurationgetJwkSetCacheRefreshTime()Gets the JWK set cache refresh time.DurationgetJwtConnectTimeout()Gets the JWT connect timeout.DurationgetJwtReadTimeout()Gets the JWT read timeout.intgetJwtSizeLimit()Gets the JWT size limit.StringgetPostLogoutRedirectUri()Gets the post logout redirect URI.AadProfilePropertiesgetProfile()StringgetRedirectUriTemplate()Gets the redirect URI template.BooleangetSessionStateless()Whether the session is stateless.AadAuthenticationProperties.UserGroupPropertiesgetUserGroup()Gets the user group properties.StringgetUserNameAttribute()Gets the username attribute.booleanisAllowedGroup(String group)Whether the group is allowed.booleanisAllowedGroupIdsConfigured()Whether allowed group IDs is configured.booleanisAllowedGroupNamesConfigured()Whether allowed group names is configured.voidsetAppIdUri(String appIdUri)Sets the App ID URI.voidsetApplicationType(AadApplicationType applicationType)Sets the AADApplicationType.voidsetJwkSetCacheLifespan(Duration jwkSetCacheLifespan)Sets the JWK set cache lifespan.voidsetJwkSetCacheRefreshTime(Duration jwkSetCacheRefreshTime)Sets the JWK set cache refresh time.voidsetJwtConnectTimeout(Duration jwtConnectTimeout)Sets the JWT connect timeout.voidsetJwtReadTimeout(Duration jwtReadTimeout)Sets the JWT read timeout.voidsetJwtSizeLimit(int jwtSizeLimit)Sets the JWT size limit.voidsetPostLogoutRedirectUri(String postLogoutRedirectUri)Set the post logout redirect URI.voidsetRedirectUriTemplate(String redirectUriTemplate)Sets the redirect URI template.voidsetSessionStateless(Boolean sessionStateless)Sets whether the session is stateless.voidsetUserNameAttribute(String userNameAttribute)Sets the username attribute.
-
-
-
Field Detail
-
PREFIX
public static final String PREFIX
- See Also:
- Constant Field Values
-
-
Method Detail
-
getProfile
public AadProfileProperties getProfile()
- Returns:
- The AADProfileProperties.
-
getCredential
public AadCredentialProperties getCredential()
- Returns:
- The AADCredentialProperties.
-
getApplicationType
public AadApplicationType getApplicationType()
Gets the AADApplicationType.- Returns:
- the AADApplicationType
-
setApplicationType
public void setApplicationType(AadApplicationType applicationType)
Sets the AADApplicationType.- Parameters:
applicationType- the AADApplicationType
-
isAllowedGroupNamesConfigured
public boolean isAllowedGroupNamesConfigured()
Whether allowed group names is configured.- Returns:
- whether allowed group names is configured
-
isAllowedGroupIdsConfigured
public boolean isAllowedGroupIdsConfigured()
Whether allowed group IDs is configured.- Returns:
- whether allowed group IDs is configured
-
getUserGroup
public AadAuthenticationProperties.UserGroupProperties getUserGroup()
Gets the user group properties.- Returns:
- the user group properties
-
getUserNameAttribute
public String getUserNameAttribute()
Gets the username attribute.- Returns:
- the username attribute
-
setUserNameAttribute
public void setUserNameAttribute(String userNameAttribute)
Sets the username attribute.- Parameters:
userNameAttribute- the username attribute
-
getRedirectUriTemplate
public String getRedirectUriTemplate()
Gets the redirect URI template.- Returns:
- the redirect URI template
-
setRedirectUriTemplate
public void setRedirectUriTemplate(String redirectUriTemplate)
Sets the redirect URI template.- Parameters:
redirectUriTemplate- the redirect URI template
-
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
-
getAuthenticateAdditionalParameters
public Map<String,Object> getAuthenticateAdditionalParameters()
Gets the additional authenticate parameters.- Returns:
- the additional authenticate parameters
-
getJwtConnectTimeout
public Duration getJwtConnectTimeout()
Gets the JWT connect timeout.- Returns:
- the JWT connect timeout
-
setJwtConnectTimeout
public void setJwtConnectTimeout(Duration jwtConnectTimeout)
Sets the JWT connect timeout.- Parameters:
jwtConnectTimeout- the JWT connect timeout
-
getJwtReadTimeout
public Duration getJwtReadTimeout()
Gets the JWT read timeout.- Returns:
- the JWT read timeout
-
setJwtReadTimeout
public void setJwtReadTimeout(Duration 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
-
getJwkSetCacheLifespan
public Duration getJwkSetCacheLifespan()
Gets the JWK set cache lifespan.- Returns:
- the JWK set cache lifespan
-
setJwkSetCacheLifespan
public void setJwkSetCacheLifespan(Duration jwkSetCacheLifespan)
Sets the JWK set cache lifespan.- Parameters:
jwkSetCacheLifespan- the JWT set cache lifespan
-
getJwkSetCacheRefreshTime
public Duration getJwkSetCacheRefreshTime()
Gets the JWK set cache refresh time.- Returns:
- the JWK set cache refresh time
-
setJwkSetCacheRefreshTime
public void setJwkSetCacheRefreshTime(Duration jwkSetCacheRefreshTime)
Sets the JWK set cache refresh time.- Parameters:
jwkSetCacheRefreshTime- the JWK set cache refresh time
-
getPostLogoutRedirectUri
public String getPostLogoutRedirectUri()
Gets the post logout redirect URI.- Returns:
- the post logout redirect URI
-
setPostLogoutRedirectUri
public void setPostLogoutRedirectUri(String postLogoutRedirectUri)
Set the post logout redirect URI.- Parameters:
postLogoutRedirectUri- the post logout redirect URI
-
getSessionStateless
public Boolean getSessionStateless()
Whether the session is stateless.- Returns:
- whether the session is stateless
-
setSessionStateless
public void setSessionStateless(Boolean sessionStateless)
Sets whether the session is stateless.- Parameters:
sessionStateless- whether the session is stateless
-
getGraphMembershipUri
public String getGraphMembershipUri()
- Returns:
- Graph membership uri.
-
getAuthorizationClients
public Map<String,AuthorizationClientProperties> getAuthorizationClients()
Gets the authorization clients.- Returns:
- the authorization clients
-
isAllowedGroup
public boolean isAllowedGroup(String group)
Whether the group is allowed.- Parameters:
group- the group- Returns:
- whether the group is allowed
-
afterPropertiesSet
public void afterPropertiesSet()
Set after properties.- Specified by:
afterPropertiesSetin interfaceorg.springframework.beans.factory.InitializingBean
-
-