console/scripts/ScriptsViewBean.java

	ScriptsViewBean.java revision 28de0461d82a4e6471c71d793af7a9492ca98dd3
/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2015 ForgeRock AS.
 */
package com.sun.identity.console.scripts;

import com.iplanet.am.util.SystemProperties;
import com.iplanet.jato.CompleteRequestException;
import com.iplanet.jato.RequestContext;
import com.iplanet.jato.RequestManager;
import com.iplanet.jato.view.event.DisplayEvent;
import com.sun.identity.console.base.model.AMAdminConstants;
import com.sun.identity.console.base.model.AMModel;
import com.sun.identity.console.base.model.AMModelBase;
import com.sun.identity.console.realm.HasEntitiesTabs;
import com.sun.identity.console.realm.RealmPropertiesBase;
import com.sun.identity.shared.Constants;
import com.sun.identity.shared.debug.Debug;

import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.text.MessageFormat;

/**
 * Script management and editing.
 * @since 13.0.0
 */
public class ScriptsViewBean extends RealmPropertiesBase implements HasEntitiesTabs {

    public static final String DEFAULT_DISPLAY_URL = "/console/scripts/Scripts.jsp";

    public static final String ROOT_REALM = "/";
    public static final String SCRIPTS_EDITOR = "{0}/scripts/{1}#list";
    public static final String SCRIPTS_REALM = "?realm={0}";

    private static final Debug debug = Debug.getInstance("amConsole");

    /**
     * Creates a scripts view bean.
     */
    public ScriptsViewBean() {
        super("Scripts");
        setDefaultDisplayURL(DEFAULT_DISPLAY_URL);
    }

    @Override
    protected void initialize() {
        if (!initialized) {
            super.initialize();
            initialized = true;
        }
    }

    /**
     * This redirects to the script editor.  This isn't a natural thing for JATO, and so the strategy used here is
     * to set up a redirect and then throw a CompleteRequestException (thus pretending an error occurred) which causes
     * the redirect to happen.
     *
     * @param event The display event.
     */
    public void beginDisplay(DisplayEvent event) {

        String redirectRealm = (String) getPageSessionAttribute(AMAdminConstants.CURRENT_REALM);
        String deploymentUri = SystemProperties.get(Constants.AM_SERVICES_DEPLOYMENT_DESCRIPTOR);

        String redirect;
        if (!ROOT_REALM.equals(redirectRealm)) {
            redirect = MessageFormat.format(SCRIPTS_EDITOR, deploymentUri,
                        MessageFormat.format(SCRIPTS_REALM, redirectRealm));
        } else {
            redirect = MessageFormat.format(SCRIPTS_EDITOR, deploymentUri, "");
        }

        RequestContext rc = RequestManager.getRequestContext();
        try {
            rc.getResponse().sendRedirect(redirect);

            // throwing this exception here causes the redirect to occur.  This is more appropriate for error
            // handling, but it works, so we use it.
            //
            throw new CompleteRequestException();
        } catch (IOException e) {
            debug.warning("ScriptsViewBean.beginDisplay unexpectedly caught exception", e);
        }
    }

    @Override
    protected AMModel getModelInternal() {
        RequestContext rc = RequestManager.getRequestContext();
        HttpServletRequest req = rc.getRequest();
        return new AMModelBase(req, getPageSessionAttributes());
    }
}