Package org.eclipse.jetty.client.api

Interface AuthenticationStore

All Known Implementing Classes:

HttpAuthenticationStore

public interface AuthenticationStore

A store for Authentications and Authentication.Results.

Method Summary

Modifier and Type	Method	Description
void	addAuthentication(Authentication authentication)
void	addAuthenticationResult(Authentication.Result result)
void	clearAuthenticationResults()	Removes all authentication results stored
void	clearAuthentications()	Removes all Authentications stored
Authentication	findAuthentication(java.lang.String type, java.net.URI uri, java.lang.String realm)	Returns the authentication that matches the given type (for example, "Basic" or "Digest"), the given request URI and the given realm.
Authentication.Result	findAuthenticationResult(java.net.URI uri)	Returns an Authentication.Result that matches the given URI, or null if no Authentication.Results match the given URI.
default boolean	hasAuthenticationResults()
void	removeAuthentication(Authentication authentication)
void	removeAuthenticationResult(Authentication.Result result)

Method Detail

addAuthentication

void addAuthentication(Authentication authentication)

Parameters:

authentication - the Authentication to add

removeAuthentication

void removeAuthentication(Authentication authentication)

Parameters:

authentication - the Authentication to remove

clearAuthentications

void clearAuthentications()

Removes all Authentications stored

findAuthentication

Authentication findAuthentication(java.lang.String type,
                                  java.net.URI uri,
                                  java.lang.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 - the Authentication type such as "Basic" or "Digest"

uri - the request URI

realm - the authentication realm

Returns:

the authentication that matches the given parameters, or null

addAuthenticationResult

void addAuthenticationResult(Authentication.Result result)

Parameters:

result - the Authentication.Result to add

removeAuthenticationResult

void removeAuthenticationResult(Authentication.Result result)

Parameters:

result - the Authentication.Result to remove

clearAuthenticationResults

void clearAuthenticationResults()

Removes all authentication results stored

findAuthenticationResult

Authentication.Result findAuthenticationResult(java.net.URI uri)

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

Parameters:

uri - the request URI

Returns:

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

hasAuthenticationResults

default boolean hasAuthenticationResults()

Returns:

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