Package org.opensaml.security.httpclient
Interface HttpClientSecurityConfiguration
-
public interface HttpClientSecurityConfiguration
The security configuration information to use when performing HTTP client requests.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description X509Credential
getClientTLSCredential()
Get the optional client TLS credential.org.apache.http.client.CredentialsProvider
getCredentialsProvider()
Get an instance ofCredentialsProvider
used for authentication by the HttpClient instance.HostnameVerifier
getHostnameVerifier()
Get the optional hostname verifier.List<String>
getTLSCipherSuites()
Get the optional list of TLS cipher suites.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.Boolean
isServerTLSFailureFatal()
Get the flag indicating whether failure of server TLS trust engine evaluation should be treated as a fatal error.
-
-
-
Method Detail
-
getCredentialsProvider
@Nullable org.apache.http.client.CredentialsProvider getCredentialsProvider()
Get an instance ofCredentialsProvider
used for authentication by the HttpClient instance.- Returns:
- the credentials provider, or null
-
getTLSTrustEngine
@Nullable TrustEngine<? super X509Credential> getTLSTrustEngine()
Sets the optional trust engine used in evaluating server TLS credentials.- Returns:
- the trust engine instance to use, or null
-
getTLSProtocols
@Nullable List<String> getTLSProtocols()
Get the optional list of TLS protocols.- Returns:
- the TLS protocols, or null
-
getTLSCipherSuites
@Nullable List<String> getTLSCipherSuites()
Get the optional list of TLS cipher suites.- Returns:
- the list of TLS cipher suites, or null
-
getHostnameVerifier
@Nullable HostnameVerifier getHostnameVerifier()
Get the optional hostname verifier.- Returns:
- the hostname verifier, or null
-
getClientTLSCredential
@Nullable X509Credential getClientTLSCredential()
Get the optional client TLS credential.- Returns:
- the client TLS credential, or null
-
isServerTLSFailureFatal
@Nullable Boolean isServerTLSFailureFatal()
Get the flag indicating whether failure of server TLS trust engine evaluation should be treated as a fatal error.Note: a
Boolean
is used here rather thanboolean
to explicitly allow a non-configured value, allowing consuming components to implement their own internal defaults.- Returns:
- true if fatal, false if non-fatal, null if not explicitly configured
-
-