Uses of Class
com.nimbusds.oauth2.sdk.ResponseMode
Packages that use ResponseMode
Package
Description
Classes for representing, serialising and parsing core OAuth 2.0 concepts.
OAuth 2.0 Authorisation Server (AS) classes.
JWT Secured Authorization Response Mode for OAuth 2.0 (JARM) utilities.
Classes for representing, serialising and parsing core OpenID Connect
concepts.
-
Uses of ResponseMode in com.nimbusds.oauth2.sdk
Fields in com.nimbusds.oauth2.sdk declared as ResponseModeModifier and TypeFieldDescriptionstatic final ResponseMode
ResponseMode.FORM_POST
The authorisation response parameters are encoded as HTML form values that are auto-submitted in the User Agent, and thus are transmitted via the HTTP POST method to the client, with the result parameters being encoded in the body using theapplication/x-www-form-urlencoded
format.static final ResponseMode
ResponseMode.FORM_POST_JWT
The authorisation response parameters are packaged in a JSON Web Token (JWT) which is transmitted via the HTTP POST method to the client.static final ResponseMode
ResponseMode.FRAGMENT
The authorisation response parameters are encoded in the fragment added to theredirect_uri
when redirecting back to the client.static final ResponseMode
ResponseMode.FRAGMENT_JWT
The authorisation response parameters are packaged in a JSON Web Token (JWT) which is returned as aresponse
fragment parameter added to theredirect_uri
when redirecting back to the client.static final ResponseMode
ResponseMode.JWT
The authorisation response parameters are packaged in a JSON Web Token (JWT) which is returned as aresponse
parameter using the redirect encoding (query.jwt
,fragment.jwt
for the requestedresponse_type
.static final ResponseMode
ResponseMode.QUERY
The authorisation response parameters are encoded in the query string added to theredirect_uri
when redirecting back to the client.static final ResponseMode
ResponseMode.QUERY_JWT
The authorisation response parameters are packaged in a JSON Web Token (JWT) which is returned as aresponse
query parameter added to theredirect_uri
when redirecting back to the client.Methods in com.nimbusds.oauth2.sdk that return ResponseModeModifier and TypeMethodDescriptionAuthorizationRequest.getResponseMode()
Returns the optional response mode.AuthorizationResponse.getResponseMode()
Returns the optional explicit response mode.GeneralException.getResponseMode()
Gets the associated response mode.AuthorizationErrorResponse.impliedResponseMode()
AuthorizationRequest.impliedResponseMode()
Returns the implied response mode, determined by the optionalresponse_mode
parameter, and if that isn't specified, by theresponse_type
.abstract ResponseMode
AuthorizationResponse.impliedResponseMode()
Determines the implied response mode.AuthorizationSuccessResponse.impliedResponseMode()
static ResponseMode
ResponseMode.resolve
(ResponseMode rm, ResponseType rt) Resolves the requested response mode.static ResponseMode
ResponseMode.resolveJARM
(ResponseType rt) Resolves the appropriate JWT-secured authorisation response mode (JARM) for the specified response typeMethods in com.nimbusds.oauth2.sdk with parameters of type ResponseModeModifier and TypeMethodDescriptionstatic ResponseMode
ResponseMode.resolve
(ResponseMode rm, ResponseType rt) Resolves the requested response mode.AuthorizationRequest.Builder.responseMode
(ResponseMode rm) Sets the response mode.Constructors in com.nimbusds.oauth2.sdk with parameters of type ResponseModeModifierConstructorDescriptionAuthorizationErrorResponse
(URI redirectURI, com.nimbusds.jwt.JWT jwtResponse, ResponseMode rm) Creates a new JSON Web Token (JWT) secured authorisation error response.AuthorizationErrorResponse
(URI redirectURI, ErrorObject error, State state, Issuer issuer, ResponseMode rm) Creates a new authorisation error response.AuthorizationErrorResponse
(URI redirectURI, ErrorObject error, State state, ResponseMode rm) Creates a new authorisation error response.AuthorizationRequest
(URI uri, ResponseType rt, ResponseMode rm, ClientID clientID, URI redirectURI, Scope scope, State state) Creates a new authorisation request.AuthorizationRequest
(URI uri, ResponseType rt, ResponseMode rm, ClientID clientID, URI redirectURI, Scope scope, State state, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<AuthorizationDetail> authorizationDetails, List<URI> resources, boolean includeGrantedScopes, com.nimbusds.jwt.JWT requestObject, URI requestURI, Prompt prompt, JWKThumbprintConfirmation dpopJKT, TrustChain trustChain, Map<String, List<String>> customParams) Creates a new authorisation request with extension and custom parameters.AuthorizationRequest
(URI uri, ResponseType rt, ResponseMode rm, ClientID clientID, URI redirectURI, Scope scope, State state, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, com.nimbusds.jwt.JWT requestObject, URI requestURI, Prompt prompt, JWKThumbprintConfirmation dpopJKT, TrustChain trustChain, Map<String, List<String>> customParams) Deprecated.AuthorizationRequest
(URI uri, ResponseType rt, ResponseMode rm, ClientID clientID, URI redirectURI, Scope scope, State state, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, com.nimbusds.jwt.JWT requestObject, URI requestURI, Prompt prompt, JWKThumbprintConfirmation dpopJKT, Map<String, List<String>> customParams) Deprecated.AuthorizationRequest
(URI uri, ResponseType rt, ResponseMode rm, ClientID clientID, URI redirectURI, Scope scope, State state, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, com.nimbusds.jwt.JWT requestObject, URI requestURI, Prompt prompt, Map<String, List<String>> customParams) Deprecated.protected
AuthorizationResponse
(URI redirectURI, com.nimbusds.jwt.JWT jwtResponse, ResponseMode rm) Creates a new JSON Web Token (JWT) secured authorisation response.protected
AuthorizationResponse
(URI redirectURI, State state, Issuer issuer, ResponseMode rm) Creates a new authorisation response.AuthorizationSuccessResponse
(URI redirectURI, com.nimbusds.jwt.JWT jwtResponse, ResponseMode rm) Creates a new JSON Web Token (JWT) secured authorisation success response.AuthorizationSuccessResponse
(URI redirectURI, AuthorizationCode code, AccessToken accessToken, State state, Issuer issuer, ResponseMode rm) Creates a new authorisation success response.AuthorizationSuccessResponse
(URI redirectURI, AuthorizationCode code, AccessToken accessToken, State state, ResponseMode rm) Creates a new authorisation success response.GeneralException
(String message, ErrorObject error, ClientID clientID, URI redirectURI, ResponseMode responseMode, State state) Creates a new general exception.GeneralException
(String message, ErrorObject error, ClientID clientID, URI redirectURI, ResponseMode responseMode, State state, Throwable cause) Creates a new general exception.ParseException
(String message, ErrorObject error, ClientID clientID, URI redirectURI, ResponseMode responseMode, State state) Creates a new parse exception.ParseException
(String message, ErrorObject error, ClientID clientID, URI redirectURI, ResponseMode responseMode, State state, Throwable cause) Creates a new parse exception. -
Uses of ResponseMode in com.nimbusds.oauth2.sdk.as
Methods in com.nimbusds.oauth2.sdk.as that return types with arguments of type ResponseModeModifier and TypeMethodDescriptionAuthorizationServerMetadata.getResponseModes()
ReadOnlyAuthorizationServerMetadata.getResponseModes()
Gets the supported response mode values.Method parameters in com.nimbusds.oauth2.sdk.as with type arguments of type ResponseModeModifier and TypeMethodDescriptionvoid
AuthorizationServerMetadata.setResponseModes
(List<ResponseMode> rms) Sets the supported response mode values. -
Uses of ResponseMode in com.nimbusds.oauth2.sdk.jarm
Fields in com.nimbusds.oauth2.sdk.jarm with type parameters of type ResponseModeModifier and TypeFieldDescriptionstatic final Set<ResponseMode>
JARMUtils.RESPONSE_MODES
The JARM response modes. -
Uses of ResponseMode in com.nimbusds.openid.connect.sdk
Methods in com.nimbusds.openid.connect.sdk that return ResponseModeMethods in com.nimbusds.openid.connect.sdk with parameters of type ResponseModeModifier and TypeMethodDescriptionAuthenticationRequest.Builder.responseMode
(ResponseMode rm) Sets the response mode.Constructors in com.nimbusds.openid.connect.sdk with parameters of type ResponseModeModifierConstructorDescriptionAuthenticationErrorResponse
(URI redirectURI, com.nimbusds.jwt.JWT jwtResponse, ResponseMode rm) Creates a new JSON Web Token (JWT) secured OpenID Connect authentication error response.AuthenticationErrorResponse
(URI redirectURI, ErrorObject error, State state, Issuer issuer, ResponseMode rm) Creates a new OpenID Connect authentication error response.AuthenticationErrorResponse
(URI redirectURI, ErrorObject error, State state, ResponseMode rm) Creates a new OpenID Connect authentication error response.AuthenticationRequest
(URI uri, ResponseType rt, ResponseMode rm, Scope scope, ClientID clientID, URI redirectURI, State state, Nonce nonce, Display display, Prompt prompt, int maxAge, List<com.nimbusds.langtag.LangTag> uiLocales, List<com.nimbusds.langtag.LangTag> claimsLocales, com.nimbusds.jwt.JWT idTokenHint, String loginHint, List<ACR> acrValues, ClaimsRequest claims, String purpose, com.nimbusds.jwt.JWT requestObject, URI requestURI, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, Map<String, List<String>> customParams) Deprecated.AuthenticationRequest
(URI uri, ResponseType rt, ResponseMode rm, Scope scope, ClientID clientID, URI redirectURI, State state, Nonce nonce, Display display, Prompt prompt, int maxAge, List<com.nimbusds.langtag.LangTag> uiLocales, List<com.nimbusds.langtag.LangTag> claimsLocales, com.nimbusds.jwt.JWT idTokenHint, String loginHint, List<ACR> acrValues, OIDCClaimsRequest claims, String purpose, com.nimbusds.jwt.JWT requestObject, URI requestURI, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, Map<String, List<String>> customParams) Deprecated.AuthenticationRequest
(URI uri, ResponseType rt, ResponseMode rm, Scope scope, ClientID clientID, URI redirectURI, State state, Nonce nonce, Display display, Prompt prompt, JWKThumbprintConfirmation dpopJKT, int maxAge, List<com.nimbusds.langtag.LangTag> uiLocales, List<com.nimbusds.langtag.LangTag> claimsLocales, com.nimbusds.jwt.JWT idTokenHint, String loginHint, List<ACR> acrValues, OIDCClaimsRequest claims, String purpose, com.nimbusds.jwt.JWT requestObject, URI requestURI, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, Map<String, List<String>> customParams) Deprecated.AuthenticationRequest
(URI uri, ResponseType rt, ResponseMode rm, Scope scope, ClientID clientID, URI redirectURI, State state, Nonce nonce, Display display, Prompt prompt, JWKThumbprintConfirmation dpopJKT, TrustChain trustChain, int maxAge, List<com.nimbusds.langtag.LangTag> uiLocales, List<com.nimbusds.langtag.LangTag> claimsLocales, com.nimbusds.jwt.JWT idTokenHint, String loginHint, List<ACR> acrValues, OIDCClaimsRequest claims, String purpose, com.nimbusds.jwt.JWT requestObject, URI requestURI, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<AuthorizationDetail> authorizationDetails, List<URI> resources, boolean includeGrantedScopes, Map<String, List<String>> customParams) Creates a new OpenID Connect authentication request with extension and custom parameters.AuthenticationRequest
(URI uri, ResponseType rt, ResponseMode rm, Scope scope, ClientID clientID, URI redirectURI, State state, Nonce nonce, Display display, Prompt prompt, JWKThumbprintConfirmation dpopJKT, TrustChain trustChain, int maxAge, List<com.nimbusds.langtag.LangTag> uiLocales, List<com.nimbusds.langtag.LangTag> claimsLocales, com.nimbusds.jwt.JWT idTokenHint, String loginHint, List<ACR> acrValues, OIDCClaimsRequest claims, String purpose, com.nimbusds.jwt.JWT requestObject, URI requestURI, CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod, List<URI> resources, boolean includeGrantedScopes, Map<String, List<String>> customParams) Deprecated.AuthenticationSuccessResponse
(URI redirectURI, com.nimbusds.jwt.JWT jwtResponse, ResponseMode rm) Creates a new JSON Web Token (JWT) secured OpenID Connect authentication success response.AuthenticationSuccessResponse
(URI redirectURI, AuthorizationCode code, com.nimbusds.jwt.JWT idToken, AccessToken accessToken, State state, State sessionState, Issuer issuer, ResponseMode rm) Creates a new OpenID Connect authentication success response.AuthenticationSuccessResponse
(URI redirectURI, AuthorizationCode code, com.nimbusds.jwt.JWT idToken, AccessToken accessToken, State state, State sessionState, ResponseMode rm) Creates a new OpenID Connect authentication success response.