com.linecorp.armeria.server.auth.AuthServiceBuilder

public final class AuthServiceBuilder
extends Object

Builds a new AuthService.

Method Summary

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

Method Details
- add
  
  public AuthServiceBuilder add(Authorizer<HttpRequest> authorizer)
  
  Adds an Authorizer.
- add
  
  public AuthServiceBuilder add(Iterable<? extends Authorizer<HttpRequest>> authorizers)
  
  Adds multiple Authorizers.
- addBasicAuth
  
  public AuthServiceBuilder addBasicAuth(Authorizer<? super BasicToken> authorizer)
  
  Adds an HTTP basic Authorizer.
- addBasicAuth
  
  public AuthServiceBuilder addBasicAuth(Authorizer<? super BasicToken> authorizer, CharSequence header)
  
  Adds an HTTP basic Authorizer for the given header.
- addOAuth1a
  
  public AuthServiceBuilder addOAuth1a(Authorizer<? super OAuth1aToken> authorizer)
  
  Adds an OAuth1a Authorizer.
- addOAuth1a
  
  public AuthServiceBuilder addOAuth1a(Authorizer<? super OAuth1aToken> authorizer, CharSequence header)
  
  Adds an OAuth1a Authorizer for the given header.
- addOAuth2
  
  public AuthServiceBuilder addOAuth2(Authorizer<? super OAuth2Token> authorizer)
  
  Adds an OAuth2 Authorizer.
- addOAuth2
  
  public AuthServiceBuilder addOAuth2(Authorizer<? super OAuth2Token> authorizer, CharSequence header)
  
  Adds an OAuth2 Authorizer for the given header.
- addTokenAuthorizer
  
  public <T> AuthServiceBuilder addTokenAuthorizer(Function<? super RequestHeaders,T> tokenExtractor, Authorizer<? super T> authorizer)
  
  Adds a token-based Authorizer.
- onSuccess
  
  public AuthServiceBuilder onSuccess(AuthSuccessHandler successHandler)
  
  Sets the AuthSuccessHandler which handles successfully authorized requests. By default, the request will be delegated to the next HttpService.
- onFailure
  
  public AuthServiceBuilder onFailure(AuthFailureHandler 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 AuthService build(HttpService delegate)
  
  Returns a newly-created AuthService based on the Authorizers added to this builder.
- newDecorator
  
  public Function<? super HttpService,AuthService> newDecorator()
  
  Returns a newly-created decorator that decorates an HttpService with a new AuthService based on the Authorizers added to this builder.

Class AuthServiceBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Details