Package jakarta.faces.context

Class PartialResponseWriter

java.lang.Object
java.io.Writer
jakarta.faces.context.ResponseWriter
jakarta.faces.context.ResponseWriterWrapper
jakarta.faces.context.PartialResponseWriter
All Implemented Interfaces:
FacesWrapper<ResponseWriter>, Closeable, Flushable, Appendable, AutoCloseable
public class PartialResponseWriter extends ResponseWriterWrapper

PartialResponseWriter decorates an existing ResponseWriter to support the generation of a partial response suitable for Ajax operations. In addition to the markup generation methods inherited from jakarta.faces.context.ResponseWriter, this class provides methods for constructing the standard partial response elements.

Since:
2.0

  • Field Details

    • RENDER_ALL_MARKER

      public static final String RENDER_ALL_MARKER

      Reserved ID value to indicate entire ViewRoot.

      Since:
      2.0
      See Also:

    • VIEW_STATE_MARKER

      public static final String VIEW_STATE_MARKER

      Reserved ID value to indicate serialized ViewState.

      Since:
      2.0
      See Also:

  • Constructor Details

    • PartialResponseWriter

      public PartialResponseWriter(ResponseWriter writer)

      Create a PartialResponseWriter.

      Parameters:
      writer - The writer to wrap.
      Since:
      2.0

  • Method Details

    • startDocument

      public void startDocument() throws IOException

      Write the start of a partial response.

      If UIViewRoot is an instance of NamingContainer, then write UIComponent.getContainerClientId(FacesContext) as value of the id attribute of the root element.

      Overrides:
      startDocument in class ResponseWriterWrapper
      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0
      See Also:

    • endDocument

      public void endDocument() throws IOException

      Write the end of a partial response.

      Overrides:
      endDocument in class ResponseWriterWrapper
      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0
      See Also:

    • startInsertBefore

      public void startInsertBefore(String targetId) throws IOException

      Write the start of an insert operation where the contents will be inserted before the specified target node.

      Parameters:
      targetId - ID of the node insertion should occur before
      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • startInsertAfter

      public void startInsertAfter(String targetId) throws IOException

      Write the start of an insert operation where the contents will be inserted after the specified target node.

      Parameters:
      targetId - ID of the node insertion should occur after
      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • endInsert

      public void endInsert() throws IOException

      Write the end of an insert operation.

      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • startUpdate

      public void startUpdate(String targetId) throws IOException

      Write the start of an update operation.

      Parameters:
      targetId - ID of the node to be updated
      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • endUpdate

      public void endUpdate() throws IOException

      Write the end of an update operation.

      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • updateAttributes

      public void updateAttributes(String targetId, Map<String,String> attributes) throws IOException

      Write an attribute update operation.

      Parameters:
      targetId - ID of the node to be updated
      attributes - Map of attribute name/value pairs to be updated
      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • delete

      public void delete(String targetId) throws IOException

      Write a delete operation.

      Parameters:
      targetId - ID of the node to be deleted
      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • redirect

      public void redirect(String url) throws IOException

      Write a redirect operation.

      Parameters:
      url - URL to redirect to
      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • startEval

      public void startEval() throws IOException

      Write the start of an eval operation.

      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • endEval

      public void endEval() throws IOException

      Write the end of an eval operation.

      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • startExtension

      public void startExtension(Map<String,String> attributes) throws IOException

      Write the start of an extension operation.

      Parameters:
      attributes - String name/value pairs for extension element attributes
      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • endExtension

      public void endExtension() throws IOException

      Write the end of an extension operation.

      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • startError

      public void startError(String errorName) throws IOException

      Write the start of an error.

      Parameters:
      errorName - Descriptive string for the error
      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0

    • endError

      public void endError() throws IOException

      Write the end of an error.

      Throws:
      IOException - if an input/output error occurs
      Since:
      2.0