Package com.linecorp.armeria.common.auth.oauth2

Interface ClientAuthentication

@UnstableApi
public interface ClientAuthentication

Provides client authentication for the OAuth 2.0 requests, as per [RFC6749], Section 2.3. For example:

 Authorization: Basic czZCaGRSa3F0Mzo3RmpmcDBaQnIxS3REUmJuZlZkbUl3
 

Method Summary

Modifier and Type	Method	Description
void	addAsBodyParams(QueryParamsBuilder formBuilder)	Sets this ClientAuthentication as body parameters.
void	addAsHeaders(HttpHeadersBuilder headersBuilder)	Sets this ClientAuthentication as headers.
default QueryParams	asBodyParams()	Returns this ClientAuthentication as body parameters.
default HttpHeaders	asHeaders()	Returns this ClientAuthentication as HttpHeaders.
static ClientAuthentication	ofAuthorization(String authorizationScheme, String authorization)	Returns a ClientAuthentication for the OAuth 2.0 requests based on encoded authorization token and authorization type, as per [RFC6749], Section 2.3.
static ClientAuthentication	ofBasic(String authorization)	Returns a ClientAuthentication for the OAuth 2.0 requests based on encoded HTTP basic authorization token, as per [RFC6749], Section 2.3.
static ClientAuthentication	ofClientPassword(String clientId, String clientSecret)	Returns a ClientAuthentication for the given client ID and client secret, as per [RFC6749], Section 2.3.1.
static ClientAuthentication	ofClientPassword(String clientId, String clientSecret, boolean useBasicAuth)	Returns a ClientAuthentication for the given client ID and client secret, as per [RFC6749], Section 2.3.1.
static ClientAuthentication	ofJsonWebToken(String jsonWebToken)	Returns a ClientAuthentication for the given JSON Web Token (JWT), as per [RFC7523], Section 2.2.

Method Details

ofClientPassword

static ClientAuthentication ofClientPassword(String clientId,
 String clientSecret)

Returns a ClientAuthentication for the given client ID and client secret, as per [RFC6749], Section 2.3.1. The ClientAuthentication will be encoded as the HTTP Basic authentication.

ofClientPassword

static ClientAuthentication ofClientPassword(String clientId,
 String clientSecret,
 boolean useBasicAuth)

Returns a ClientAuthentication for the given client ID and client secret, as per [RFC6749], Section 2.3.1.

Note that if useBasicAuth is false, the client ID and client secret will be added as body parameters.

ofJsonWebToken

static ClientAuthentication ofJsonWebToken(String jsonWebToken)

Returns a ClientAuthentication for the given JSON Web Token (JWT), as per [RFC7523], Section 2.2.

ofAuthorization

static ClientAuthentication ofAuthorization(String authorizationScheme,
 String authorization)

Returns a ClientAuthentication for the OAuth 2.0 requests based on encoded authorization token and authorization type, as per [RFC6749], Section 2.3.

Parameters:

authorizationScheme - One of the registered HTTP authentication schemes as per HTTP Authentication Scheme Registry.

authorization - A client authorization token.

ofBasic

static ClientAuthentication ofBasic(String authorization)

Returns a ClientAuthentication for the OAuth 2.0 requests based on encoded HTTP basic authorization token, as per [RFC6749], Section 2.3.

Parameters:

authorization - A client authorization token.

addAsHeaders

void addAsHeaders(HttpHeadersBuilder headersBuilder)

Sets this ClientAuthentication as headers.

The client authentication can be set via the given HttpHeadersBuilder or addAsBodyParams(QueryParamsBuilder).

asHeaders

default HttpHeaders asHeaders()

Returns this ClientAuthentication as HttpHeaders.

addAsBodyParams

void addAsBodyParams(QueryParamsBuilder formBuilder)

Sets this ClientAuthentication as body parameters.

The client authentication can be set via the given QueryParamsBuilder or addAsHeaders(HttpHeadersBuilder).

asBodyParams

default QueryParams asBodyParams()

Returns this ClientAuthentication as body parameters.