Package org.apereo.cas.configuration.model.core.authentication

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 Details

    • HttpClientProperties

      public HttpClientProperties()

  • Method Details

    • getConnectionTimeout

      public String getConnectionTimeout()
      Connection timeout for all operations that reach out to URL endpoints.

    • getSocketTimeout

      public String getSocketTimeout()
      Determines the default socket timeout value for I/O operations.

    • getResponseTimeout

      public String 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

      public String getAsyncTimeout()
      Indicates timeout for async operations.

    • getHostNameVerifier

      public String getHostNameVerifier()
      Enable hostname verification when attempting to contact URL endpoints. May also be set to none to disable verification.

    • getTruststore

      public HttpClientTrustStoreProperties getTruststore()
      Configuration properties namespace for embedded Java SSL trust store.

    • isAllowLocalUrls

      public boolean isAllowLocalUrls()
      Whether CAS should accept local URLs. For example http(s)://localhost/logout.

    • getAuthorityValidationRegex

      public String getAuthorityValidationRegex()
      If specified the regular expression will be used to validate the url's authority.

    • getProxyHost

      public String 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 with authorityValidationRegex should be handled as case-sensitive (true) or case-insensitive (false). If no authorityValidationRegex is set, this value does not have any effect.

    • getDefaultHeaders

      public Map<String,String> 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

      public HttpClientProperties setConnectionTimeout(String connectionTimeout)
      Connection timeout for all operations that reach out to URL endpoints.
      Returns:
      this.

    • setSocketTimeout

      public HttpClientProperties setSocketTimeout(String socketTimeout)
      Determines the default socket timeout value for I/O operations.
      Returns:
      this.

    • setResponseTimeout

      public HttpClientProperties setResponseTimeout(String responseTimeout)
      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

      public HttpClientProperties setAsyncTimeout(String asyncTimeout)
      Indicates timeout for async operations.
      Returns:
      this.

    • setHostNameVerifier

      public HttpClientProperties setHostNameVerifier(String hostNameVerifier)
      Enable hostname verification when attempting to contact URL endpoints. May also be set to none to disable verification.
      Returns:
      this.

    • setTruststore

      public HttpClientProperties setTruststore(HttpClientTrustStoreProperties truststore)
      Configuration properties namespace for embedded Java SSL trust store.
      Returns:
      this.

    • setAllowLocalUrls

      public HttpClientProperties setAllowLocalUrls(boolean allowLocalUrls)
      Whether CAS should accept local URLs. For example http(s)://localhost/logout.
      Returns:
      this.

    • setAuthorityValidationRegex

      public HttpClientProperties setAuthorityValidationRegex(String authorityValidationRegex)
      If specified the regular expression will be used to validate the url's authority.
      Returns:
      this.

    • setProxyHost

      public HttpClientProperties setProxyHost(String proxyHost)
      Send requests via a proxy; define the hostname.
      Returns:
      this.

    • setProxyPort

      public HttpClientProperties setProxyPort(int proxyPort)
      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 with authorityValidationRegex should be handled as case-sensitive (true) or case-insensitive (false). If no authorityValidationRegex is set, this value does not have any effect.
      Returns:
      this.

    • setDefaultHeaders

      public HttpClientProperties setDefaultHeaders(Map<String,String> defaultHeaders)
      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.