Package org.apereo.cas.services

Class OidcRegisteredService

java.lang.Object

org.apereo.cas.services.BaseRegisteredService

org.apereo.cas.services.BaseWebBasedRegisteredService

org.apereo.cas.support.oauth.services.OAuthRegisteredService

org.apereo.cas.services.OidcRegisteredService

All Implemented Interfaces:

Serializable, Comparable<org.apereo.cas.services.RegisteredService>, org.apereo.cas.services.RegisteredService, org.apereo.cas.services.RegisteredServiceDefinition, org.apereo.cas.services.WebBasedRegisteredService

public class OidcRegisteredService
extends org.apereo.cas.support.oauth.services.OAuthRegisteredService

This is OidcRegisteredService.

Since:

5.0.0

See Also:

• Serialized Form

Field Summary

Fields inherited from interface org.apereo.cas.services.RegisteredServiceDefinition

INITIAL_IDENTIFIER_VALUE

Constructor Summary

Constructors

Constructor	Description
OidcRegisteredService()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getApplicationType()
long	getClientSecretExpiration()
int	getEvaluationPriority()
String	getFriendlyName()
String	getIdTokenEncryptionAlg()
String	getIdTokenEncryptionEncoding()
RegisteredServiceOidcIdTokenExpirationPolicy	getIdTokenExpirationPolicy()
String	getIdTokenIssuer()
String	getIdTokenSigningAlg()
String	getJwks()
String	getJwksCacheDuration()
String	getJwksKeyId()
String	getSectorIdentifierUri()
String	getSubjectType()	Gets subject type.
String	getUserInfoEncryptedResponseAlg()
String	getUserInfoEncryptedResponseEncoding()
String	getUserInfoSigningAlg()
int	hashCode()
boolean	isEncryptIdToken()
boolean	isIdTokenEncryptionOptional()
boolean	isSignIdToken()
void	markAsDynamicallyRegistered()	Mark the service as one that is as dynamically registered via the OIDC dynamic registration flow.
OidcRegisteredService	setApplicationType(String applicationType)
OidcRegisteredService	setClientSecretExpiration(long clientSecretExpiration)
OidcRegisteredService	setEncryptIdToken(boolean encryptIdToken)
OidcRegisteredService	setIdTokenEncryptionAlg(String idTokenEncryptionAlg)
OidcRegisteredService	setIdTokenEncryptionEncoding(String idTokenEncryptionEncoding)
OidcRegisteredService	setIdTokenEncryptionOptional(boolean idTokenEncryptionOptional)
OidcRegisteredService	setIdTokenExpirationPolicy(RegisteredServiceOidcIdTokenExpirationPolicy idTokenExpirationPolicy)
OidcRegisteredService	setIdTokenIssuer(String idTokenIssuer)
OidcRegisteredService	setIdTokenSigningAlg(String idTokenSigningAlg)
OidcRegisteredService	setJwks(String jwks)
OidcRegisteredService	setJwksCacheDuration(String jwksCacheDuration)
OidcRegisteredService	setJwksKeyId(String jwksKeyId)
OidcRegisteredService	setSectorIdentifierUri(String sectorIdentifierUri)
OidcRegisteredService	setSignIdToken(boolean signIdToken)
OidcRegisteredService	setSubjectType(String subjectType)
OidcRegisteredService	setUserInfoEncryptedResponseAlg(String userInfoEncryptedResponseAlg)
OidcRegisteredService	setUserInfoEncryptedResponseEncoding(String userInfoEncryptedResponseEncoding)
OidcRegisteredService	setUserInfoSigningAlg(String userInfoSigningAlg)
String	toString()

Methods inherited from class org.apereo.cas.support.oauth.services.OAuthRegisteredService

