impl/src/main/java/org/apache/myfaces/lifecycle/UrlClientWindow.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.myfaces.lifecycle;

import org.apache.myfaces.util.token.TokenGenerator;
import java.util.HashMap;
import java.util.Map;
import javax.faces.context.FacesContext;
import javax.faces.lifecycle.ClientWindow;
import javax.faces.render.ResponseStateManager;

/**
 *
 * @author lu4242
 */
public class UrlClientWindow extends ClientWindow
{
    private String windowId;

    private TokenGenerator tokenGenerator;
    
    private Map<String,String> queryParamsMap;
    
    public UrlClientWindow(TokenGenerator tokenGenerator)
    {
        this.tokenGenerator = tokenGenerator;
    }
        
    @Override
    public void decode(FacesContext context)
    {
        String windowId = calculateWindowId(context);

        if (windowId != null)
        {
            // Store the current windowId.
            setId(windowId);
        }
        else
        {
            //Generate a new windowId
            setId(tokenGenerator.getNextToken());
        }
    }
    
    protected String calculateWindowId(FacesContext context)
    {
        //1. If it comes as parameter, it takes precedence over any other choice, because
        //   no browser is capable to do a POST and create a new window at the same time.
        String windowId = context.getExternalContext().getRequestParameterMap().get(
                ResponseStateManager.CLIENT_WINDOW_PARAM);
        if (windowId != null)
        {
            return windowId;
        }
        windowId = context.getExternalContext().getRequestParameterMap().get(
                ResponseStateManager.CLIENT_WINDOW_URL_PARAM);
        if (windowId != null)
        {
            return windowId;
        }
        return null;
    }

    @Override
    public String getId()
    {
        return windowId;
    }
    
    public void setId(String id)
    {
        windowId = id;
        queryParamsMap = null;
    }

    @Override
    public Map<String, String> getQueryURLParameters(FacesContext context)
    {
        if (queryParamsMap == null)
        {
            String id = context.getExternalContext().getClientWindow().getId();
            if (id != null)
            {
                queryParamsMap = new HashMap<>(2, 1);
                queryParamsMap.put(ResponseStateManager.CLIENT_WINDOW_URL_PARAM, id);
            }
        }
        return queryParamsMap;
    }
    
}