org.opensaml.security.httpclient

Class HttpClientSecurityParameters

java.lang.Object

org.opensaml.security.httpclient.HttpClientSecurityParameters

public class HttpClientSecurityParameters
extends Object

Parameters related to HttpClient request security features.

Field Summary

Fields

Modifier and Type	Field and Description
private X509Credential	clientTLSCredential The X509 credential used for client TLS.
private CredentialsProvider	credentialsProvider HttpClient credentials provider.
private X509HostnameVerifier	hostnameVerifier The hostname verifier.
private List<String>	tlsCipherSuites TLS cipher suites.
private net.shibboleth.utilities.java.support.resolver.CriteriaSet	tlsCriteriaSet Optional criteria set used in evaluating server TLS credentials.
private List<String>	tlsProtocols TLS Protocols.
private TrustEngine<? super X509Credential>	tlsTrustEngine Optional trust engine used in evaluating server TLS credentials.

Constructor Summary

Constructors

Constructor and Description
HttpClientSecurityParameters()

Method Summary

Methods

Modifier and Type	Method and Description
X509Credential	getClientTLSCredential() Get the optional client TLS credential.
CredentialsProvider	getCredentialsProvider() Get an instance of CredentialsProvider used for authentication by the HttpClient instance.
X509HostnameVerifier	getHostnameVerifier() Get the optional hostname verifier.
List<String>	getTLSCipherSuites() Get the optional list of TLS cipher suites.
net.shibboleth.utilities.java.support.resolver.CriteriaSet	getTLSCriteriaSet() Get the optional criteria set used in evaluating server TLS credentials.
List<String>	getTLSProtocols() Get the optional list of TLS protocols.
TrustEngine<? super X509Credential>	getTLSTrustEngine() Sets the optional trust engine used in evaluating server TLS credentials.
void	setBasicCredentials(UsernamePasswordCredentials credentials) A convenience method to set a (single) username and password used for BASIC authentication.
void	setBasicCredentialsWithScope(UsernamePasswordCredentials credentials, AuthScope scope) A convenience method to set a (single) username and password used for BASIC authentication.
void	setClientTLSCredential(X509Credential credential) Set the optional client TLS credential.
void	setCredentialsProvider(CredentialsProvider provider) Set an instance of CredentialsProvider used for authentication by the HttpClient instance.
void	setHostnameVerifier(X509HostnameVerifier verifier) Set the optional hostname verifier.
void	setTLSCipherSuites(List<String> cipherSuites) Set the optional list of TLS cipher suites.
void	setTLSCriteriaSet(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet) Set the optional criteria set used in evaluating server TLS credentials.
void	setTLSProtocols(List<String> protocols) Set the optional list of TLS protocols.
void	setTLSTrustEngine(TrustEngine<? super X509Credential> engine) Sets the optional trust engine used in evaluating server TLS credentials.

Methods inherited from class java.lang.Object

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

Field Detail

credentialsProvider

private CredentialsProvider credentialsProvider

HttpClient credentials provider.

tlsTrustEngine

private TrustEngine<? super X509Credential> tlsTrustEngine

Optional trust engine used in evaluating server TLS credentials.

tlsCriteriaSet

private net.shibboleth.utilities.java.support.resolver.CriteriaSet tlsCriteriaSet

Optional criteria set used in evaluating server TLS credentials.

tlsProtocols

private List<String> tlsProtocols

TLS Protocols.

tlsCipherSuites

private List<String> tlsCipherSuites

TLS cipher suites.

hostnameVerifier

private X509HostnameVerifier hostnameVerifier

The hostname verifier.

clientTLSCredential

private X509Credential clientTLSCredential

The X509 credential used for client TLS.

Constructor Detail

HttpClientSecurityParameters

public HttpClientSecurityParameters()

Method Detail

getCredentialsProvider

@Nullable
public CredentialsProvider getCredentialsProvider()

