Top Description Methods
org.eclipse.jetty.client

public Interface AuthenticationStore

Known Direct Implementers
org.eclipse.jetty.client.internal.HttpAuthenticationStore
Imports
java.net.URI

A store for Authentications and Authentication.Results.

Method Summary

Modifier and TypeMethod and Description
public void
addAuthentication(Authentication
the Authentication to add
authentication
)

Add the Authentication to add.

public void
public void
clearAuthenticationResults()

Removes all authentication results stored

public void
clearAuthentications()

Removes all Authentications stored

public Authentication

Returns:

the authentication that matches the given parameters, or null
findAuthentication
(String
the Authentication type such as "Basic" or "Digest"
type
,
URI
the request URI
uri
,
String
the authentication realm
realm
)

Returns the authentication that matches the given type (for example, "Basic" or "Digest"), the given request URI and the given realm.

public Authentication.Result

Returns:

the Authentication.Result that matches the given URI, or null
findAuthenticationResult
(URI
the request URI
uri
)

Returns an Authentication.Result that matches the given URI, or null if no Authentication.Results match the given URI.

public default boolean
hasAuthenticationResults()

Returns: false if there are no stored authentication results, true if there may be some.

public void
removeAuthentication(Authentication
the Authentication to remove
authentication
)

Remove an Authentication.

public void
removeAuthenticationResult(Authentication.Result
the Authentication.Result to remove
result
)

Remove and Authentication Result

Method Detail

addAuthenticationback to summary
public void addAuthentication(Authentication authentication)

Add the Authentication to add.

Parameters
authentication:Authentication

the Authentication to add

addAuthenticationResultback to summary
public void addAuthenticationResult(Authentication.Result result)

Add the Authentication.Result to add.

Parameters
result:Authentication.Result

the Authentication.Result to add

clearAuthenticationResultsback to summary
public void clearAuthenticationResults()

Removes all authentication results stored

clearAuthenticationsback to summary
public void clearAuthentications()

Removes all Authentications stored

findAuthenticationback to summary
public Authentication findAuthentication(String type, URI uri, String realm)

Returns the authentication that matches the given type (for example, "Basic" or "Digest"), the given request URI and the given realm. If no such authentication can be found, returns null.

Parameters
type:String

the Authentication type such as "Basic" or "Digest"

uri:URI

the request URI

realm:String

the authentication realm

Returns:Authentication

the authentication that matches the given parameters, or null

findAuthenticationResultback to summary
public Authentication.Result findAuthenticationResult(URI uri)

Returns an Authentication.Result that matches the given URI, or null if no Authentication.Results match the given URI.

Parameters
uri:URI

the request URI

Returns:Authentication.Result

the Authentication.Result that matches the given URI, or null

hasAuthenticationResultsback to summary
public default boolean hasAuthenticationResults()
Returns:boolean

false if there are no stored authentication results, true if there may be some.

removeAuthenticationback to summary
public void removeAuthentication(Authentication authentication)

Remove an Authentication.

Parameters
authentication:Authentication

the Authentication to remove

removeAuthenticationResultback to summary
public void removeAuthenticationResult(Authentication.Result result)

Remove and Authentication Result

Parameters
result:Authentication.Result

the Authentication.Result to remove