BasicAuthHttpServiceFilter

java.lang.Object

io.servicetalk.http.utils.auth.BasicAuthHttpServiceFilter<UserInfo>

Type Parameters:: UserInfo - a type for authenticated user info object

All Implemented Interfaces:: HttpExecutionStrategyInfluencer, StreamingHttpServiceFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class BasicAuthHttpServiceFilter<UserInfo> extends Object implements StreamingHttpServiceFilterFactory

A StreamingHttpServiceFilter, which filters HTTP requests using RFC7617: The 'Basic' HTTP Authentication Scheme.

See Also:

BasicAuthHttpServiceFilter.Builder

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static final class

BasicAuthHttpServiceFilter.Builder<UserInfo>

A builder for an StreamingHttpServiceFilter, which filters HTTP requests using RFC7617: The 'Basic' HTTP Authentication Scheme.

static interface

BasicAuthHttpServiceFilter.CredentialsVerifier<UserInfo>

Verifies user-id and password, parsed from the 'Basic' HTTP Authentication Scheme credentials.
Method Summary

Modifier and Type

Method

Description

StreamingHttpServiceFilter

create(StreamingHttpService service)

Create a StreamingHttpServiceFilter using the provided StreamingHttpService.

HttpExecutionStrategy

requiredOffloads()

Return an ExecutionStrategy that describes the offloads required by the influencer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.servicetalk.http.api.HttpExecutionStrategyInfluencer
influenceStrategy

Method Details
- create
  
  public StreamingHttpServiceFilter create(StreamingHttpService service)
  
  Description copied from interface: StreamingHttpServiceFilterFactory
  
  Create a StreamingHttpServiceFilter using the provided StreamingHttpService.
  
  Specified by:
  
  create in interface StreamingHttpServiceFilterFactory
  
  Parameters:
  
  service - StreamingHttpService to filter
  
  Returns:
  
  StreamingHttpServiceFilter using the provided StreamingHttpService.
- requiredOffloads
  
  public HttpExecutionStrategy requiredOffloads()
  
  Description copied from interface: HttpExecutionStrategyInfluencer
  
  Return an ExecutionStrategy that describes the offloads required by the influencer.
  The provided default implementation requests offloading of all operations. Implementations that require no offloading should be careful to return HttpExecutionStrategies.offloadNone() rather than HttpExecutionStrategies.offloadNever(). Implementations should avoid returning HttpExecutionStrategies.defaultStrategy(), instead returning the strategy they require or HttpExecutionStrategies.offloadAll() if offloading for all paths is required (safe default).
  
  Specified by:
  
  requiredOffloads in interface ExecutionStrategyInfluencer<UserInfo>
  
  Specified by:
  
  requiredOffloads in interface HttpExecutionStrategyInfluencer
  
  Returns:
  
  the ExecutionStrategy required by the influencer.