Interface SupportsPatch

All Known Implementing Classes:
HttpServletBase

public interface SupportsPatch
Optional interface indicating that a servlet supports the HTTP PATCH method.
Author:
cdivilly
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    doPatch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Perform a HTTP PATCH operation.
  • Field Details

  • Method Details

    • doPatch

      void doPatch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws javax.servlet.ServletException, IOException
      Perform a HTTP PATCH operation. The PATCH method requests that a set of changes described in the request entity be applied to the resource identified by the Request-URI. The set of changes is represented in a format called a "patch document" identified by a media type. The server MUST apply the entire set of changes atomically and never provide (e.g., in response to a GET during this operation) a partially modified representation. If the entire patch document cannot be successfully applied, then the server MUST NOT apply any of the changes.
      Parameters:
      request - an HttpServletRequest object that contains the request the client has made of the servlet
      response - an HttpServletResponse object that contains the response the servlet sends to the client
      Throws:
      IOException - if an input or output error is detected when the servlet handles the PATCH request
      javax.servlet.ServletException - if the request for the PATCH could not be handled