Package org.apache.juneau.http.header

Class Authorization.Builder

java.lang.Object
org.apache.juneau.http.header.Authorization.Builder
Enclosing class:
Authorization
public static class Authorization.Builder extends Object
Fluent builder for assembling an HTTP Authorization credentials value.

Composes the scheme 1*SP ( token68 / #auth-param ) credentials form defined by RFC 7235 ยง4.2. The basic(String, String) and bearer(String) presets render the opaque token68 form; the digest() preset enables the typed Digest auth-params, which apply the correct quoting (quoted-string vs token). param(String, String) is a generic escape hatch so new params never require an API change. Setting a scheme preset or token(String) clears any previously-registered auth-params and vice versa, so a built value carries either a token68 or an auth-param list, never both.

Example:

String value = Authorization.create() .digest() .username("Mufasa") .realm("http-auth@example.org") .uri("/dir/index.html") .qop("auth") .nc("00000001") .response("8ca523f5e9506fed4657c9700eebdbec") .build(); // => "Digest username=\"Mufasa\", realm=\"...\", uri=\"/dir/index.html\", qop=auth, nc=00000001, response=\"...\""

See Also:
Since:
10.0.0

  • Constructor Details

  • Method Details

    • scheme

      public Authorization.Builder scheme(String value)
      Sets the authentication scheme (e.g. "Basic", "Bearer", "Digest").
      Parameters:
      value - The scheme name. Must not be null or blank.
      Returns:
      This object.
      Throws:
      IllegalArgumentException - If value is null or blank.

    • basic

      public Authorization.Builder basic(String user, String password)
      Sets Basic credentials by base64-encoding user:password as the token68 form.
      Parameters:
      user - The username. Must not be null.
      password - The password. Must not be null.
      Returns:
      This object.

    • bearer

      public Authorization.Builder bearer(String token)
      Sets Bearer credentials with the supplied token as the token68 form.
      Parameters:
      token - The bearer token. Must not be null.
      Returns:
      This object.

    • digest

      public Authorization.Builder digest()
      Sets the scheme to Digest (typed Digest auth-params can then be chained).
      Returns:
      This object.

    • token

      public Authorization.Builder token(String value)
      Sets the opaque token68 credentials form, clearing any auth-params.
      Parameters:
      value - The token68 value. Must not be null.
      Returns:
      This object.

    • username

      public Authorization.Builder username(String value)
      Sets the username auth-param (rendered as a quoted-string).
      Parameters:
      value - The username. Must not be null.
      Returns:
      This object.

    • realm

      public Authorization.Builder realm(String value)
      Sets the realm auth-param (rendered as a quoted-string).
      Parameters:
      value - The realm. Must not be null.
      Returns:
      This object.

    • nonce

      public Authorization.Builder nonce(String value)
      Sets the nonce auth-param (rendered as a quoted-string).
      Parameters:
      value - The server nonce echoed back from the challenge. Must not be null.
      Returns:
      This object.

    • uri

      public Authorization.Builder uri(String value)
      Sets the uri auth-param (rendered as a quoted-string).
      Parameters:
      value - The effective request URI. Must not be null.
      Returns:
      This object.

    • response

      public Authorization.Builder response(String value)
      Sets the response auth-param (rendered as a quoted-string).
      Parameters:
      value - The computed digest response. Must not be null.
      Returns:
      This object.

    • cnonce

      public Authorization.Builder cnonce(String value)
      Sets the cnonce auth-param (rendered as a quoted-string).
      Parameters:
      value - The client nonce. Must not be null.
      Returns:
      This object.

    • opaque

      public Authorization.Builder opaque(String value)
      Sets the opaque auth-param (rendered as a quoted-string).
      Parameters:
      value - The opaque value echoed back from the challenge. Must not be null.
      Returns:
      This object.

    • algorithm

      public Authorization.Builder algorithm(String value)
      Sets the algorithm auth-param (rendered as a bare token, unquoted).
      Parameters:
      value - The algorithm (e.g. "MD5", "SHA-256"). Must not be null.
      Returns:
      This object.

    • qop

      public Authorization.Builder qop(String value)
      Sets the qop auth-param (rendered as a bare token, unquoted; a single value in credentials).
      Parameters:
      value - The quality-of-protection token (e.g. "auth"). Must not be null.
      Returns:
      This object.

    • nc

      public Authorization.Builder nc(String value)
      Sets the nc (nonce-count) auth-param (rendered as a bare token, unquoted).
      Parameters:
      value - The 8-digit hex nonce-count (e.g. "00000001"). Must not be null.
      Returns:
      This object.

    • param

      public Authorization.Builder param(String name, String value)
      Generic escape hatch for setting any auth-param by name, rendered as a quoted-string.

      Replaces any previously-registered value for the same param while preserving its original position, and clears any previously-set token68.

      Parameters:
      name - The auth-param name. Must not be null or blank.
      value - The auth-param value (quoted automatically). Must not be null.
      Returns:
      This object.
      Throws:
      IllegalArgumentException - If name is null or blank.

    • build

      public String build()
      Builds the rendered Authorization credentials value.

      Returns an empty string when no scheme has been registered.

      Returns:
      The header value. Never null.

    • toHeader

      public Authorization toHeader()
      Builds an Authorization header bean directly from this builder.
      Returns:
      An Authorization carrying build(). Never null.

    • toString

      public String toString()
      Overrides:
      toString in class Object