getAccessTokenExpirationPolicy, getAudience, getClientId, getClientSecret, getCodeExpirationPolicy, getDeviceTokenExpirationPolicy, getIntrospectionEncryptedResponseAlg, getIntrospectionEncryptedResponseEncoding, getIntrospectionSignedResponseAlg, getJwtAccessTokenSigningAlg, getRefreshTokenExpirationPolicy, getResponseMode, getScopes, getSupportedGrantTypes, getSupportedResponseTypes, getTlsClientAuthSanDns, getTlsClientAuthSanEmail, getTlsClientAuthSanIp, getTlsClientAuthSanUri, getTlsClientAuthSubjectDn, getTokenEndpointAuthenticationMethod, getUserProfileViewType, initialize, isBypassApprovalPrompt, isGenerateRefreshToken, isJwtAccessToken, isRenewRefreshToken, setAccessTokenExpirationPolicy, setAudience, setBypassApprovalPrompt, setClientId, setClientSecret, setCodeExpirationPolicy, setDeviceTokenExpirationPolicy, setGenerateRefreshToken, setIntrospectionEncryptedResponseAlg, setIntrospectionEncryptedResponseEncoding, setIntrospectionSignedResponseAlg, setJwtAccessToken, setJwtAccessTokenSigningAlg, setRefreshTokenExpirationPolicy, setRenewRefreshToken, setResponseMode, setScopes, setSupportedGrantTypes, setSupportedResponseTypes, setTlsClientAuthSanDns, setTlsClientAuthSanEmail, setTlsClientAuthSanIp, setTlsClientAuthSanUri, setTlsClientAuthSubjectDn, setTokenEndpointAuthenticationMethod, setUserProfileViewType

Methods inherited from class org.apereo.cas.services.BaseWebBasedRegisteredService

getAcceptableUsagePolicy, getSingleSignOnParticipationPolicy, getWebflowInterruptPolicy, setAcceptableUsagePolicy, setSingleSignOnParticipationPolicy, setWebflowInterruptPolicy

Methods inherited from class org.apereo.cas.services.BaseRegisteredService

compareTo, getAccessStrategy, getAttributeReleasePolicy, getAuthenticationPolicy, getContacts, getDescription, getEnvironments, getEvaluationOrder, getExpirationPolicy, getId, getInformationUrl, getLocale, getLogo, getLogoutType, getLogoutUrl, getMatchingStrategy, getMultifactorAuthenticationPolicy, getName, getPrivacyUrl, getProperties, getPublicKey, getServiceId, getTemplateName, getTheme, getTicketGrantingTicketExpirationPolicy, getUsernameAttributeProvider, matches, matches, setAccessStrategy, setAttributeReleasePolicy, setAuthenticationPolicy, setContacts, setDescription, setEnvironments, setEvaluationOrder, setExpirationPolicy, setId, setInformationUrl, setLocale, setLogo, setLogoutType, setLogoutUrl, setMatchingStrategy, setMultifactorAuthenticationPolicy, setName, setPrivacyUrl, setProperties, setPublicKey, setServiceId, setTemplateName, setTheme, setTicketGrantingTicketExpirationPolicy, setUsernameAttributeProvider

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.apereo.cas.services.RegisteredService

getAccessStrategy, getAttributeReleasePolicy, getAuthenticationPolicy, getContacts, getEnvironments, getEvaluationOrder, getExpirationPolicy, getMatchingStrategy, getMultifactorAuthenticationPolicy, getProperties, getPublicKey, getServiceId, getTemplateName, getTicketGrantingTicketExpirationPolicy, getUsernameAttributeProvider, matches, matches, setEvaluationOrder

Methods inherited from interface org.apereo.cas.services.RegisteredServiceDefinition

getDescription, getId, getName, setId

Methods inherited from interface org.apereo.cas.services.WebBasedRegisteredService

getInformationUrl, getLocale, getLogo, getLogoutType, getLogoutUrl, getPrivacyUrl, getTheme

Constructor Details

OidcRegisteredService

public OidcRegisteredService()

Method Details

getSubjectType

public String getSubjectType()

Gets subject type.

Returns:

the subject type

getEvaluationPriority

public int getEvaluationPriority()

Specified by:

getEvaluationPriority in interface org.apereo.cas.services.RegisteredService

Overrides:

getEvaluationPriority in class org.apereo.cas.support.oauth.services.OAuthRegisteredService

getFriendlyName

public String getFriendlyName()

Specified by:

getFriendlyName in interface org.apereo.cas.services.RegisteredService

Overrides:

getFriendlyName in class org.apereo.cas.support.oauth.services.OAuthRegisteredService

markAsDynamicallyRegistered

public void markAsDynamicallyRegistered()

