Package io.vertx.ext.auth.authentication
Class UsernamePasswordCredentials
- java.lang.Object
-
- io.vertx.ext.auth.authentication.UsernamePasswordCredentials
-
- All Implemented Interfaces:
Credentials
- Direct Known Subclasses:
HtdigestCredentials
public class UsernamePasswordCredentials extends Object implements Credentials
Credentials used by anyAuthenticationProviderthat requires tokens, for example JWT, Oauth2, OpenId Connect- Author:
- Paulo Lopes
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedUsernamePasswordCredentials()UsernamePasswordCredentials(JsonObject jsonObject)UsernamePasswordCredentials(String username, String password)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UsernamePasswordCredentialsapplyHttpChallenge(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.StringgetPassword()StringgetUsername()UsernamePasswordCredentialssetPassword(String password)UsernamePasswordCredentialssetUsername(String username)StringtoHttpAuthorization()Encodes this credential as an HTTP Authorization https://tools.ietf.org/html/rfc7235.JsonObjecttoJson()Simple interop to downcast back to JSON for backwards compatibility.StringtoString()-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface io.vertx.ext.auth.authentication.Credentials
applyHttpChallenge, applyHttpChallenge
-
-
-
-
Constructor Detail
-
UsernamePasswordCredentials
protected UsernamePasswordCredentials()
-
UsernamePasswordCredentials
public UsernamePasswordCredentials(JsonObject jsonObject)
-
-
Method Detail
-
getPassword
public String getPassword()
-
getUsername
public String getUsername()
-
setPassword
public UsernamePasswordCredentials setPassword(String password)
-
setUsername
public UsernamePasswordCredentials setUsername(String username)
-
checkValid
public <V> void checkValid(V arg) throws CredentialValidationExceptionDescription 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
public JsonObject 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.
-
applyHttpChallenge
public UsernamePasswordCredentials 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
public String 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.
-
-