All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.faces.application.view.StateManagementStrategyImpl Maven / Gradle / Ivy

Go to download

This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.

There is a newer version: 2.4.0
Show 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 com.sun.faces.application.view;

import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.faces.FactoryFinder;
import javax.faces.component.UIComponent;
import javax.faces.component.UIViewRoot;
import javax.faces.component.visit.VisitResult;
import javax.faces.context.FacesContext;
import javax.faces.render.ResponseStateManager;

import com.sun.faces.component.visit.VisitUtils;
import com.sun.faces.context.StateContext;
import com.sun.faces.renderkit.RenderKitUtils;
import com.sun.faces.util.ComponentStruct;
import com.sun.faces.util.FacesLogger;
import com.sun.faces.util.MessageUtils;
import com.sun.faces.util.Util;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.io.IOException;
import javax.faces.application.StateManager;
import javax.faces.component.ContextCallback;
import javax.faces.component.visit.VisitCallback;
import javax.faces.component.visit.VisitContext;
import javax.faces.view.StateManagementStrategy;
import javax.faces.FacesException;
import javax.faces.application.Application;
import javax.faces.event.PostRestoreStateEvent;
import javax.faces.view.ViewDeclarationLanguage;
import javax.faces.view.ViewDeclarationLanguageFactory;

/**
 * 

 * A StateManager implementation to meet the requirements
 * of the specification.
 * 

 *
 * 

 * For those who had compile dependencies on this class, we're sorry for any
 * inconvenience, but this had to be re-worked as the version you depended on
 * was incorrectly implemented.  
 * 

 */
public class StateManagementStrategyImpl extends StateManagementStrategy {

    private static final Logger LOGGER = FacesLogger.APPLICATION_VIEW.getLogger();

    private final ViewDeclarationLanguageFactory vdlFactory;

    private static final String CLIENTIDS_TO_REMOVE_NAME =
            "com.sun.faces.application.view.CLIENTIDS_TO_REMOVE";
    private static final String CLIENTIDS_TO_ADD_NAME =
            "com.sun.faces.application.view.CLIENTIDS_TO_ADD";


    // ------------------------------------------------------------ Constructors


    /**
     * Create a new StateManagerImpl instance.
     */
    public StateManagementStrategyImpl() {

        vdlFactory = (ViewDeclarationLanguageFactory)
              FactoryFinder.getFactory(FactoryFinder.VIEW_DECLARATION_LANGUAGE_FACTORY);

    }

    
    // ----------------------------------------------- Methods from StateManager


    /**
     * @see {@link javax.faces.application.StateManager#saveView(javax.faces.context.FacesContext))
     */
    @Override
    public Object saveView(FacesContext context) {

        if (context == null) {
            return null;
        }

        // irrespective of method to save the tree, if the root is transient
        // no state information needs to  be persisted.
        UIViewRoot viewRoot = context.getViewRoot();
        if (viewRoot.isTransient()) {
            return null;
        }


        // honor the requirement to check for id uniqueness
        Util.checkIdUniqueness(context,
                               viewRoot,
                               new HashSet(viewRoot.getChildCount() << 1));
        final Map stateMap = new HashMap();

// -----------------------------------------------------------------------------
//        COMMENTED OUT DUE TO ISSUE 1310 UNTIL NEW VISIT HINTS CAN BE
//        ADDED TO THE API
// -----------------------------------------------------------------------------
//        VisitContext visitContext = VisitContext.createVisitContext(context);
//        final FacesContext finalContext = context;
//        viewRoot.visitTree(visitContext, new VisitCallback() {
//
//            public VisitResult visit(VisitContext context, UIComponent target) {
//                VisitResult result = VisitResult.ACCEPT;
//                Object stateObj;
//                if (!target.isTransient()) {
//                    if (target.getAttributes().containsKey(DYNAMIC_COMPONENT)) {
//                        stateObj = new StateHolderSaver(finalContext, target);
//                    } else {
//                        stateObj = target.saveState(context.getFacesContext());
//                    }
//                    if (null != stateObj) {
//                        stateMap.put(target.getClientId(context.getFacesContext()),
//                                                        stateObj);
//                    }
//                } else {
//                    return result;
//                }
//
//                return result;
//            }
//
//        });
// -----------------------------------------------------------------------------

        StateContext stateContext = StateContext.getStateContext(context);

        // PENDING: Use of VisitUtils and FacesContext Attribute For Visit Hints
        //    until new Visit Hints defined in spec.
        //    See: https://javaserverfaces-spec-public.dev.java.net/issues/show_bug.cgi?id=545
        VisitUtils.startStateSaveRestore(context);

        // ADDED FOR ISSUE 1310 - REMOVE ONCE NEW VISIT HINTS ARE ADDED TO THE
        // API
        saveComponentState(viewRoot, context, stateContext, stateMap);

        // PENDING: Use of VisitUtils and FacesContext Attribute For Visit Hints
        //    until new Visit Hints defined in spec.
        //    See: https://javaserverfaces-spec-public.dev.java.net/issues/show_bug.cgi?id=545
        VisitUtils.endStateSaveRestore(context);

        // handle dynamic adds/removes
        List removeList = stateContext.getDynamicRemoves();
        if (null != removeList && !removeList.isEmpty()) {
            stateMap.put(CLIENTIDS_TO_REMOVE_NAME, removeList);
        }
        Map addList = stateContext.getDynamicAdds();
        if (null != addList && !addList.isEmpty()) {
            List savedAddList = new ArrayList(addList.size());
            for (ComponentStruct s : addList.values()) {
                savedAddList.add(s.saveState(context));
            }
            stateMap.put(CLIENTIDS_TO_ADD_NAME, savedAddList.toArray());
        }
        //return stateMap;
        return new Object[] { null, stateMap };

    }