Mark the service as one that is as dynamically registered via the OIDC dynamic registration flow. This operation will assign specific properties to the service definition to carry the registration signal/data.

toString

public String toString()

Overrides:

toString in class org.apereo.cas.support.oauth.services.OAuthRegisteredService

getJwks

public String getJwks()

getJwksKeyId

public String getJwksKeyId()

getJwksCacheDuration

public String getJwksCacheDuration()

isSignIdToken

public boolean isSignIdToken()

isEncryptIdToken

public boolean isEncryptIdToken()

isIdTokenEncryptionOptional

public boolean isIdTokenEncryptionOptional()

getIdTokenEncryptionAlg

public String getIdTokenEncryptionAlg()

getIdTokenSigningAlg

public String getIdTokenSigningAlg()

getUserInfoSigningAlg

public String getUserInfoSigningAlg()

getUserInfoEncryptedResponseAlg

public String getUserInfoEncryptedResponseAlg()

getUserInfoEncryptedResponseEncoding

public String getUserInfoEncryptedResponseEncoding()

getIdTokenEncryptionEncoding

public String getIdTokenEncryptionEncoding()

getIdTokenIssuer

public String getIdTokenIssuer()

getSectorIdentifierUri

public String getSectorIdentifierUri()

getApplicationType

public String getApplicationType()

getClientSecretExpiration

public long getClientSecretExpiration()

getIdTokenExpirationPolicy

public RegisteredServiceOidcIdTokenExpirationPolicy getIdTokenExpirationPolicy()

setJwks

public OidcRegisteredService setJwks(String jwks)

Returns:

this.

setJwksKeyId

public OidcRegisteredService setJwksKeyId(String jwksKeyId)

Returns:

this.

setJwksCacheDuration

public OidcRegisteredService setJwksCacheDuration(String jwksCacheDuration)

Returns:

this.

setSignIdToken

public OidcRegisteredService setSignIdToken(boolean signIdToken)

Returns:

this.

setEncryptIdToken

public OidcRegisteredService setEncryptIdToken(boolean encryptIdToken)

Returns:

this.

setIdTokenEncryptionOptional

public OidcRegisteredService setIdTokenEncryptionOptional(boolean idTokenEncryptionOptional)

Returns:

this.

setIdTokenEncryptionAlg

public OidcRegisteredService setIdTokenEncryptionAlg(String idTokenEncryptionAlg)

Returns:

this.

setIdTokenSigningAlg

public OidcRegisteredService setIdTokenSigningAlg(String idTokenSigningAlg)

Returns:

this.

setUserInfoSigningAlg

public OidcRegisteredService setUserInfoSigningAlg(String userInfoSigningAlg)

Returns:

this.

setUserInfoEncryptedResponseAlg

public OidcRegisteredService setUserInfoEncryptedResponseAlg(String userInfoEncryptedResponseAlg)

Returns:

this.

setUserInfoEncryptedResponseEncoding

public OidcRegisteredService setUserInfoEncryptedResponseEncoding(String userInfoEncryptedResponseEncoding)

Returns:

this.

setIdTokenEncryptionEncoding

public OidcRegisteredService setIdTokenEncryptionEncoding(String idTokenEncryptionEncoding)

Returns:

this.

setIdTokenIssuer

public OidcRegisteredService setIdTokenIssuer(String idTokenIssuer)

Returns:

this.

setSectorIdentifierUri

public OidcRegisteredService setSectorIdentifierUri(String sectorIdentifierUri)

Returns:

this.

setApplicationType

public OidcRegisteredService setApplicationType(String applicationType)

Returns:

this.

setSubjectType

public OidcRegisteredService setSubjectType(String subjectType)

Returns:

this.

setClientSecretExpiration

public OidcRegisteredService setClientSecretExpiration(long clientSecretExpiration)

Returns:

this.

setIdTokenExpirationPolicy

public OidcRegisteredService setIdTokenExpirationPolicy(RegisteredServiceOidcIdTokenExpirationPolicy idTokenExpirationPolicy)

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class org.apereo.cas.support.oauth.services.OAuthRegisteredService

hashCode

public int hashCode()

Overrides:

hashCode in class org.apereo.cas.support.oauth.services.OAuthRegisteredService