javax.faces.context.PartialResponseWriter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-jsf-api_2.0_spec
Show all versions of jboss-jsf-api_2.0_spec
JavaServer(tm) Faces API Classes
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.context;
import java.io.IOException;
import java.util.Map;
/**
* 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
* javax.faces.context.ResponseWriter, this class provides
* methods for constructing the standard partial response elements.
*
* @since 2.0
*/
public class PartialResponseWriter extends ResponseWriterWrapper {
// True when we need to close a start tag
//
private boolean inChanges = false;
// True when we need to close a before insert tag
//
private boolean inInsertBefore = false;
// True when we need to close afer insert tag
//
private boolean inInsertAfter = false;
ResponseWriter writer;
/**
* Reserved ID value to indicate
* entire ViewRoot.
*
* @since 2.0
*/
public static final String RENDER_ALL_MARKER = "javax.faces.ViewRoot";
/**
* Reserved ID value to indicate
* serialized ViewState.
*
* @since 2.0
*/
public static final String VIEW_STATE_MARKER = "javax.faces.ViewState";
/**
* Create a PartialResponseWriter.
*
* @param writer The writer to wrap.
* @since 2.0
*/
public PartialResponseWriter(ResponseWriter writer) {
this.writer = writer;
}
/**
* Return the wrapped
* {@link ResponseWriter} instance.
*
* @see ResponseWriterWrapper#getWrapped()
* @since 2.0
*/
public ResponseWriter getWrapped() {
return writer;
}
/**
* Write the start of a partial response.
*
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void startDocument() throws IOException {
ResponseWriter writer = getWrapped();
String encoding = writer.getCharacterEncoding( );
if( encoding == null ) {
encoding = "utf-8";
}
writer.write("\n");
writer.startElement("partial-response", null);
}
/**
* Write the end of a partial response.
*
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void endDocument() throws IOException {
endChangesIfNecessary();
ResponseWriter writer = getWrapped();
writer.endElement("partial-response");
}
/**
* Write the start of an insert operation
* where the contents will be inserted before the specified target node.
*
* @param targetId ID of the node insertion should occur before
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void startInsertBefore(String targetId)
throws IOException {
startChangesIfNecessary();
inInsertBefore = true;
ResponseWriter writer = getWrapped();
writer.startElement("insert", null);
writer.startElement("before", null);
writer.writeAttribute("id", targetId, null);
writer.startCDATA();
}
/**
* Write the start of an insert operation
* where the contents will be inserted after the specified target node.
*
* @param targetId ID of the node insertion should occur after
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void startInsertAfter(String targetId)
throws IOException {
startChangesIfNecessary();
inInsertAfter = true;
ResponseWriter writer = getWrapped();
writer.startElement("insert", null);
writer.startElement("after", null);
writer.writeAttribute("id", targetId, null);
writer.startCDATA();
}
/**
* Write the end of an insert operation.
*
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void endInsert() throws IOException {
ResponseWriter writer = getWrapped();
writer.endCDATA();
if (inInsertBefore) {
writer.endElement("before");
inInsertBefore = false;
} else if (inInsertAfter) {
writer.endElement("after");
inInsertAfter = false;
}
writer.endElement("insert");
}
/**
* Write the start of an update operation.
*
* @param targetId ID of the node to be updated
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void startUpdate(String targetId) throws IOException {
startChangesIfNecessary();
ResponseWriter writer = getWrapped();
writer.startElement("update", null);
writer.writeAttribute("id", targetId, null);
writer.startCDATA();
}
/**
* Write the end of an update operation.
*
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void endUpdate() throws IOException {
ResponseWriter writer = getWrapped();
writer.endCDATA();
writer.endElement("update");
}
/**
* Write an attribute update operation.
*
* @param targetId ID of the node to be updated
* @param attributes Map of attribute name/value pairs to be updated
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void updateAttributes(String targetId, Map attributes)
throws IOException {
startChangesIfNecessary();
ResponseWriter writer = getWrapped();
writer.startElement("attributes", null);
writer.writeAttribute("id", targetId, null);
for (Map.Entry entry : attributes.entrySet()) {
writer.startElement("attribute", null);
writer.writeAttribute("name", entry.getKey(), null);
writer.writeAttribute("value", entry.getValue(), null);
writer.endElement("attribute");
}
writer.endElement("attributes");
}
/**
* Write a delete operation.
*
* @param targetId ID of the node to be deleted
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void delete(String targetId) throws IOException {
startChangesIfNecessary();
ResponseWriter writer = getWrapped();
writer.startElement("delete", null);
writer.writeAttribute("id", targetId, null);
writer.endElement("delete");
}
/**
* Write a redirect operation.
*
* @param url URL to redirect to
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void redirect(String url) throws IOException {
endChangesIfNecessary();
ResponseWriter writer = getWrapped();
writer.startElement("redirect", null);
writer.writeAttribute("url", url, null);
writer.endElement("redirect");
}
/**
* Write the start of an eval operation.
*
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void startEval() throws IOException {
startChangesIfNecessary();
ResponseWriter writer = getWrapped();
writer.startElement("eval", null);
writer.startCDATA();
}
/**
* Write the end of an eval operation.
*
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void endEval() throws IOException {
ResponseWriter writer = getWrapped();
writer.endCDATA();
writer.endElement("eval");
}
/**
* Write the start of an extension operation.
*
* @param attributes String name/value pairs for extension element attributes
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void startExtension(Map attributes) throws IOException {
endChangesIfNecessary();
ResponseWriter writer = getWrapped();
writer.startElement("extension", null);
if (attributes != null && !attributes.isEmpty()) {
for (Map.Entry entry : attributes.entrySet()) {
writer.writeAttribute(entry.getKey(), entry.getValue(), null);
}
}
}
/**
* Write the end of an extension operation.
*
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void endExtension() throws IOException {
ResponseWriter writer = getWrapped();
writer.endElement("extension");
}
/**
* Write the start of an error.
*
* @param errorName Descriptive string for the error
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void startError(String errorName) throws IOException {
endChangesIfNecessary();
ResponseWriter writer = getWrapped();
writer.startElement("error", null);
writer.startElement("error-name", null);
writer.write(errorName);
writer.endElement("error-name");
writer.startElement("error-message", null);
writer.startCDATA();
}
/**
* Write the end of an error.
*
* @throws IOException if an input/output error occurs
* @since 2.0
*/
public void endError() throws IOException {
ResponseWriter writer = getWrapped();
writer.endCDATA();
writer.endElement("error-message");
writer.endElement("error");
}
private void startChangesIfNecessary() throws IOException {
if (!inChanges) {
ResponseWriter writer = getWrapped();
writer.startElement("changes", null);
inChanges = true;
}
}
private void endChangesIfNecessary() throws IOException {
if (inChanges) {
ResponseWriter writer = getWrapped();
writer.endElement("changes");
inChanges = false;
}
}
}