    /**
     * @see {@link StateManager#restoreView(javax.faces.context.FacesContext, String, String)}
     */
    @Override
    public UIViewRoot restoreView(FacesContext context,
                                  String viewId,
                                  String renderKitId) {

        ResponseStateManager rsm =
              RenderKitUtils.getResponseStateManager(context, renderKitId);
        boolean processingEvents = context.isProcessingEvents();
        // Build the tree to initial state
        UIViewRoot viewRoot;
        try {
            ViewDeclarationLanguage vdl = vdlFactory.getViewDeclarationLanguage(viewId);
            viewRoot = vdl.getViewMetadata(context, viewId).createMetadataView(context);
            context.setViewRoot(viewRoot);
            context.setProcessingEvents(true);
            vdl.buildView(context, viewRoot);
        } catch (IOException ioe) {
            throw new FacesException(ioe);
        }
        Object[] rawState = (Object[]) rsm.getState(context, viewId);
        if (rawState == null) {
            return null; // trigger a ViewExpiredException
        }
        //noinspection unchecked
        final Map state = (Map) rawState[1];
        final StateContext stateContext = StateContext.getStateContext(context);

        if (null != state) {
            try {
                stateContext.setTrackViewModifications(false);
                final Application app = context.getApplication();
                // We need to clone the tree, otherwise we run the risk
                // of being left in a state where the restored
                // UIComponent instances are in the session instead
                // of the TreeNode instances.  This is a problem
                // for servers that persist session data since
                // UIComponent instances are not serializable.

	        // PENDING: Use of VisitUtils and FacesContext Attribute For Visit Hints
	        //    until new Visit Hints defined in spec.
                //    See: https://javaserverfaces-spec-public.dev.java.net/issues/show_bug.cgi?id=545
                // VisitContext visitContext = VisitContext.createVisitContext(context);
                // viewRoot.visitTree(visitContext, new VisitCallback() {
	        VisitUtils.startStateSaveRestore(context);
		VisitUtils.doFullNonIteratingVisit(context, new VisitCallback() {

		  public VisitResult visit(VisitContext context, UIComponent target) {
		      VisitResult result = VisitResult.ACCEPT;
		      String cid = target.getClientId(context.getFacesContext());
		      Object stateObj = state.get(cid);
		      if (stateObj != null && !stateContext.componentAddedDynamically(target)) {
			  try {
			      target.restoreState(context.getFacesContext(),
						  stateObj);
			  } catch (Exception e) {
			      String msg =
                                  MessageUtils.getExceptionMessageString(
                                        MessageUtils.PARTIAL_STATE_ERROR_RESTORING_ID,
                                        cid,
                                        e.toString());
                                throw new FacesException(msg, e);
                            }
                        }

                        return result;
                    }

                });

            VisitUtils.endStateSaveRestore(context);
            
            // Handle dynamic add/removes
            //noinspection unchecked
            List removeList = (List) state.get(CLIENTIDS_TO_REMOVE_NAME);
            if (null != removeList && !removeList.isEmpty()) {
                for (String cur : removeList) {
                    boolean trackMods = stateContext.trackViewModifications();
                    if (trackMods) {
                        stateContext.setTrackViewModifications(false);
                    }
                    viewRoot.invokeOnComponent(context, cur, new ContextCallback() {

                            public void invokeContextCallback(FacesContext context, UIComponent target) {
                                UIComponent parent = target.getParent();
                                if (null != parent) {
                                    parent.getChildren().remove(target);
                                }
                            }

                        });
                        if (trackMods) {
                            stateContext.setTrackViewModifications(true);
                        }
                    }
                }

                Object restoredAddList[] = (Object[]) state.get(CLIENTIDS_TO_ADD_NAME);
                if (restoredAddList != null && restoredAddList.length > 0) {
                    // Restore the list of added components
                    List addList = new ArrayList(restoredAddList.length);
                    for (Object aRestoredAddList : restoredAddList) {
                        ComponentStruct cur = new ComponentStruct();
                        cur.restoreState(context, aRestoredAddList);
                        addList.add(cur);
                    }
                    // restore the components themselves
                    for (ComponentStruct cur : addList) {
                        final ComponentStruct finalCur = cur;
                        // Find the parent
                        viewRoot.invokeOnComponent(context, finalCur.parentClientId,
                                new ContextCallback() {
                                    public void invokeContextCallback(FacesContext context, UIComponent parent) {
                                        // Create the child
                                        StateHolderSaver saver = (StateHolderSaver) state.get(finalCur.clientId);
                                        UIComponent toAdd = (UIComponent) saver.restore(context);
                                        int idx = finalCur.indexOfChildInParent;
                                        if (idx == -1) {
                                            // add facet to the parent
                                            parent.getFacets().put(finalCur.facetName, toAdd);
                                        } else {
                                            // add the child to the parent at correct index
                                            try {
                                                parent.getChildren().add(finalCur.indexOfChildInParent, toAdd);
                                            } catch (IndexOutOfBoundsException ioobe) {
                                                // the indexing within the parent list is off during the restore.
                                                // This is most likely due to a transient component added during
                                                // RENDER_REPONSE phase.
                                                if (LOGGER.isLoggable(Level.FINE)) {
                                                    LOGGER.log(Level.FINE,
                                                            "Unable to insert child with client ID {0} into parent with client ID {1} into list at index {2}.",
                                                            new Object[]{finalCur.clientId,
                                                                finalCur.parentClientId,
                                                                finalCur.indexOfChildInParent});
                                                }
                                                parent.getChildren().add(toAdd);
                                            }
                                        }
                                    }
                                });
                    }
                }
            } finally {
               stateContext.setTrackViewModifications(true); 
            }
        } else {
            viewRoot = null;
        }
        context.setProcessingEvents(processingEvents);
        return viewRoot;

    }




