org.efaps.jaas.ActionCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation

eFaps is a framework used to map objects with or without attached files to a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface. The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.

There is a newer version: 3.2.0

Show newest version

/*
 * Copyright 2003 - 2012 The eFaps Team
 *
 * Licensed 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.
 *
 * Revision:        $Rev: 7483 $
 * Last Changed:    $Date: 2012-05-11 11:57:38 -0500 (Fri, 11 May 2012) $
 * Last Changed By: $Author: [email protected] $
 */

package org.efaps.jaas;

import javax.security.auth.callback.Callback;

/**
 * The class defines with which action the call back is made. It defines e.g.
 * the difference between a login and an import of all persons.
 *
 * @author The eFaps Team
 * @version $Id: ActionCallback.java 7483 2012-05-11 16:57:38Z [email protected] $
 */
public class ActionCallback
    implements Callback
{
    /**
     * Defines all possible modes of the call back.
     */
    public enum Mode {
        /** A List of all persons is needed. */
        ALL_PERSONS,
        /** A 'normal' login is done. Name and Password must be checked. */
        LOGIN,
        /** Information about a person is needed. Password is not to check */
        PERSON_INFORMATION,
        /** The Password is set. The right to change the password must be checked */
        SET_PASSWORD,
        /** Mode is undefined. An exception should be thrown. */
        UNDEFINED
    }

    /**
     * @see #setMode(Mode)
     * @see #getMode()
     */
    private Mode mode = ActionCallback.Mode.UNDEFINED;

    /**
     * This is the setter method for instance variable {@link #mode}.
     *
     * @param _mode new value for instance variable {@link #mode}
     * @see #mode
     * @see #getMode()
     */
    public void setMode(final Mode _mode)
    {
        this.mode = _mode;
    }

    /**
     * This is the getter method for instance variable {@link #mode}.
     *
     * @return the value of the instance variable {@link #mode}.
     * @see #mode
     * @see #setMode(Mode)
     */
    public Mode getMode()
    {
        return this.mode;
    }
}