|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.nimbusds.openid.connect.sdk.rp.Client
public class Client
OpenID Connect client details. Used in client registration requests and responses.
Related specifications:
Constructor Summary | |
---|---|
Client()
Creates a new OpenID Connect client details instance. |
Method Summary | |
---|---|
ApplicationType |
getApplicationType()
Gets the client application type. |
List<javax.mail.internet.InternetAddress> |
getContacts()
Gets the administrator contacts for the client. |
Set<ACR> |
getDefaultACRs()
Gets the default Authentication Context Class References (ACRs). |
int |
getDefaultMaxAge()
Gets the default maximum authentication age. |
URL |
getEncryptionJWKSetURL()
Gets the URL for the client's JSON Web Key (JWK) set containing key(s) that ares used to encrypt the ID Token and UserInfo endpoint responses to the client. |
URL |
getEncryptionX509URL()
Gets the URL for the client's PEM encoded X.509 certificate or certificate chain that is used to encrypt the ID Token and UserInfo endpoint responses to the client. |
ClientID |
getID()
Gets the client ID. |
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 authorisation server initiated login HTTPS URL. |
URL |
getJWKSetURL()
Gets the URL for the client's JSON Web Key (JWK) set containing key(s) that are used in signing Token endpoint requests and OpenID request objects. |
URL |
getLogoURL()
Gets the client application logo. |
String |
getName()
Gets the client name. |
String |
getName(com.nimbusds.langtag.LangTag langTag)
Gets the client name. |
Map<com.nimbusds.langtag.LangTag,String> |
getNameEntries()
Gets the client name entries. |
URL |
getPolicyURL()
Gets the client policy for use of end-user data. |
URL |
getPostLogoutRedirectURI()
Gets the post logout redirect URL. |
Set<URL> |
getRedirectURIs()
Gets the redirect URIs for the client. |
BearerAccessToken |
getRegistrationAccessToken()
Gets the registration access token. |
com.nimbusds.jose.JWSAlgorithm |
getRequestObjectJWSAlgorithm()
Gets the JSON Web Signature (JWS) algorithm required for the OpenID request objects sent by this client. |
Secret |
getSecret()
Gets the client secret. |
URL |
getSectorIDURL()
Gets the sector identifier URL. |
SubjectType |
getSubjectType()
Gets the subject identifier type for responses to this client. |
URL |
getTermsOfServiceURL()
Gets the client terms of service. |
ClientAuthenticationMethod |
getTokenEndpointAuthMethod()
Gets the Token endpoint authentication method. |
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. |
URL |
getX509URL()
Gets the URL for the client's PEM encoded X.509 certificate or certificate chain that is used for signing Token endpoint requests and OpenID request objects. |
static Client |
parse(net.minidev.json.JSONObject jsonObject)
Parses an OpenID Connect client details instance from the specified JSON object. |
boolean |
requiresAuthTime()
Gets the default requirement for the auth_time claim in the
ID Token. |
void |
requiresAuthTime(boolean requireAuthTime)
Sets the default requirement for the auth_time claim in the
ID Token. |
void |
setApplicationType(ApplicationType applicationType)
Sets the client application type. |
void |
setContacts(List<javax.mail.internet.InternetAddress> contacts)
Sets the administrator contacts for the client. |
void |
setDefaultACRs(Set<ACR> defaultACRs)
Sets the default Authentication Context Class References (ACRs). |
void |
setDefaultMaxAge(int defaultMaxAge)
Sets the default maximum authentication age. |
void |
setEncryptionX509URL(URL encryptionX509URL)
Sets the URL for the client's PEM encoded X.509 certificate or certificate chain that is used to encrypt the ID Token and UserInfo endpoint responses to the client. |
void |
setEncrytionJWKSetURL(URL encryptionJWKSetURL)
Sets the URL for the client's JSON Web Key (JWK) set containing key(s) that are used to encrypt the ID Token and UserInfo endpoint responses to the client. |
void |
setID(ClientID id)
Sets the client ID. |
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 initiateLoginURI)
Sets the authorisation server initiated login HTTPS URL. |
void |
setJWKSetURL(URL jwkSetURL)
Sets the URL for the client's JSON Web Key (JWK) set containing key(s) that are used in signing Token endpoint requests and OpenID request objects. |
void |
setLogoURL(URL logoURL)
Sets the client application logo. |
void |
setName(LangTaggedObject<String> name)
Sets the client name. |
void |
setName(String name)
Sets the client name. |
void |
setPolicyURL(URL policyURL)
Sets the client policy for use of end-user data. |
void |
setPostLogoutRedirectURI(URL postLogoutRedirectURI)
Sets the post logout redirect URL. |
void |
setRedirectURIs(Set<URL> redirectURIs)
Sets the redirect URIs for the client. |
void |
setRegistrationAccessToken(BearerAccessToken accessToken)
Sets the registration access token. |
void |
setRequestObjectJWSAlgorithm(com.nimbusds.jose.JWSAlgorithm requestObjectJWSAlg)
Sets the JSON Web Signature (JWS) algorithm required for the OpenID request objects sent by this client. |
void |
setSecret(Secret secret)
Sets the client secret. |
void |
setSectorIDURL(URL sectorIDURL)
Sets the sector identifier URL. |
void |
setSubjectType(SubjectType subjectType)
Sets the subject identifier type for responses to this client. |
void |
setTermsOfServiceURL(URL tosURL)
Sets the client terms of service. |
void |
setTokenEndpointAuthMethod(ClientAuthenticationMethod tokenEndpointAuthMethod)
Sets the Token endpoint authentication method. |
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. |
void |
setX509URL(URL x509URL)
Sets the URL for the client's PEM encoded X.509 certificate or certificate chain that is used for signing Token endpoint requests and OpenID request objects. |
net.minidev.json.JSONObject |
toJSONObject()
Returns the client details as a JSON object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Client()
Method Detail |
---|
public ClientID getID()
null
if not specified.public void setID(ClientID id)
id
- The client ID, null
if not specified.public Set<URL> getRedirectURIs()
redirect_uris
client registration parameter.
null
if none.public void setRedirectURIs(Set<URL> redirectURIs)
redirect_uris
client registration parameter.
redirectURIs
- The redirect URIs, null
if none.public List<javax.mail.internet.InternetAddress> getContacts()
contacts
client registration parameter.
null
if none.public void setContacts(List<javax.mail.internet.InternetAddress> contacts)
contacts
client registration parameter.
contacts
- The administrator contacts, null
if none.public ApplicationType getApplicationType()
application_type
client registration parameter.
public void setApplicationType(ApplicationType applicationType)
application_type
client registration parameter.
applicationType
- The client application type, null
for
the default.public String getName()
client_name
client
registration parameter, with no language tag.
null
if not specified.public String getName(com.nimbusds.langtag.LangTag langTag)
client_name
client
registration parameter, with an optional language tag.
langTag
- The language tag of the entry, null
to get
the non-tagged entry.
null
if not specified.public Map<com.nimbusds.langtag.LangTag,String> getNameEntries()
client_name
client registration parameter.
public void setName(String name)
client_name
client
registration parameter, with no language tag.
name
- The client name, null
if not specified.public void setName(LangTaggedObject<String> name)
client_name
client
registration parameter, with an optional language tag.
name
- The client name, with optional language tag.
null
if not specified.public URL getLogoURL()
logo_url
client registration parameter.
null
if not specified.public void setLogoURL(URL logoURL)
logo_url
client registration parameter.
logoURL
- The logo URL, null
if not specified.public URL getPolicyURL()
policy_url
client registration parameter.
null
if not specified.public void setPolicyURL(URL policyURL)
policy_url
client registration parameter.
policyURL
- The policy URL, null
if not specified.public URL getTermsOfServiceURL()
tos_url
client registration parameter.
null
if not specified.public void setTermsOfServiceURL(URL tosURL)
tos_url
client registration parameter.
tosURL
- The terms of service URL, 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 getSectorIDURL()
sector_identifier_url
client registration parameter.
null
if not specified.public void setSectorIDURL(URL sectorIDURL)
sector_identifier_url
client registration parameter.
sectorIDURL
- The sector identifier URL, null
if not
specified.public ClientAuthenticationMethod getTokenEndpointAuthMethod()
token_endpoint_auth_method
client registration parameter.
public void setTokenEndpointAuthMethod(ClientAuthenticationMethod tokenEndpointAuthMethod)
token_endpoint_auth_method
client registration parameter.
tokenEndpointAuthMethod
- The Token endpoint authentication
method, null
for the default.public URL getJWKSetURL()
getEncryptionJWKSetURL()
if not provided,
also used to encrypt the ID Token and UserInfo endpoint responses to
the client. Corresponds to the jwk_url
client registration
parameter.
null
if not specified.public void setJWKSetURL(URL jwkSetURL)
getEncryptionJWKSetURL()
if not provided,
also used to encrypt the ID Token and UserInfo endpoint responses to
the client. Corresponds to the jwk_url
client registration
parameter.
jwkSetURL
- The JWK set URL, null
if not specified.public URL getEncryptionJWKSetURL()
jwk_encryption_url
client registration parameter.
null
if not specified.public void setEncrytionJWKSetURL(URL encryptionJWKSetURL)
jwk_encryption_url
client registration parameter.
encryptionJWKSetURL
- The encryption JWK set URL, null
if not specified.public URL getX509URL()
getEncryptionX509URL()
is not
provided, also used to encrypt the ID Token and UserInfo endpoint
responses to the client. Corresponds to the x509_url
client
registration parameter.
null
if not specified.public void setX509URL(URL x509URL)
getEncryptionX509URL()
is not
provided, also used to encrypt the ID Token and UserInfo endpoint
responses to the client. Corresponds to the x509_url
client
registration parameter.
x509URL
- The X.509 certificate URL, null
if not
specified.public URL getEncryptionX509URL()
x509_encryption_url
client registration parameter.
null
if not
specified.public void setEncryptionX509URL(URL encryptionX509URL)
x509_encryption_url
client registration parameter.
encryptionX509URL
- The encryption X.509 certificate URL,
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 requireAuthTime)
auth_time
claim in the
ID Token. Corresponds to the require_auth_time
client
registration parameter.
requireAuthTime
- If true
the auth_Time
claim
in the ID Token is required by default.public Set<ACR> getDefaultACRs()
default_acr_values
client registration
parameter.
null
if not specified.public void setDefaultACRs(Set<ACR> defaultACRs)
default_acr_values
client registration
parameter.
defaultACRs
- The default ACRs, null
if not specified.public URL getInitiateLoginURI()
initiate_login_uri
client registration
parameter.
null
if not specified.public void setInitiateLoginURI(URL initiateLoginURI)
initiate_login_uri
client registration
parameter.
initiateLoginURI
- The login URL, null
if not
specified.public URL getPostLogoutRedirectURI()
post_logout_redirect_url
client registration parameter.
null
if not specified.public void setPostLogoutRedirectURI(URL postLogoutRedirectURI)
post_logout_redirect_url
client registration parameter.
postLogoutRedirectURI
- The post logout redirect URL,
null
if not specified.public BearerAccessToken getRegistrationAccessToken()
registration_access_token
client registration parameter.
null
if not
specified.public void setRegistrationAccessToken(BearerAccessToken accessToken)
registration_access_token
client registration parameter.
accessToken
- The registration access token, null
if
not specified.public Secret getSecret()
client_secret
and
expires_at
client registration parameters.
null
if not specified.public void setSecret(Secret secret)
client_secret
and
expires_at
client registration parameters.
secret
- The client secret, null
if not specified.public net.minidev.json.JSONObject toJSONObject()
public static Client 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 details instance.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |