Package com.linecorp.armeria.server.auth
Class AuthServiceBuilder
java.lang.Object
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 anAuthorizer
.AuthServiceBuilder
add(Iterable<? extends Authorizer<HttpRequest>> authorizers)
Adds multipleAuthorizer
s.AuthServiceBuilder
addBasicAuth(Authorizer<? super BasicToken> authorizer)
Adds an HTTP basicAuthorizer
.AuthServiceBuilder
addBasicAuth(Authorizer<? super BasicToken> authorizer, CharSequence header)
Adds an HTTP basicAuthorizer
for the givenheader
.AuthServiceBuilder
addOAuth1a(Authorizer<? super OAuth1aToken> authorizer)
Adds an OAuth1aAuthorizer
.AuthServiceBuilder
addOAuth1a(Authorizer<? super OAuth1aToken> authorizer, CharSequence header)
Adds an OAuth1aAuthorizer
for the givenheader
.AuthServiceBuilder
addOAuth2(Authorizer<? super OAuth2Token> authorizer)
Adds an OAuth2Authorizer
.AuthServiceBuilder
addOAuth2(Authorizer<? super OAuth2Token> authorizer, CharSequence header)
Adds an OAuth2Authorizer
for the givenheader
.<T> AuthServiceBuilder
addTokenAuthorizer(Function<? super RequestHeaders,T> tokenExtractor, Authorizer<? super T> authorizer)
Adds a token-basedAuthorizer
.AuthService
build(HttpService delegate)
Returns a newly-createdAuthService
based on theAuthorizer
s added to this builder.Function<? super HttpService,AuthService>
newDecorator()
Returns a newly-created decorator that decorates anHttpService
with a newAuthService
based on theAuthorizer
s added to this builder.AuthServiceBuilder
onFailure(AuthFailureHandler failureHandler)
Sets theAuthFailureHandler
which handles the requests with failed authorization.AuthServiceBuilder
onSuccess(AuthSuccessHandler successHandler)
Sets theAuthSuccessHandler
which handles successfully authorized requests.
-
Method Details
-
add
Adds anAuthorizer
. -
add
Adds multipleAuthorizer
s. -
addBasicAuth
Adds an HTTP basicAuthorizer
. -
addBasicAuth
public AuthServiceBuilder addBasicAuth(Authorizer<? super BasicToken> authorizer, CharSequence header)Adds an HTTP basicAuthorizer
for the givenheader
. -
addOAuth1a
Adds an OAuth1aAuthorizer
. -
addOAuth1a
public AuthServiceBuilder addOAuth1a(Authorizer<? super OAuth1aToken> authorizer, CharSequence header)Adds an OAuth1aAuthorizer
for the givenheader
. -
addOAuth2
Adds an OAuth2Authorizer
. -
addOAuth2
public AuthServiceBuilder addOAuth2(Authorizer<? super OAuth2Token> authorizer, CharSequence header)Adds an OAuth2Authorizer
for the givenheader
. -
addTokenAuthorizer
public <T> AuthServiceBuilder addTokenAuthorizer(Function<? super RequestHeaders,T> tokenExtractor, Authorizer<? super T> authorizer)Adds a token-basedAuthorizer
. -
onSuccess
Sets theAuthSuccessHandler
which handles successfully authorized requests. By default, the request will be delegated to the nextHttpService
. -
onFailure
Sets theAuthFailureHandler
which handles the requests with failed authorization. By default, an exception thrown during authorization is logged at WARN level (if any) and a401 Unauthorized
response will be sent. -
build
Returns a newly-createdAuthService
based on theAuthorizer
s added to this builder. -
newDecorator
Returns a newly-created decorator that decorates anHttpService
with a newAuthService
based on theAuthorizer
s added to this builder.
-