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

Class ClientAuthorization

java.lang.Object

com.linecorp.armeria.common.auth.oauth2.ClientAuthorization

@Deprecated
public final class ClientAuthorization
extends Object

Deprecated.

Use ClientAuthentication instead.

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

 Authorization: Basic czZCaGRSa3F0Mzo3RmpmcDBaQnIxS3REUmJuZlZkbUl3
 

Fetches authorization source from the designated authorization or credentials supplier, which might be facilitated by a secure Secret provider. Will fetch the authorization source for each request. Therefore the designated supplier must cache the value in order to avoid unnecessary network hops. The authorization source might either provide complete authorization token or client credentials.

Method Summary

Modifier and Type	Method	Description
void	addAsBodyParameters(QueryParamsBuilder formBuilder)	Deprecated. Fetches client credentials from the supplier and composes required body parameters, as per [RFC6749], Section 2.3:
QueryParams	asBodyParameters()	Deprecated. Fetches client credentials from the supplier and composes required body parameters, as per [RFC6749], Section 2.3:
String	asHeaderValue()	Deprecated. Fetches client authorization token or client credentials from the supplier and composes client Authorization header value, as per [RFC6749], Section 2.3:
static ClientAuthorization	ofAuthorization(Supplier<String> authorizationSupplier, String authorizationType)	Deprecated. Use ClientAuthentication.ofAuthorization(String, String) instead.
static ClientAuthorization	ofBasicAuthorization(Supplier<String> authorizationSupplier)	Deprecated. Use ClientAuthentication.ofBasic(String)} instead.
static ClientAuthorization	ofCredentials(Supplier<? extends Map.Entry<String,String>> credentialsSupplier)	Deprecated. Use ClientAuthentication.ofClientPassword(String, String) instead.
static ClientAuthorization	ofCredentials(Supplier<? extends Map.Entry<String,String>> credentialsSupplier, String authorizationType)	Deprecated. Use ClientAuthentication.ofClientPassword(String, String) or ClientAuthentication.ofAuthorization(String, String) instead.
ClientAuthentication	toClientAuthentication()	Deprecated. Converts this ClientAuthorization to a ClientAuthentication.
String	toString()	Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

ofAuthorization

@Deprecated
public static ClientAuthorization ofAuthorization(Supplier<String> authorizationSupplier,
 String authorizationType)

Deprecated.

Use ClientAuthentication.ofAuthorization(String, String) instead.

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

Parameters:

authorizationSupplier - A supplier of encoded client authorization token.

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

ofBasicAuthorization

@Deprecated
public static ClientAuthorization ofBasicAuthorization(Supplier<String> authorizationSupplier)

Deprecated.

Use ClientAuthentication.ofBasic(String)} instead.

Provides client authorization for the OAuth 2.0 requests based on encoded authorization token and Basic authorization type, as per [RFC6749], Section 2.3.

Parameters:

authorizationSupplier - A supplier of encoded client authorization token.

ofCredentials

@Deprecated
public static ClientAuthorization ofCredentials(Supplier<? extends Map.Entry<String,String>> credentialsSupplier,
 String authorizationType)

Deprecated.

Use ClientAuthentication.ofClientPassword(String, String) or ClientAuthentication.ofAuthorization(String, String) instead.

Provides client authorization for the OAuth 2.0 requests based on client credentials and authorization type, as per [RFC6749], Section 2.3.

Parameters:

credentialsSupplier - A supplier of client credentials.

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

ofCredentials

@Deprecated
public static ClientAuthorization ofCredentials(Supplier<? extends Map.Entry<String,String>> credentialsSupplier)

Deprecated.

Use ClientAuthentication.ofClientPassword(String, String) instead.

Provides client authorization for the OAuth 2.0 requests based on client credentials and Basic authorization type, as per [RFC6749], Section 2.3.

Parameters:

credentialsSupplier - A supplier of client credentials.

asHeaderValue

public String asHeaderValue()

Deprecated.

Fetches client authorization token or client credentials from the supplier and composes client Authorization header value, as per [RFC6749], Section 2.3:

 Authorization: Basic czZCaGRSa3F0Mzo3RmpmcDBaQnIxS3REUmJuZlZkbUl3
 

.

Returns:

encoded client Authorization header value.

addAsBodyParameters

public void addAsBodyParameters(QueryParamsBuilder formBuilder)

Deprecated.

Fetches client credentials from the supplier and composes required body parameters, as per [RFC6749], Section 2.3:

 client_id=s6BhdRkqt3&client_secret=7Fjfp0ZBr1KtDRbnfVdmIw
 

. The client MAY omit the client_secret parameter if the client secret is an empty string.

asBodyParameters

public QueryParams asBodyParameters()

Deprecated.

Fetches client credentials from the supplier and composes required body parameters, as per [RFC6749], Section 2.3:

 client_id=s6BhdRkqt3&client_secret=7Fjfp0ZBr1KtDRbnfVdmIw
 

. The client MAY omit the client_secret parameter if the client secret is an empty string.

Returns:

encoded client credentials request body parameters as QueryParams.

toClientAuthentication

public ClientAuthentication toClientAuthentication()

Deprecated.

Converts this ClientAuthorization to a ClientAuthentication.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object