com.linecorp.armeria.server.auth

Class HttpAuthServiceBuilder

java.lang.Object

com.linecorp.armeria.server.auth.HttpAuthServiceBuilder

public final class HttpAuthServiceBuilder
extends Object

Builds a new HttpAuthService.

Constructor Summary

Constructors

Constructor and Description
HttpAuthServiceBuilder()

Method Summary

Modifier and Type	Method and Description
HttpAuthServiceBuilder	add(Authorizer<HttpRequest> authorizer) Adds an Authorizer.
HttpAuthServiceBuilder	add(Iterable<? extends Authorizer<HttpRequest>> authorizers) Adds multiple Authorizers.
HttpAuthServiceBuilder	addBasicAuth(Authorizer<? super BasicToken> authorizer) Adds an HTTP basic Authorizer.
HttpAuthServiceBuilder	addBasicAuth(Authorizer<? super BasicToken> authorizer, CharSequence header) Adds an HTTP basic Authorizer for the given header.
HttpAuthServiceBuilder	addOAuth1a(Authorizer<? super OAuth1aToken> authorizer) Adds an OAuth1a Authorizer.
HttpAuthServiceBuilder	addOAuth1a(Authorizer<? super OAuth1aToken> authorizer, CharSequence header) Adds an OAuth1a Authorizer for the given header.
HttpAuthServiceBuilder	addOAuth2(Authorizer<? super OAuth2Token> authorizer) Adds an OAuth2 Authorizer.
HttpAuthServiceBuilder	addOAuth2(Authorizer<? super OAuth2Token> authorizer, CharSequence header) Adds an OAuth2 Authorizer for the given header.
<T> HttpAuthServiceBuilder	addTokenAuthorizer(Function<? super RequestHeaders,T> tokenExtractor, Authorizer<? super T> authorizer) Adds a token-based Authorizer.
HttpAuthService	build(HttpService delegate) Returns a newly-created HttpAuthService based on the Authorizers added to this builder.
Function<? super HttpService,HttpAuthService>	newDecorator() Returns a newly-created decorator that decorates an HttpService with a new HttpAuthService based on the Authorizers added to this builder.
HttpAuthServiceBuilder	onFailure(AuthFailureHandler<HttpRequest,HttpResponse> failureHandler) Sets the AuthFailureHandler which handles the requests with failed authorization.
HttpAuthServiceBuilder	onSuccess(AuthSuccessHandler<HttpRequest,HttpResponse> successHandler) Sets the AuthSuccessHandler which handles successfully authorized requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpAuthServiceBuilder

public HttpAuthServiceBuilder()

Method Detail

add

public HttpAuthServiceBuilder add(Authorizer<HttpRequest> authorizer)

Adds an Authorizer.

add

public HttpAuthServiceBuilder add(Iterable<? extends Authorizer<HttpRequest>> authorizers)

Adds multiple Authorizers.

addBasicAuth

public HttpAuthServiceBuilder addBasicAuth(Authorizer<? super BasicToken> authorizer)

Adds an HTTP basic Authorizer.

addBasicAuth

public HttpAuthServiceBuilder addBasicAuth(Authorizer<? super BasicToken> authorizer,
                                           CharSequence header)

Adds an HTTP basic Authorizer for the given header.

addOAuth1a

public HttpAuthServiceBuilder addOAuth1a(Authorizer<? super OAuth1aToken> authorizer)

Adds an OAuth1a Authorizer.

addOAuth1a

public HttpAuthServiceBuilder addOAuth1a(Authorizer<? super OAuth1aToken> authorizer,
                                         CharSequence header)

Adds an OAuth1a Authorizer for the given header.

addOAuth2

public HttpAuthServiceBuilder addOAuth2(Authorizer<? super OAuth2Token> authorizer)

Adds an OAuth2 Authorizer.

addOAuth2

public HttpAuthServiceBuilder addOAuth2(Authorizer<? super OAuth2Token> authorizer,
                                        CharSequence header)

Adds an OAuth2 Authorizer for the given header.

addTokenAuthorizer

public <T> HttpAuthServiceBuilder addTokenAuthorizer(Function<? super RequestHeaders,T> tokenExtractor,
                                                     Authorizer<? super T> authorizer)

Adds a token-based Authorizer.

onSuccess

public HttpAuthServiceBuilder onSuccess(AuthSuccessHandler<HttpRequest,HttpResponse> successHandler)

Sets the AuthSuccessHandler which handles successfully authorized requests. By default, the request will be delegated to the next HttpService.

onFailure

public HttpAuthServiceBuilder onFailure(AuthFailureHandler<HttpRequest,HttpResponse> failureHandler)

Sets the AuthFailureHandler which handles the requests with failed authorization. By default, an exception thrown during authorization is logged at WARN level (if any) and a 401 Unauthorized response will be sent.

build

public HttpAuthService build(HttpService delegate)

Returns a newly-created HttpAuthService based on the Authorizers added to this builder.

newDecorator

public Function<? super HttpService,HttpAuthService> newDecorator()

Returns a newly-created decorator that decorates an HttpService with a new HttpAuthService based on the Authorizers added to this builder.