Package org.asynchttpclient

Class Realm.Builder

java.lang.Object

org.asynchttpclient.Realm.Builder

Enclosing class:

Realm

public static class Realm.Builder
extends Object

A builder for Realm

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(@Nullable String principal, @Nullable String password)

Method Summary

Modifier and Type	Method	Description
Realm	build()	Build a Realm
@Nullable String	getNonceValue()
@Nullable String	getQopValue()
boolean	isStale()
static @Nullable String	matchParam(String headerLine, String token)	Extracts the value of a token from a WWW-Authenticate or Proxy-Authenticate header line.
Realm.Builder	parseProxyAuthenticateHeader(String headerLine)
Realm.Builder	parseWWWAuthenticateHeader(String headerLine)
Realm.Builder	setAlgorithm(@Nullable String algorithm)
Realm.Builder	setCharset(Charset charset)
Realm.Builder	setCustomLoginConfig(@Nullable Map<String,String> customLoginConfig)
Realm.Builder	setEntityBodyHash(@Nullable String entityBodyHash)
Realm.Builder	setLoginContextName(@Nullable String loginContextName)
Realm.Builder	setMaxIterationCount(int maxIterationCount)
Realm.Builder	setMethodName(String methodName)
Realm.Builder	setNc(String nc)
Realm.Builder	setNonce(@Nullable String nonce)
Realm.Builder	setNtlmDomain(String ntlmDomain)
Realm.Builder	setNtlmHost(String host)
Realm.Builder	setOmitQuery(boolean omitQuery)
Realm.Builder	setOpaque(@Nullable String opaque)
Realm.Builder	setQop(@Nullable String qop)
Realm.Builder	setRealmName(@Nullable String realmName)
Realm.Builder	setResponse(String response)
Realm.Builder	setScheme(Realm.AuthScheme scheme)
Realm.Builder	setServicePrincipalName(@Nullable String servicePrincipalName)
Realm.Builder	setSid(@Nullable String sid)
Realm.Builder	setStale(boolean stale)
Realm.Builder	setUri(@Nullable Uri uri)
Realm.Builder	setUseAbsoluteURI(boolean useAbsoluteURI)
Realm.Builder	setUseCanonicalHostname(boolean useCanonicalHostname)
Realm.Builder	setUsePreemptiveAuth(boolean usePreemptiveAuth)
Realm.Builder	setUserhash(boolean userhash)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(@Nullable
               @Nullable String principal,
               @Nullable
               @Nullable String password)

Method Detail

setNtlmDomain

public Realm.Builder setNtlmDomain(String ntlmDomain)

setNtlmHost

public Realm.Builder setNtlmHost(String host)

setScheme

public Realm.Builder setScheme(Realm.AuthScheme scheme)

setRealmName

public Realm.Builder setRealmName(@Nullable
                                  @Nullable String realmName)

setNonce

public Realm.Builder setNonce(@Nullable
                              @Nullable String nonce)

setAlgorithm

public Realm.Builder setAlgorithm(@Nullable
                                  @Nullable String algorithm)

setResponse

public Realm.Builder setResponse(String response)

setOpaque

public Realm.Builder setOpaque(@Nullable
                               @Nullable String opaque)

setQop

public Realm.Builder setQop(@Nullable
                            @Nullable String qop)

setNc

public Realm.Builder setNc(String nc)

setUri

public Realm.Builder setUri(@Nullable
                            @Nullable Uri uri)

setMethodName

public Realm.Builder setMethodName(String methodName)

setUsePreemptiveAuth

public Realm.Builder setUsePreemptiveAuth(boolean usePreemptiveAuth)

setUseAbsoluteURI

public Realm.Builder setUseAbsoluteURI(boolean useAbsoluteURI)

setOmitQuery

public Realm.Builder setOmitQuery(boolean omitQuery)

setCharset

public Realm.Builder setCharset(Charset charset)

setCustomLoginConfig

public Realm.Builder setCustomLoginConfig(@Nullable
                                          @Nullable Map<String,String> customLoginConfig)

setServicePrincipalName

public Realm.Builder setServicePrincipalName(@Nullable
                                             @Nullable String servicePrincipalName)

setUseCanonicalHostname

public Realm.Builder setUseCanonicalHostname(boolean useCanonicalHostname)

setLoginContextName

public Realm.Builder setLoginContextName(@Nullable
                                         @Nullable String loginContextName)

setStale

public Realm.Builder setStale(boolean stale)

isStale

public boolean isStale()

setUserhash

public Realm.Builder setUserhash(boolean userhash)

setEntityBodyHash

public Realm.Builder setEntityBodyHash(@Nullable
                                       @Nullable String entityBodyHash)

setSid

public Realm.Builder setSid(@Nullable
                            @Nullable String sid)

setMaxIterationCount

public Realm.Builder setMaxIterationCount(int maxIterationCount)

getQopValue

@Nullable
public @Nullable String getQopValue()

getNonceValue

@Nullable
public @Nullable String getNonceValue()

parseWWWAuthenticateHeader

public Realm.Builder parseWWWAuthenticateHeader(String headerLine)

parseProxyAuthenticateHeader

public Realm.Builder parseProxyAuthenticateHeader(String headerLine)

matchParam

@Nullable
public static @Nullable String matchParam(String headerLine,
                                          String token)

Extracts the value of a token from a WWW-Authenticate or Proxy-Authenticate header line. Handles both quoted values (token="value") and unquoted values (token=value). Example: matchParam('Digest realm="test", algorithm=SHA-256', "realm") returns "test" Example: matchParam('Digest algorithm=SHA-256', "algorithm") returns "SHA-256"

build

public Realm build()

Build a Realm

Returns:

a Realm