Class HttpClientProperties
java.lang.Object
org.apereo.cas.configuration.model.core.authentication.HttpClientProperties
- All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-core-authentication",
automated=true)
public class HttpClientProperties
extends Object
implements Serializable
Configuration properties class for http.client.truststore.
- Since:
- 5.0.0
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionIndicates timeout for async operations.If specified the regular expression will be used to validate the url's authority.Connection timeout for all operations that reach out to URL endpoints.The default headers to use for any HTTP connection.Enable hostname verification when attempting to contact URL endpoints.Send requests via a proxy; define the hostname.int
Send requests via a proxy; define the proxy port.Determines the timeout until arrival of a response from the opposite endpoint.Determines the default socket timeout value for I/O operations.Configuration properties namespace for embedded Java SSL trust store.boolean
Whether CAS should accept local URLs.boolean
Whether the regular expression specified withauthorityValidationRegex
should be handled as case-sensitive (true
) or case-insensitive (false
).setAllowLocalUrls
(boolean allowLocalUrls) Whether CAS should accept local URLs.setAsyncTimeout
(String asyncTimeout) Indicates timeout for async operations.setAuthorityValidationRegex
(String authorityValidationRegex) If specified the regular expression will be used to validate the url's authority.setAuthorityValidationRegExCaseSensitive
(boolean authorityValidationRegExCaseSensitive) Whether the regular expression specified withauthorityValidationRegex
should be handled as case-sensitive (true
) or case-insensitive (false
).setConnectionTimeout
(String connectionTimeout) Connection timeout for all operations that reach out to URL endpoints.setDefaultHeaders
(Map<String, String> defaultHeaders) The default headers to use for any HTTP connection.setHostNameVerifier
(String hostNameVerifier) Enable hostname verification when attempting to contact URL endpoints.setProxyHost
(String proxyHost) Send requests via a proxy; define the hostname.setProxyPort
(int proxyPort) Send requests via a proxy; define the proxy port.setResponseTimeout
(String responseTimeout) Determines the timeout until arrival of a response from the opposite endpoint.setSocketTimeout
(String socketTimeout) Determines the default socket timeout value for I/O operations.setTruststore
(HttpClientTrustStoreProperties truststore) Configuration properties namespace for embedded Java SSL trust store.
-
Constructor Details
-
HttpClientProperties
public HttpClientProperties()
-
-
Method Details
-
getConnectionTimeout
Connection timeout for all operations that reach out to URL endpoints. -
getSocketTimeout
Determines the default socket timeout value for I/O operations. -
getResponseTimeout
Determines the timeout until arrival of a response from the opposite endpoint. A timeout value of zero is interpreted as an infinite timeout. Please note that response timeout may be unsupported by HTTP transports with message multiplexing. -
getAsyncTimeout
Indicates timeout for async operations. -
getHostNameVerifier
Enable hostname verification when attempting to contact URL endpoints. May also be set tonone
to disable verification. -
getTruststore
Configuration properties namespace for embedded Java SSL trust store. -
isAllowLocalUrls
public boolean isAllowLocalUrls()Whether CAS should accept local URLs. For examplehttp(s)://localhost/logout
. -
getAuthorityValidationRegex
If specified the regular expression will be used to validate the url's authority. -
getProxyHost
Send requests via a proxy; define the hostname. -
getProxyPort
public int getProxyPort()Send requests via a proxy; define the proxy port. Negative/zero values should deactivate the proxy configuration for the http client. -
isAuthorityValidationRegExCaseSensitive
public boolean isAuthorityValidationRegExCaseSensitive()Whether the regular expression specified withauthorityValidationRegex
should be handled as case-sensitive (true
) or case-insensitive (false
). If noauthorityValidationRegex
is set, this value does not have any effect. -
getDefaultHeaders
The default headers to use for any HTTP connection. This is defined as map, where the key is the header name and the value is the header value that should be sent along with request. -
setConnectionTimeout
Connection timeout for all operations that reach out to URL endpoints.- Returns:
this
.
-
setSocketTimeout
Determines the default socket timeout value for I/O operations.- Returns:
this
.
-
setResponseTimeout
Determines the timeout until arrival of a response from the opposite endpoint. A timeout value of zero is interpreted as an infinite timeout. Please note that response timeout may be unsupported by HTTP transports with message multiplexing.- Returns:
this
.
-
setAsyncTimeout
Indicates timeout for async operations.- Returns:
this
.
-
setHostNameVerifier
Enable hostname verification when attempting to contact URL endpoints. May also be set tonone
to disable verification.- Returns:
this
.
-
setTruststore
Configuration properties namespace for embedded Java SSL trust store.- Returns:
this
.
-
setAllowLocalUrls
Whether CAS should accept local URLs. For examplehttp(s)://localhost/logout
.- Returns:
this
.
-
setAuthorityValidationRegex
If specified the regular expression will be used to validate the url's authority.- Returns:
this
.
-
setProxyHost
Send requests via a proxy; define the hostname.- Returns:
this
.
-
setProxyPort
Send requests via a proxy; define the proxy port. Negative/zero values should deactivate the proxy configuration for the http client.- Returns:
this
.
-
setAuthorityValidationRegExCaseSensitive
public HttpClientProperties setAuthorityValidationRegExCaseSensitive(boolean authorityValidationRegExCaseSensitive) Whether the regular expression specified withauthorityValidationRegex
should be handled as case-sensitive (true
) or case-insensitive (false
). If noauthorityValidationRegex
is set, this value does not have any effect.- Returns:
this
.
-
setDefaultHeaders
The default headers to use for any HTTP connection. This is defined as map, where the key is the header name and the value is the header value that should be sent along with request.- Returns:
this
.
-