eu.agrosense.api.session.AuthorizationMethod Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2008-2013 LimeTri. All rights reserved.
 *
 * AgroSense is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * There are special exceptions to the terms and conditions of the GPLv3 as it is applied to
 * this software, see the FLOSS License Exception
 * .
 *
 * AgroSense is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with AgroSense.  If not, see .
 */
package eu.agrosense.api.session;

import eu.agrosense.api.session.AuthorizationCallback;
import org.opendolphin.core.PresentationModel;
import org.openide.LifecycleManager;

/**
 *
 * @author Timon Veenstra 
 */
public interface AuthorizationMethod {
    /**
     * one of:
     * - {@link UserSession#METHOD_LOCAL}
     * - {@link UserSession#METHOD_OPENID}
     * @return 
     */
    String getSupportedMethod();
       
    /**
     * Authorize the user session
     * Usually presents something to the user, like a login panel
     * 
     * @param authorizationCallback
     * @param userSessionModel
     */
    void authorize(final AuthorizationCallback authorizationCallback, PresentationModel userSessionModel);
    
    /**
     * action to be performed on success
     * 
     * @param onSuccessAction 
     */
    void onSuccess(final OnSuccessAction onSuccessAction);
    
    
    /**
     * Action to be performed on failure
     * 
     * @param onFailureAction 
     */
    void onFailure(final OnFailureAction onFailureAction);
    
    void triggerFailure(OnFailureAction.Type type);
    
//    /**
//     * action to be performed on failure
//     * 
//     * @param authorizationCallback 
//     */
//    void onFailure(final AuthorizationCallback authorizationCallback);
    
    /**
     * action to be performed when login should be displayed
     * 
     * @param showLoginAction 
     */
    void onShowLogin(final ShowLoginAction showLoginAction);
    
    
}