Interface Credentials

    • Method Detail

      • checkValid

        default <V> void checkValid​(V arg)
                             throws CredentialValidationException
        Implementors 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.
        Type Parameters:
        V - the generic type of the argument
        Parameters:
        arg - optional argument or null.
        Throws:
        CredentialValidationException - when the validation fails
      • toJson

        JsonObject toJson()
        Simple interop to downcast back to JSON for backwards compatibility.
        Returns:
        JSON representation of this credential.
      • applyHttpChallenge

        default Credentials applyHttpChallenge​(String challenge,
                                               HttpMethod method,
                                               String uri,
                                               Integer nc,
                                               String cnonce)
                                        throws CredentialValidationException
        Applies 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.

        Parameters:
        challenge - the challenge is the WWW-Authenticate header 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.
      • applyHttpChallenge

        default Credentials applyHttpChallenge​(String challenge,
                                               HttpMethod method,
                                               String uri)
                                        throws CredentialValidationException
        Applies 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.

        Parameters:
        challenge - the challenge is the WWW-Authenticate header 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.
        Returns:
        fluent self.
        Throws:
        CredentialValidationException - if the challenge cannot be applicable.
      • applyHttpChallenge

        default Credentials applyHttpChallenge​(String challenge)
                                        throws CredentialValidationException
        Applies 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.

        Parameters:
        challenge - the challenge is the WWW-Authenticate header 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.
        Returns:
        fluent self.
        Throws:
        CredentialValidationException - if the challenge cannot be applicable.