com.sun.faces.application.view.JspStateManagementStrategy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.faces Show documentation
Show all versions of javax.faces Show documentation
This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 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.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 com.sun.faces.application.view;
import com.sun.faces.renderkit.RenderKitUtils;
import com.sun.faces.util.FacesLogger;
import com.sun.faces.util.Util;
import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.faces.FacesException;
import javax.faces.application.ProjectStage;
import javax.faces.component.UIComponent;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.render.ResponseStateManager;
import javax.faces.view.StateManagementStrategy;
/**
* A state management strategy for JSP.
*
* @author Manfred Riem ([email protected])
*/
public class JspStateManagementStrategy extends StateManagementStrategy {
/**
* Stores the logger.
*/
private static final Logger LOGGER = FacesLogger.APPLICATION_VIEW.getLogger();
/**
* Stores the class map.
*/
private Map> classMap;
/**
* Are we in development mode.
*/
private boolean isDevelopmentMode;
/**
* Constructor.
*/
public JspStateManagementStrategy() {
this(FacesContext.getCurrentInstance());
}
/**
* Constructor.
*
* @param context the Faces context.
*/
public JspStateManagementStrategy(FacesContext context) {
isDevelopmentMode = context.isProjectStage(ProjectStage.Development);
classMap = new ConcurrentHashMap<>(32);
}
/**
* Capture the child.
*
* @param tree the tree.
* @param parent the parent.
* @param c the component.
*/
private void captureChild(List tree, int parent, UIComponent c) {
if (!c.isTransient()) {
TreeNode n = new TreeNode(parent, c);
int pos = tree.size();
tree.add(n);
captureRest(tree, pos, c);
}
}
/**
* Capture the facet.
*
* @param tree the tree.
* @param parent the parent.
* @param name the facet name.
* @param c the component.
*/
private void captureFacet(List tree, int parent, String name, UIComponent c) {
if (!c.isTransient()) {
FacetNode n = new FacetNode(parent, name, c);
int pos = tree.size();
tree.add(n);
captureRest(tree, pos, c);
}
}
/**
* Capture the rest.
*
* @param tree the tree.
* @param pos the position.
* @param c the component.
*/
private void captureRest(List tree, int pos, UIComponent c) {
int sz = c.getChildCount();
if (sz > 0) {
List child = c.getChildren();
for (int i = 0; i < sz; i++) {
captureChild(tree, pos, child.get(i));
}
}
sz = c.getFacetCount();
if (sz > 0) {
for (Map.Entry entry : c.getFacets().entrySet()) {
captureFacet(tree, pos, entry.getKey(), entry.getValue());
}
}
}
/**
* Create a new component instance.
*
* @param n the tree node.
* @return the UI component.
* @throws FacesException when a serious error occurs.
*/
private UIComponent newInstance(TreeNode n) throws FacesException {
if (LOGGER.isLoggable(Level.FINEST)) {
LOGGER.log(Level.FINEST, "newInstance", n.componentType);
}
try {
Class t = ((classMap != null) ? classMap.get(n.componentType) : null);
if (t == null) {
t = Util.loadClass(n.componentType, n);
if (t != null && classMap != null) {
classMap.put(n.componentType, t);
} else {
if (!isDevelopmentMode) {
throw new NullPointerException();
}
}
}
assert (t != null);
UIComponent c = (UIComponent) t.newInstance();
c.setId(n.id);
return c;
} catch (ClassNotFoundException | NullPointerException | InstantiationException | IllegalAccessException e) {
throw new FacesException(e);
}
}
/**
* Restore the component tree.
*
* @param renderKitId the render kit id.
* @param tree the saved tree.
* @return the view root.
* @throws FacesException when a serious error occurs.
*/
private UIViewRoot restoreTree(FacesContext context,
String renderKitId,
Object[] tree) throws FacesException {
if (LOGGER.isLoggable(Level.FINEST)) {
LOGGER.log(Level.FINEST, "restoreTree", renderKitId);
}
UIComponent c;
FacetNode fn;
TreeNode tn;
for (int i = 0; i < tree.length; i++) {
if (tree[i] instanceof FacetNode) {
fn = (FacetNode) tree[i];
c = newInstance(fn);
tree[i] = c;
if (i != fn.parent) {
((UIComponent) tree[fn.parent]).getFacets().put(fn.facetName, c);
}
} else {
tn = (TreeNode) tree[i];
c = newInstance(tn);
tree[i] = c;
if (i != tn.parent) {
((UIComponent) tree[tn.parent]).getChildren().add(c);
} else {
assert (c instanceof UIViewRoot);
UIViewRoot viewRoot = (UIViewRoot) c;
context.setViewRoot(viewRoot);
viewRoot.setRenderKitId(renderKitId);
}
}
}
return (UIViewRoot) tree[0];
}
/**
* Restore the view.
*
* @param context the Faces context.
* @param viewId the view id.
* @param renderKitId the render kit id.
* @return the view root.
*/
@Override
public UIViewRoot restoreView(FacesContext context, String viewId, String renderKitId) {
if (LOGGER.isLoggable(Level.FINEST)) {
LOGGER.log(Level.FINEST, "restoreView", new Object[]{viewId, renderKitId});
}
UIViewRoot result = null;
ResponseStateManager rsm = RenderKitUtils.getResponseStateManager(context, renderKitId);
Object[] state = (Object[]) rsm.getState(context, viewId);
if (state != null && state.length >= 2) {
/*
* Restore the component tree.
*/
if (state[0] != null) {
result = restoreTree(context, renderKitId, ((Object[]) state[0]).clone());
context.setViewRoot(result);
}
/*
* Restore the component state.
*/
if (result != null && state[1] != null) {
result.processRestoreState(context, state[1]);
}
}
return result;
}
/**
* Save the view.
*
* @param context the Faces context.
* @return the saved view.
*/
@Override
public Object saveView(FacesContext context) {
if (LOGGER.isLoggable(Level.FINEST)) {
LOGGER.finest("saveView");
}
Object[] result;
UIViewRoot viewRoot = context.getViewRoot();
/*
* Check uniqueness.
*/
Util.checkIdUniqueness(context, viewRoot, new HashSet<>(viewRoot.getChildCount() << 1));
/*
* Save the component state.
*/
Object state = viewRoot.processSaveState(context);
/*
* Save the tree structure.
*/
List treeList = new ArrayList<>(32);
captureChild(treeList, 0, viewRoot);
Object[] tree = treeList.toArray();
result = new Object[]{tree, state};
return result;
}
/**
* Inner class used to store a facet in the saved component tree.
*/
private static final class FacetNode extends TreeNode {
/**
* Stores the serial version UID.
*/
private static final long serialVersionUID = -3777170310958005106L;
/**
* Stores the facet name.
*/
public String facetName;
/**
* Constructor.
*/
public FacetNode() {
}
/**
* Constructor.
*
* @param parent the parent.
* @param name the facet name.
* @param c the component.
*/
public FacetNode(int parent, String name, UIComponent c) {
super(parent, c);
this.facetName = name;
}
/**
* Read the facet node in.
*
* @param in the object input.
* @throws IOException when an I/O error occurs.
* @throws ClassNotFoundException when the class could not be found.
*/
@Override
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
super.readExternal(in);
this.facetName = in.readUTF();
}
/**
* Write the facet node out.
*
* @param out the object output.
* @throws IOException when an I/O error occurs.
*/
@Override
public void writeExternal(ObjectOutput out) throws IOException {
super.writeExternal(out);
out.writeUTF(this.facetName);
}
}
/**
* Inner class used to store a node in the saved component tree.
*/
private static class TreeNode implements Externalizable {
/**
* Stores the serial version UID.
*/
private static final long serialVersionUID = -835775352718473281L;
/**
* Stores the NULL_ID constant.
*/
private static final String NULL_ID = "";
/**
* Stores the component type.
*/
public String componentType;
/**
* Stores the id.
*/
public String id;
/**
* Stores the parent.
*/
public int parent;
/**
* Constructor.
*/
public TreeNode() {
}
/**
* Constructor.
*
* @param parent the parent.
* @param c the component.
*/
public TreeNode(int parent, UIComponent c) {
this.parent = parent;
this.id = c.getId();
this.componentType = c.getClass().getName();
}
/**
* Read the tree node in.
*
* @param in the object input.
* @throws IOException when an I/O error occurs.
* @throws ClassNotFoundException when the class could not be found.
*/
@Override
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
this.parent = in.readInt();
this.componentType = in.readUTF();
this.id = in.readUTF();
if (id.length() == 0) {
id = null;
}
}
/**
* Write the tree node out.
*
* @param out the object output.
* @throws IOException when an I/O error occurs.
*/
@Override
public void writeExternal(ObjectOutput out) throws IOException {
out.writeInt(this.parent);
out.writeUTF(this.componentType);
if (this.id != null) {
out.writeUTF(this.id);
} else {
out.writeUTF(NULL_ID);
}
}
}
}