authentication/UI/CallBackTiledView.java

	CallBackTiledView.java revision 25e37495f2591ee8f2c057f2644ed5570b4c078d
/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
 *
 * 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
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/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 Copyrighted [year] [name of copyright owner]"
 *
 * $Id: CallBackTiledView.java,v 1.4 2008/12/23 21:26:17 ericow Exp $
 *
 */

/*
 * Portions Copyrighted 2011 ForgeRock AS
 */

package com.sun.identity.authentication.UI;

import java.util.List;

import javax.security.auth.callback.Callback;
import javax.security.auth.callback.ChoiceCallback;
import javax.security.auth.callback.NameCallback;
import javax.security.auth.callback.PasswordCallback;

import com.iplanet.jato.RequestHandler;
import com.iplanet.jato.model.DatasetModel;
import com.iplanet.jato.model.ModelControlException;
import com.iplanet.jato.view.RequestHandlingTiledViewBase;
import com.iplanet.jato.view.TiledView;
import com.iplanet.jato.view.View;
import com.iplanet.jato.view.event.ChildDisplayEvent;
import com.iplanet.jato.view.event.DisplayEvent;
import com.iplanet.jato.view.html.StaticTextField;

/**
 * This class contains a set of callbacks for login view bean
 */
public class CallBackTiledView
    extends RequestHandlingTiledViewBase
    implements TiledView, RequestHandler
{
    private Callback[] callbacks = null;
    private List requiredList = null;
    private List<String> infoText = null;
    private Callback curCallback = null;
    private int curTile = 0;

    /** index of current tile */
    public static final String TXT_INDEX = "txtIndex";

    /** tiled view of choice */
    public static final String TILED_CHOICE = "tiledChoices";

    /** prompt/label for attribute */
    public static final String TXT_PROMPT = "txtPrompt";

    /** value for attribute */
    public static final String TXT_VALUE = "txtValue";

    /** info text value */
    public static String TXT_INFO = "txtInfo";

    /**
     * constructs a tiled view of callbacks
     *
     * @param parent The reference of the parent container
     * @param name The name of this view.
     */
    public CallBackTiledView(View parent, String name) {
        super(parent, name);
        setPrimaryModel((DatasetModel) getDefaultModel());
        registerChildren();
    }

    /**
     * registers child components/views
     */
    protected void registerChildren() {
        registerChild(TXT_INDEX, StaticTextField.class);
        registerChild(TILED_CHOICE, CallBackChoiceTiledView.class);
        registerChild(TXT_PROMPT, StaticTextField.class);
        registerChild(TXT_VALUE, StaticTextField.class);
        registerChild(TXT_INFO, StaticTextField.class);
    }


    /**
     * creates child component
     *
     * @param name of child component
     * @return child component
     */
    protected View createChild(String name) {
        if (name.equals(TXT_INDEX)) {
            return new StaticTextField(this, TXT_INDEX, "");
        }
        if (name.equals(TILED_CHOICE)) {
            return new CallBackChoiceTiledView(this, TILED_CHOICE);
        }
        if (name.equals(TXT_PROMPT)) {
            return new StaticTextField(this, TXT_PROMPT, "");
        }
        if (name.equals(TXT_VALUE)) {
            return new StaticTextField(this, TXT_VALUE, "");
        }
        if (name.equals(TXT_INFO)) {
            return new StaticTextField(this, TXT_INFO, "");
        }
        throw new IllegalArgumentException("Invalid child name ["
            + name + "]");
    }

    /**
     * begins displaying page. we set the required information
     *
     * @param event   display event
     * @throws ModelControlException  if problem access value of component
     */
    public void beginDisplay(DisplayEvent event)
        throws ModelControlException {
        if (getPrimaryModel() == null) {
            throw new ModelControlException("Primary model is null");
        }

        if (callbacks != null) {
            getPrimaryModel().setSize(callbacks.length);
        } else {
            getPrimaryModel().setSize(0);
        }

        super.beginDisplay(event);
        resetTileIndex();
    }

    /**
     * moves the current tile position to the next available tile.
     *
     * @return true if another tile was available, false if the position
     *         remained unchanged because no next tile was available.
     *
     * @throws ModelControlException if manipulation of model fails.
     */
    public boolean nextTile()
        throws ModelControlException {
        boolean movedToRow = super.nextTile();

        if (movedToRow) {
            curTile = getTileIndex();
            curCallback = callbacks[curTile];
            setDisplayFieldValue(TXT_INDEX, Integer.toString(curTile));

            if (curCallback instanceof NameCallback) {
                setNameCallbackInfo((NameCallback) curCallback);
            } else if (curCallback instanceof PasswordCallback) {
                setPasswordCallbackInfo((PasswordCallback) curCallback);
            } else if (curCallback instanceof ChoiceCallback) {
                setChoiceCallbackInfo((ChoiceCallback) curCallback);
            } else {
                setDisplayFieldValue(TXT_PROMPT, "");
                setDisplayFieldValue(TXT_VALUE, "");
                setDisplayFieldValue(TXT_INFO, "");

                CallBackChoiceTiledView tView =
                    (CallBackChoiceTiledView) getChild(TILED_CHOICE);
                tView.setChoices(curTile, null, 0);
            }
        }

        return movedToRow;
    }

    public void setCallBackArray(Callback[] callbacks, List requiredList) {
        this.callbacks = callbacks;
        this.requiredList = requiredList;
    }

    /**
     * set callback array
     *
     * @param callbacks array
     * @param requiredList - list of required attribute
     */
    public void setCallBackArray(Callback[] callbacks, List requiredList, List<String> infoText) {
        this.callbacks = callbacks;
        this.requiredList = requiredList;
        this.infoText = infoText;
    }

    private void setNameCallbackInfo(NameCallback nc) {
        setDisplayFieldValue(TXT_PROMPT, nc.getPrompt());

        String name = nc.getName();

        if ((name == null) || (name.equals(""))) {
            name = nc.getDefaultName();
        }

        setDisplayFieldValue(TXT_VALUE, name);
        setDisplayFieldValue(TXT_INFO, getInfoText());

        CallBackChoiceTiledView tView =
            (CallBackChoiceTiledView) getChild(TILED_CHOICE);
        tView.setChoices(curTile, null, 0);
    }

    private void setPasswordCallbackInfo(PasswordCallback pc) {
        setDisplayFieldValue(TXT_PROMPT, pc.getPrompt());
        char[] tmp = pc.getPassword();

        if (tmp == null) {
            setDisplayFieldValue(TXT_VALUE, "");
        } else {
            setDisplayFieldValue(TXT_VALUE, new String(tmp));
        }

        setDisplayFieldValue(TXT_INFO, getInfoText());
        CallBackChoiceTiledView tView =
            (CallBackChoiceTiledView) getChild(TILED_CHOICE);
        tView.setChoices(curTile, null, 0);
    }

    private void setChoiceCallbackInfo(ChoiceCallback cc) {
        setDisplayFieldValue(TXT_PROMPT, cc.getPrompt());
        setDisplayFieldValue(TXT_VALUE, "");
        setDisplayFieldValue(TXT_INFO, getInfoText());

        CallBackChoiceTiledView tView =
            (CallBackChoiceTiledView) getChild(TILED_CHOICE);
        tView.setChoices(curTile, cc.getChoices(), cc.getDefaultChoice());
    }

    /**
     * begins display of textbox field element
     *
     * @param event - child display event
     * @return true if current callback is for textbox
     */
    public boolean beginTextBoxDisplay(ChildDisplayEvent event) {
        return (curCallback != null) && (curCallback instanceof NameCallback);
    }

    /**
     * begins display of password field element
     *
     * @param event - child display event
     * @return true if current callback is for password
     */
    public boolean beginPasswordDisplay(ChildDisplayEvent event) {
        return (curCallback != null) &&
            (curCallback instanceof PasswordCallback);
    }

    /**
     * begins display of choice field element
     *
     * @param event - child display event
     * @return true if current callback is for choices
     */
    public boolean beginChoiceDisplay(ChildDisplayEvent event) {
        return (curCallback != null) && (curCallback instanceof ChoiceCallback);
    }

    /**
     * begins display of required marked element
     *
     * @param event - child display event
     * @return true if current callback is required
     */
    public boolean beginIsRequiredDisplay(ChildDisplayEvent event) {
        boolean required = false;

        if ((requiredList != null) && !requiredList.isEmpty()) {
            String s = (String) requiredList.get(curTile -1);

            if ((s != null) && (s.length() > 0)) {
                required = true;
            }
        }

        return required;
    }

    public boolean beginHasInfoTextDisplay(ChildDisplayEvent event) {
        boolean hasInfoText = false;

        if ((infoText != null) && !infoText.isEmpty()) {
            String s = infoText.get(curTile -1);

            if ((s != null) && (s.length() > 0)) {
                hasInfoText = true;
            }
        }

        return hasInfoText;
    }


    private String getInfoText() {
        String result = "";

        if ((infoText != null) && !infoText.isEmpty()) {
            String s = infoText.get(curTile -1);

            if ((s != null) && (s.length() > 0)) {
                result = s;
            }
        }

        return result;
    }
}