Package io.servicetalk.http.security.auth.basic.jersey

Class BasicAuthSecurityContextFilters

java.lang.Object

io.servicetalk.http.security.auth.basic.jersey.BasicAuthSecurityContextFilters

public final class BasicAuthSecurityContextFilters
extends Object

Factory methods for building ContainerRequestFilter that establish SecurityContexts for requests authenticated with the Basic HTTP Authentication Scheme (RFC7617).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BasicAuthSecurityContextFilters.AbstractBuilder<B extends BasicAuthSecurityContextFilters.AbstractBuilder,PF,SCF>	A builder for ContainerRequestFilter instances.
static class	BasicAuthSecurityContextFilters.NoUserInfoBuilder	A builder that can be used when no user info is stored in AsyncContext.
static class	BasicAuthSecurityContextFilters.UserInfoBuilder<UserInfo>	A builder that can be used when user info is stored in AsyncContext.

Method Summary

Modifier and Type	Method	Description
static BasicAuthSecurityContextFilters.NoUserInfoBuilder	forGlobalBinding()	Creates a new BasicAuthSecurityContextFilters.NoUserInfoBuilder instance for building a ContainerRequestFilter that needs to be globally bound to the JAX-RS Application.
static <UserInfo> BasicAuthSecurityContextFilters.UserInfoBuilder<UserInfo>	forGlobalBinding(ContextMap.Key<UserInfo> userInfoKey)	Creates a new BasicAuthSecurityContextFilters.UserInfoBuilder instance for building a ContainerRequestFilter that needs to be globally bound to the JAX-RS Application.
static BasicAuthSecurityContextFilters.NoUserInfoBuilder	forNameBinding()	Creates a new BasicAuthSecurityContextFilters.NoUserInfoBuilder instance for building a ContainerRequestFilter that needs to be explicitly bound to resources via the BasicAuthenticated annotation.
static <UserInfo> BasicAuthSecurityContextFilters.UserInfoBuilder<UserInfo>	forNameBinding(ContextMap.Key<UserInfo> userInfoKey)	Creates a new BasicAuthSecurityContextFilters.UserInfoBuilder instance for building a ContainerRequestFilter that needs to be explicitly bound to resources via the BasicAuthenticated annotation.

Methods inherited from class java.lang.Object

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

Method Details

forGlobalBinding

public static <UserInfo>
BasicAuthSecurityContextFilters.UserInfoBuilder<UserInfo> forGlobalBinding(ContextMap.Key<UserInfo> userInfoKey)

Creates a new BasicAuthSecurityContextFilters.UserInfoBuilder instance for building a ContainerRequestFilter that needs to be globally bound to the JAX-RS Application.

Type Parameters:

UserInfo - the type of user info object expected in AsyncContext's userInfoKey entry

Parameters:

userInfoKey - the ContextMap.Key to use to get the user info from AsyncContext

Returns:

a new BasicAuthSecurityContextFilters.UserInfoBuilder instance

forGlobalBinding

public static BasicAuthSecurityContextFilters.NoUserInfoBuilder forGlobalBinding()

Creates a new BasicAuthSecurityContextFilters.NoUserInfoBuilder instance for building a ContainerRequestFilter that needs to be globally bound to the JAX-RS Application.

Returns:

a new BasicAuthSecurityContextFilters.NoUserInfoBuilder instance

forNameBinding

public static <UserInfo>
BasicAuthSecurityContextFilters.UserInfoBuilder<UserInfo> forNameBinding(ContextMap.Key<UserInfo> userInfoKey)

Creates a new BasicAuthSecurityContextFilters.UserInfoBuilder instance for building a ContainerRequestFilter that needs to be explicitly bound to resources via the BasicAuthenticated annotation.

Type Parameters:

UserInfo - the type of user info object expected in AsyncContext's userInfoKey entry

Parameters:

userInfoKey - the ContextMap.Key to use to get the user info from AsyncContext

Returns:

a new BasicAuthSecurityContextFilters.UserInfoBuilder instance

forNameBinding

public static BasicAuthSecurityContextFilters.NoUserInfoBuilder forNameBinding()

Creates a new BasicAuthSecurityContextFilters.NoUserInfoBuilder instance for building a ContainerRequestFilter that needs to be explicitly bound to resources via the BasicAuthenticated annotation.

Returns:

a new BasicAuthSecurityContextFilters.NoUserInfoBuilder instance