Get an instance of CredentialsProvider used for authentication by the HttpClient instance.

Returns:

the credentials provider, or null

setCredentialsProvider

public void setCredentialsProvider(@Nullable
                          CredentialsProvider provider)

Set an instance of CredentialsProvider used for authentication by the HttpClient instance.

Parameters:

provider - the credentials provider

setBasicCredentials

public void setBasicCredentials(@Nullable
                       UsernamePasswordCredentials credentials)

A convenience method to set a (single) username and password used for BASIC authentication. To disable BASIC authentication pass null for the credentials instance.

An AuthScope will be generated which specifies any host, port, scheme and realm.

To specify multiple usernames and passwords for multiple host, port, scheme, and realm combinations, instead provide an instance of CredentialsProvider via setCredentialsProvider(CredentialsProvider).

Parameters:

credentials - the username and password credentials

setBasicCredentialsWithScope

public void setBasicCredentialsWithScope(@Nullable
                                UsernamePasswordCredentials credentials,
                                @Nullable
                                AuthScope scope)

A convenience method to set a (single) username and password used for BASIC authentication. To disable BASIC authentication pass null for the credentials instance.

If the authScope is null, an AuthScope will be generated which specifies any host, port, scheme and realm.

To specify multiple usernames and passwords for multiple host, port, scheme, and realm combinations, instead provide an instance of CredentialsProvider via setCredentialsProvider(CredentialsProvider).

Parameters:

credentials - the username and password credentials

scope - the HTTP client auth scope with which to scope the credentials, may be null

getTLSTrustEngine

@Nullable
public TrustEngine<? super X509Credential> getTLSTrustEngine()

Sets the optional trust engine used in evaluating server TLS credentials.

Returns:

the trust engine instance to use, or null

setTLSTrustEngine

public void setTLSTrustEngine(@Nullable
                     TrustEngine<? super X509Credential> engine)

Sets the optional trust engine used in evaluating server TLS credentials.

Parameters:

engine - the trust engine instance to use

getTLSCriteriaSet

@Nullable
public net.shibboleth.utilities.java.support.resolver.CriteriaSet getTLSCriteriaSet()

Get the optional criteria set used in evaluating server TLS credentials.

Returns:

the criteria set instance to use

setTLSCriteriaSet

public void setTLSCriteriaSet(@Nullable
                     net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet)

Set the optional criteria set used in evaluating server TLS credentials.

Parameters:

criteriaSet - the new criteria set instance to use

getTLSProtocols

@Nullable
public List<String> getTLSProtocols()

Get the optional list of TLS protocols.

Returns:

the TLS protocols, or null

setTLSProtocols

public void setTLSProtocols(@Nullable
                   List<String> protocols)

Set the optional list of TLS protocols.

Parameters:

protocols - the TLS protocols or null

getTLSCipherSuites

@Nullable
public List<String> getTLSCipherSuites()

Get the optional list of TLS cipher suites.

Returns:

the list of TLS cipher suites, or null

setTLSCipherSuites

public void setTLSCipherSuites(@Nullable
                      List<String> cipherSuites)

Set the optional list of TLS cipher suites.

Parameters:

cipherSuites - the TLS cipher suites, or null

getHostnameVerifier

@Nullable
public X509HostnameVerifier getHostnameVerifier()

Get the optional hostname verifier.

Returns:

the hostname verifier, or null

setHostnameVerifier

public void setHostnameVerifier(@Nullable
                       X509HostnameVerifier verifier)

Set the optional hostname verifier.

Parameters:

verifier - the hostname verifier, or null

getClientTLSCredential

@Nullable
public X509Credential getClientTLSCredential()

Get the optional client TLS credential.

Returns:

the client TLS credential, or null

setClientTLSCredential

public void setClientTLSCredential(@Nullable
                          X509Credential credential)

Set the optional client TLS credential.

Parameters:

credential - the client TLS credential, or null