|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.nimbusds.oauth2.sdk.client.ClientMetadata com.nimbusds.openid.connect.sdk.rp.OIDCClientMetadata
public class OIDCClientMetadata
OpenID Connect client metadata.
Related specifications:
Constructor Summary | |
---|---|
OIDCClientMetadata()
Creates a new OpenID Connect client metadata instance. |
|
OIDCClientMetadata(ClientMetadata metadata)
Creates a new OpenID Connect client metadata instance from the specified base OAuth 2.0 client metadata. |
Method Summary | |
---|---|
void |
applyDefaults()
Applies the client metadata defaults where no values have been specified. |
ApplicationType |
getApplicationType()
Gets the client application type. |
List<ACR> |
getDefaultACRs()
Gets the default Authentication Context Class Reference (ACR) values. |
int |
getDefaultMaxAge()
Gets the default maximum authentication age. |
com.nimbusds.jose.JWEAlgorithm |
getIDTokenJWEAlgorithm()
Gets the JSON Web Encryption (JWE) algorithm required for the ID Tokens issued to this client. |
com.nimbusds.jose.EncryptionMethod |
getIDTokenJWEEncryptionMethod()
Gets the encryption method (JWE enc) required for the ID Tokens issued to this client. |
com.nimbusds.jose.JWSAlgorithm |
getIDTokenJWSAlgorithm()
Gets the JSON Web Signature (JWS) algorithm required for the ID Tokens issued to this client. |
URL |
getInitiateLoginURI()
Gets the HTTPS URI that the authorisation server can call to initiate a login at the client. |
URL |
getPostLogoutRedirectURI()
Gets the post logout redirect URI. |
com.nimbusds.jose.JWSAlgorithm |
getRequestObjectJWSAlgorithm()
Gets the JSON Web Signature (JWS) algorithm required for the OpenID Connect request objects sent by this client. |
Set<URL> |
getRequestObjectURIs()
Gets the pre-registered OpenID Connect request object URIs. |
URL |
getSectorIDURI()
Gets the sector identifier URI. |
SubjectType |
getSubjectType()
Gets the subject identifier type for responses to this client. |
com.nimbusds.jose.JWEAlgorithm |
getUserInfoJWEAlgorithm()
Gets the JSON Web Encryption (JWE) algorithm required for the UserInfo responses to this client. |
com.nimbusds.jose.EncryptionMethod |
getUserInfoJWEEncryptionMethod()
Gets the encryption method (JWE enc) required for the UserInfo responses to this client. |
com.nimbusds.jose.JWSAlgorithm |
getUserInfoJWSAlgorithm()
Gets the JSON Web Signature (JWS) algorithm required for the UserInfo responses to this client. |
static OIDCClientMetadata |
parse(net.minidev.json.JSONObject jsonObject)
Parses an OpenID Connect client metadata instance from the specified JSON object. |
boolean |
requiresAuthTime()
Gets the default requirement for the auth_time claim in the
ID Token. |
void |
requiresAuthTime(boolean requiresAuthTime)
Sets the default requirement for the auth_time claim in the
ID Token. |
void |
setApplicationType(ApplicationType applicationType)
Sets the client application type. |
void |
setDefaultACRs(List<ACR> defaultACRs)
Sets the default Authentication Context Class Reference (ACR) values. |
void |
setDefaultMaxAge(int defaultMaxAge)
Sets the default maximum authentication age. |
void |
setIDTokenJWEAlgorithm(com.nimbusds.jose.JWEAlgorithm idTokenJWEAlg)
Sets the JSON Web Encryption (JWE) algorithm required for the ID Tokens issued to this client. |
void |
setIDTokenJWEEncryptionMethod(com.nimbusds.jose.EncryptionMethod idTokenJWEEnc)
Sets the encryption method (JWE enc) required for the ID Tokens issued to this client. |
void |
setIDTokenJWSAlgorithm(com.nimbusds.jose.JWSAlgorithm idTokenJWSAlg)
Sets the JSON Web Signature (JWS) algorithm required for the ID Tokens issued to this client. |
void |
setInitiateLoginURI(URL loginURI)
Sets the HTTPS URI that the authorisation server can call to initiate a login at the client. |
void |
setPostLogoutRedirectURI(URL logoutURI)
Sets the post logout redirect URI. |
void |
setRequestObjectJWSAlgorithm(com.nimbusds.jose.JWSAlgorithm requestObjectJWSAlg)
Sets the JSON Web Signature (JWS) algorithm required for the OpenID Connect request objects sent by this client. |
void |
setRequestObjectURIs(Set<URL> requestObjectURIs)
Sets the pre-registered OpenID Connect request object URIs. |
void |
setSectorIDURI(URL sectorIDURI)
Sets the sector identifier URI. |
void |
setSubjectType(SubjectType subjectType)
Sets the subject identifier type for responses to this client. |
void |
setUserInfoJWEAlgorithm(com.nimbusds.jose.JWEAlgorithm userInfoJWEAlg)
Sets the JSON Web Encryption (JWE) algorithm required for the UserInfo responses to this client. |
void |
setUserInfoJWEEncryptionMethod(com.nimbusds.jose.EncryptionMethod userInfoJWEEnc)
Sets the encryption method (JWE enc) required for the UserInfo responses to this client. |
void |
setUserInfoJWSAlgorithm(com.nimbusds.jose.JWSAlgorithm userInfoJWSAlg)
Sets the JSON Web Signature (JWS) algorithm required for the UserInfo responses to this client. |
net.minidev.json.JSONObject |
toJSONObject()
Returns the JSON object representation of this client metadata. |
Methods inherited from class com.nimbusds.oauth2.sdk.client.ClientMetadata |
---|
getContacts, getGrantTypes, getJWKSetURI, getLogoURI, getLogoURI, getLogoURIEntries, getName, getName, getNameEntries, getPolicyURI, getPolicyURI, getPolicyURIEntries, getRedirectURIs, getResponseTypes, getScope, getTermsOfServiceURI, getTermsOfServiceURI, getTermsOfServiceURIEntries, getTokenEndpointAuthMethod, getURI, getURI, getURIEntries, setContacts, setGrantTypes, setJWKSetURL, setLogoURI, setLogoURI, setName, setName, setPolicyURI, setPolicyURI, setRedirectURIs, setResponseTypes, setScope, setTermsOfServiceURI, setTermsOfServiceURI, setTokenEndpointAuthMethod, setURI, setURI |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OIDCClientMetadata()
public OIDCClientMetadata(ClientMetadata metadata)
metadata
- The base OAuth 2.0 client metadata. Must not be
null
.Method Detail |
---|
public ApplicationType getApplicationType()
application_type
client registration parameter.
null
if not specified.public void setApplicationType(ApplicationType applicationType)
application_type
client registration parameter.
applicationType
- The client application type, null
if
not specified.public SubjectType getSubjectType()
subject_type
client registration
parameter.
null
if not specified.public void setSubjectType(SubjectType subjectType)
subject_type
client registration
parameter.
subjectType
- The subject identifier type, null
if not
specified.public URL getSectorIDURI()
sector_identifier_uri
client registration parameter.
null
if not specified.public void setSectorIDURI(URL sectorIDURI)
sector_identifier_uri
client registration parameter.
sectorIDURI
- The sector identifier URI, null
if not
specified.public Set<URL> getRequestObjectURIs()
request_uris
client registration
parameter.
null
if not specified.public void setRequestObjectURIs(Set<URL> requestObjectURIs)
request_uris
client registration
parameter.
requestObjectURIs
- The request object URIs, null
if
not specified.public com.nimbusds.jose.JWSAlgorithm getRequestObjectJWSAlgorithm()
request_object_signing_alg
client registration parameter.
null
if not specified.public void setRequestObjectJWSAlgorithm(com.nimbusds.jose.JWSAlgorithm requestObjectJWSAlg)
request_object_signing_alg
client registration parameter.
requestObjectJWSAlg
- The JWS algorithm, null
if not
specified.public com.nimbusds.jose.JWSAlgorithm getIDTokenJWSAlgorithm()
id_token_signed_response_alg
client registration parameter.
null
if not specified.public void setIDTokenJWSAlgorithm(com.nimbusds.jose.JWSAlgorithm idTokenJWSAlg)
id_token_signed_response_alg
client registration parameter.
idTokenJWSAlg
- The JWS algorithm, null
if not
specified.public com.nimbusds.jose.JWEAlgorithm getIDTokenJWEAlgorithm()
id_token_encrypted_response_alg
client registration
parameter.
null
if not specified.public void setIDTokenJWEAlgorithm(com.nimbusds.jose.JWEAlgorithm idTokenJWEAlg)
id_token_encrypted_response_alg
client registration
parameter.
idTokenJWEAlg
- The JWE algorithm, null
if not
specified.public com.nimbusds.jose.EncryptionMethod getIDTokenJWEEncryptionMethod()
id_token_encrypted_response_enc
client registration
parameter.
null
if not specified.public void setIDTokenJWEEncryptionMethod(com.nimbusds.jose.EncryptionMethod idTokenJWEEnc)
id_token_encrypted_response_enc
client registration
parameter.
idTokenJWEEnc
- The JWE encryption method, null
if not
specified.public com.nimbusds.jose.JWSAlgorithm getUserInfoJWSAlgorithm()
userinfo_signed_response_alg
client registration
parameter.
null
if not specified.public void setUserInfoJWSAlgorithm(com.nimbusds.jose.JWSAlgorithm userInfoJWSAlg)
userinfo_signed_response_alg
client registration
parameter.
userInfoJWSAlg
- The JWS algorithm, null
if not
specified.public com.nimbusds.jose.JWEAlgorithm getUserInfoJWEAlgorithm()
userinfo_encrypted_response_alg
client registration
parameter.
null
if not specified.public void setUserInfoJWEAlgorithm(com.nimbusds.jose.JWEAlgorithm userInfoJWEAlg)
userinfo_encrypted_response_alg
client registration
parameter.
userInfoJWEAlg
- The JWE algorithm, null
if not
specified.public com.nimbusds.jose.EncryptionMethod getUserInfoJWEEncryptionMethod()
userinfo_encrypted_response_enc
client registration
parameter.
null
if not specified.public void setUserInfoJWEEncryptionMethod(com.nimbusds.jose.EncryptionMethod userInfoJWEEnc)
userinfo_encrypted_response_enc
client registration
parameter.
userInfoJWEEnc
- The JWE encryption method, null
if not
specified.public int getDefaultMaxAge()
default_max_age
client registration parameter.
public void setDefaultMaxAge(int defaultMaxAge)
default_max_age
client registration parameter.
defaultMaxAge
- The default max authentication age, in seconds.
If not specified 0.public boolean requiresAuthTime()
auth_time
claim in the
ID Token. Corresponds to the require_auth_time
client
registration parameter.
true
the auth_Time
claim in the ID Token
is required by default.public void requiresAuthTime(boolean requiresAuthTime)
auth_time
claim in the
ID Token. Corresponds to the require_auth_time
client
registration parameter.
requiresAuthTime
- If true
the auth_Time
claim
in the ID Token is required by default.public List<ACR> getDefaultACRs()
default_acr_values
client
registration parameter.
null
if not specified.public void setDefaultACRs(List<ACR> defaultACRs)
default_acr_values
client
registration parameter.
defaultACRs
- The default ACRs, by order of preference,
null
if not specified.public URL getInitiateLoginURI()
initiate_login_uri
client registration parameter.
null
if not specified.public void setInitiateLoginURI(URL loginURI)
initiate_login_uri
client registration parameter.
loginURI
- The login URI, null
if not specified.public URL getPostLogoutRedirectURI()
post_logout_redirect_uri
client registration parameter.
null
if not specified.public void setPostLogoutRedirectURI(URL logoutURI)
post_logout_redirect_uri
client registration parameter.
logoutURI
- The logout URI, null
if not specified.public void applyDefaults()
ClientMetadata
applyDefaults
in class ClientMetadata
public net.minidev.json.JSONObject toJSONObject()
ClientMetadata
toJSONObject
in class ClientMetadata
public static OIDCClientMetadata parse(net.minidev.json.JSONObject jsonObject) throws ParseException
jsonObject
- The JSON object to parse. Must not be
null
.
ParseException
- If the JSON object couldn't be parsed to an
OpenID Connect client metadata instance.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |