Class TokenCredentials
java.lang.Object
io.vertx.ext.auth.authentication.TokenCredentials
- All Implemented Interfaces:
Credentials
Credentials used by any
AuthenticationProvider that requires Tokens, such as OAuth2 or JWT
to perform its authentication- Author:
- Paulo Lopes
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionapplyHttpChallenge(String challenge, HttpMethod method, String uri, Integer nc, String cnonce) Applies the HTTP Authorization challenge to this Credential instance.<V> voidcheckValid(V arg) Implementors should override this method to perform validation.getToken()Encodes this credential as an HTTP Authorization https://tools.ietf.org/html/rfc7235.toJson()Simple interop to downcast back to JSON for backwards compatibility.toString()Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface Credentials
applyHttpChallenge, applyHttpChallenge
-
Constructor Details
-
TokenCredentials
public TokenCredentials() -
TokenCredentials
-
TokenCredentials
-
-
Method Details
-
getToken
-
setToken
-
getScopes
-
setScopes
-
addScope
-
checkValid
Description copied from interface:CredentialsImplementors should override this method to perform validation. An argument is allowed to allow custom validation, for example, when given a configuration property, a specific property may be allowed to be null.- Specified by:
checkValidin interfaceCredentials- Type Parameters:
V- the generic type of the argument- Parameters:
arg- optional argument or null.- Throws:
CredentialValidationException- when the validation fails
-
toJson
Description copied from interface:CredentialsSimple interop to downcast back to JSON for backwards compatibility.- Specified by:
toJsonin interfaceCredentials- Returns:
- JSON representation of this credential.
-
toString
-
applyHttpChallenge
public TokenCredentials applyHttpChallenge(String challenge, HttpMethod method, String uri, Integer nc, String cnonce) throws CredentialValidationException Description copied from interface:CredentialsApplies the HTTP Authorization challenge to this Credential instance. The internal state can change to reflect the extra properties the challenge conveys.See https://tools.ietf.org/html/rfc7235 for more information.
- Specified by:
applyHttpChallengein interfaceCredentials- Parameters:
challenge- the challenge is theWWW-Authenticateheader response from a 401 request. Null challenges are allowed, and in this case, no verification will be performed, however it is up to the implementation to permit this.method- The http method this response is responding.uri- The http uri this response is responding.nc- The client internal counter (optional).cnonce- The client internal nonce (optional).- Returns:
- fluent self.
- Throws:
CredentialValidationException- if the challenge cannot be applicable.
-
toHttpAuthorization
Description copied from interface:CredentialsEncodes this credential as an HTTP Authorization https://tools.ietf.org/html/rfc7235.Calls to this method, expect that
Credentials.applyHttpChallenge(String, HttpMethod, String, Integer, String)has been prior executed. For some Authentication schemes, this isn't a requirement but doing so ensures that the object is on the right state.- Specified by:
toHttpAuthorizationin interfaceCredentials- Returns:
- HTTP header including scheme.
-