class: Login

public class: Login
Author: : Tobias Schraut, created 31.01.2007
Project: Phase: 1.0; Status: Proposed; Version: : $Revision: 2689 $ $LastChangedDate: 2009-05-27 1; Complexity: 1
Dates: Created: 16.07.2009 15:32:11; Modified: 16.07.2009 15:32:11;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {1184F9D1-FBC3-4cd1-976D-F1838F0894A3}
Class for providing login / logout functionality and coresponds to the Login.jspf.
 

Goto: Custom Properties, Fields, Methods

Extends: FacesBean

See also: FacesBean

Appears in: desktop

Connections
 
Custom Properties
 
Login Attributes
Attribute Details
public static const String
  BEAN_NAME
Initial: "Login"
private String
  btnLoginLogout
Initial: "login_btLogin"
private String
  displayUserName
Initial: ""
private boolean
  loggedIn
Initial: false
private static Logger
  logger
Initial: Logger.getLogger(Login.class)
public static String
  LOGIN_URL
Initial: "/aa/login"
public static String
  LOGOUT_URL
Initial: "/aa/logout/clear.jsp"
private HtmlInputText
  txtLogin
Initial: new HtmlInputText()
private HtmlInputText
  txtPassword
Initial: new HtmlInputText()
 
Login Methods
Operation Details
public
forceLogout():String
Sequential
Notes: method for brutal logout if authentication errors occur in the framework
@return String navigation string for loading the login error page
public
forceLogout(
   String itemID):String
Sequential
Notes: method for brutal logout if authantication errors occur in the framework
@return String navigation string for loading the login error page
public
getBtnLoginLogout():String
Sequential
Notes: Getters and Setters
public
getDisplayUserName():String
Sequential
public
getFacesParamValue(
   String name):String
Sequential
Notes: gets the parameters out of the faces context
@return String value of the faces context parameter
public
getLoggedIn():boolean
Sequential
private
getLoginUrlFromCurrentBreadcrumb():String
Sequential
Tags: throws=IOException,URISyntaxException,ServiceException
public
getTxtLogin():HtmlInputText
Sequential
public
getTxtPassword():HtmlInputText
Sequential
public
init():void
Sequential
Notes: Callback method that is called whenever a page is navigated to, either directly via a URL, or indirectly via page navigation.
public
isLoggedIn():boolean
Sequential
public
Login():
Sequential
Notes: public constructor
public
loginLogout():String
Sequential
Tags: throws=ServletException,IOException,ServiceException,URISyntaxException
Notes: one method for login and logout according to the current login state
@return String empty navigation string for reloading the page
public
logout():void
Sequential
Tags: throws=IOException,ServiceException,URISyntaxException
Notes: @param fc
public
setBtnLoginLogout(
   String btnLoginLogout):void
Sequential
public
setDisplayUserName(
   String displayUserName):void
Sequential
public
setLoggedIn(
   boolean loggedIn):void
Sequential
public
setTxtLogin(
   HtmlInputText txtLogin):void
Sequential
public
setTxtPassword(
   HtmlInputText txtPassword):void
Sequential