Package com.sap.cds.services.request

Interface ParameterInfo

All Known Subinterfaces:
ModifiableParameterInfo
public interface ParameterInfo
Interface to access request-specific information. For example, if the request is processed by a HTTP-based protocol adapter these methods provide access to the HTTP request.

  • Method Details

    • create

      static ModifiableParameterInfo create()
      Creates a ModifiableUserInfo based on default values of a clear ParameterInfo.
      Returns:
      The created ModifiableUserInfo instance.

    • getCorrelationId

      default String getCorrelationId()
      Returns:
      the correlation id

    • getHeader

      default String getHeader(String id)
      Returns the value of a header with the given identifier. In case the header with id has several values, the result contains the values comma-separated.
      Parameters:
      id - the header identifier
      Returns:
      the value of the header

    • getHeaders

      default Map<String,String> getHeaders()
      Returns the header values as Map. Note that this might be an expensive operation.
      Returns:
      the header values as Map.

    • getQueryParameter

      default String getQueryParameter(String key)
      Returns the value of a query parameter with the given key
      Parameters:
      key - the query parameter key
      Returns:
      the value of the query parameter

    • getQueryParams

      default Map<String,String> getQueryParams()
      Returns the query parameter values as Map. Note that this might be an expensive operation.
      Returns:
      the query parameter values as Map.

    • getLocale

      default Locale getLocale()
      Returns:
      the preferred Locale set by the request

    • getValidFrom

      default Instant getValidFrom()
      Returns:
      parsed Instant value of request parameter "valid-from" or constructed from Long.MIN_VALUE if not available or parsing failed.

    • getValidTo

      default Instant getValidTo()
      Returns:
      parsed Instant value of request parameter "valid-to" or constructed from Long.MAX_VALUE if not available or parsing failed.

    • copy

      default ModifiableParameterInfo copy()
      Creates a ModifiableParameterInfo based on this ParameterInfo.
      Returns:
      The created ModifiableParameterInfo instance.