Interface Response

All Known Subinterfaces:
ActionResponse, QueryResponse, ResourceResponse
All Known Implementing Classes:
BadRequestException, ConflictException, CreateNotSupportedException, ForbiddenException, InternalServerErrorException, NotFoundException, NotSupportedException, PermanentException, PreconditionFailedException, PreconditionRequiredException, ResourceException, RetryableException, ServiceUnavailableException, UncategorizedException, UnsupportedMediaTypeException
public interface Response
Common response object of all resource responses.

  • Method Summary

    Modifier and Type
    Method
    Description
    default ResponseCacheControl
    getCacheControl()
    Indicates how the response should be cached by clients.
    org.forgerock.http.routing.Version
    getResourceApiVersion()
    Gets the API version of the resource that the request was routed to.
    void
    setResourceApiVersion(org.forgerock.http.routing.Version version)
    Sets the API version of the resource that the request was routed to.

  • Method Details

    • setResourceApiVersion

      void setResourceApiVersion(org.forgerock.http.routing.Version version)
      Sets the API version of the resource that the request was routed to.
      Parameters:
      version - The resource API version.

    • getResourceApiVersion

      org.forgerock.http.routing.Version getResourceApiVersion()
      Gets the API version of the resource that the request was routed to.
      Returns:
      The resource API version.

    • getCacheControl

      default ResponseCacheControl getCacheControl()
      Indicates how the response should be cached by clients.
      Returns:
      the cache controls to apply to the response.