org.eclipse.osbp.authentication/src/org/eclipse/osbp/authentication/shiro/extensions/IPortalAuthenticationToken.java

/**
 *                                                                            
 * Copyright (c) 2011, 2016 - Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
 *                                                                            
 * All rights reserved. This program and the accompanying materials           
 * are made available under the terms of the Eclipse Public License v1.0       
 * which accompanies this distribution, and is available at                  
 * http://www.eclipse.org/legal/epl-v10.html                                 
 *                                                                            
 * Contributors:   
 * Christophe Loetz (Loetz GmbH&Co.KG) - initial implementation 
 */
package org.eclipse.osbp.authentication.shiro.extensions;

import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.realm.AuthenticatingRealm;

import org.eclipse.osbp.authentication.providerimpl.UserProtocol;

// TODO: Auto-generated Javadoc
/**
 * The Interface IPortalAuthenticationToken.
 */
public interface IPortalAuthenticationToken extends AuthenticationToken {
    
    /**
     * Gets the portal id.
     *
     * @return the portal id
     */
    String getPortalId();
	
	/**
	 * Sets the authenticated by realm.
	 *
	 * @param authenticatingRealm the new authenticated by realm
	 */
	void setAuthenticatedByRealm(AuthenticatingRealm authenticatingRealm);
	
	/**
	 * Sets the user protocol.
	 *
	 * @param protocol the new user protocol
	 */
	void setUserProtocol(UserProtocol protocol);
	
	/**
	 * Gets the user protocol.
	 *
	 * @return the user protocol
	 */
	UserProtocol getUserProtocol();
}