Package org.apereo.cas.configuration.model.core.web.security

Class HttpRequestProperties

java.lang.Object
org.apereo.cas.configuration.model.core.web.security.HttpRequestProperties
All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-core-web", automated=true) public class HttpRequestProperties extends Object implements Serializable
This is HttpRequestProperties.
Since:
5.0.0
See Also:

  • Constructor Details

    • HttpRequestProperties

      public HttpRequestProperties()

  • Method Details

    • isAllowMultiValueParameters

      public boolean isAllowMultiValueParameters()
      Whether CAS should accept multi-valued parameters in incoming requests. Example block would to prevent requests where more than one service parameter is specified.

    • getOnlyPostParams

      public String getOnlyPostParams()
      Parameters that are only allowed and accepted during posts.

    • getParamsToCheck

      public String getParamsToCheck()
      Parameters to sanitize and cross-check in incoming requests. Separate parameter names by a comma. The special value * instructs the Filter to check all parameters.

    • getCharactersToForbid

      public String getCharactersToForbid()
      Characters to block in incoming requests. none is a special value. Separate characters by a space.

    • getPatternToBlock

      public String getPatternToBlock()
      Specify a regular expression that would be checked against the request URL. If a successful match is found, the request would be blocked.

    • getCustomHeaders

      public Map<String,String> getCustomHeaders()
      Custom response headers to inject into the response as needed.

    • getWeb

      public HttpWebRequestProperties getWeb()
      Control http request settings.

    • getHeader

      public HttpHeadersRequestProperties getHeader()
      Enforce request header options and security settings.

    • getCors

      public HttpCorsRequestProperties getCors()
      Control CORS settings for requests.

    • setAllowMultiValueParameters

      public HttpRequestProperties setAllowMultiValueParameters(boolean allowMultiValueParameters)
      Whether CAS should accept multi-valued parameters in incoming requests. Example block would to prevent requests where more than one service parameter is specified.
      Returns:
      this.

    • setOnlyPostParams

      public HttpRequestProperties setOnlyPostParams(String onlyPostParams)
      Parameters that are only allowed and accepted during posts.
      Returns:
      this.

    • setParamsToCheck

      public HttpRequestProperties setParamsToCheck(String paramsToCheck)
      Parameters to sanitize and cross-check in incoming requests. Separate parameter names by a comma. The special value * instructs the Filter to check all parameters.
      Returns:
      this.

    • setCharactersToForbid

      public HttpRequestProperties setCharactersToForbid(String charactersToForbid)
      Characters to block in incoming requests. none is a special value. Separate characters by a space.
      Returns:
      this.

    • setPatternToBlock

      public HttpRequestProperties setPatternToBlock(String patternToBlock)
      Specify a regular expression that would be checked against the request URL. If a successful match is found, the request would be blocked.
      Returns:
      this.

    • setCustomHeaders

      public HttpRequestProperties setCustomHeaders(Map<String,String> customHeaders)
      Custom response headers to inject into the response as needed.
      Returns:
      this.

    • setWeb

      public HttpRequestProperties setWeb(HttpWebRequestProperties web)
      Control http request settings.
      Returns:
      this.

    • setHeader

      public HttpRequestProperties setHeader(HttpHeadersRequestProperties header)
      Enforce request header options and security settings.
      Returns:
      this.

    • setCors

      public HttpRequestProperties setCors(HttpCorsRequestProperties cors)
      Control CORS settings for requests.
      Returns:
      this.