    // --------------------------------------------------------- Private Methods


    /**
     * Temporary method added for issue 1310 to perform state saving as it
     * was done in 1.2 as calling VisitTree in its current incarnation may
     * have unintended side effects.
     *
     * @param c the component to process
     * @param ctx the FacesContext for the current request
     * @param stateMap a Map to push saved state keyed by
     *  client ID
     */
    private void saveComponentState(UIComponent c,
                                    FacesContext ctx,
                                    StateContext stateContext,
                                    Map stateMap) {

        if (!c.isTransient()) {
            Object stateObj;
            if (stateContext.componentAddedDynamically(c)) {
                stateObj = new StateHolderSaver(ctx, c);
                // ensure it's in the addList.
                Map dynamicAdds = stateContext.getDynamicAdds();
                assert(null != dynamicAdds);
                String clientId = c.getClientId(ctx);
                if (!dynamicAdds.containsKey(clientId)) {
                    ComponentStruct toAdd = new ComponentStruct();
                    toAdd.absorbComponent(ctx, c);
                    dynamicAdds.put(clientId, toAdd);
                }
            } else {
                stateObj = c.saveState(ctx);
            }
            if (null != stateObj) {
                stateMap.put(c.getClientId(ctx), stateObj);
            }
            for (Iterator i = c.getFacetsAndChildren(); i.hasNext();) {
                saveComponentState(i.next(), ctx, stateContext, stateMap);
            }
        }


    }

}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy