class: LoginHelper

public class: LoginHelper
Author: : Tobias Schraut, created 07.03.2007
Project: Phase: 1.0; Status: Proposed; Version: : $Revision: 2615 $ $LastChangedDate: 2009-05-08 1; Complexity: 1
Dates: Created: 16.07.2009 15:33:44; Modified: 16.07.2009 15:33:44;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {77F35CE5-B1E1-4a61-AC75-CA9ACE83F80F}
LoginHelper.java Class for providing helper methods for login / logout mechanism
 

Goto: Custom Properties, Fields, Methods

Extends: FacesBean

See also: ContextListSessionBean, PubItemListSessionBean, QAWS, FacesBean, PubFileVOPresentation, FileBean, ViewItemFull, ItemControllerSessionBean

Appears in: util

Connections
 
Custom Properties
 
LoginHelper Attributes
Attribute Details
private AccountUserVO
  accountUser
Initial: new AccountUserVO()
public static const String
  BEAN_NAME
Initial: "LoginHelper"
private String
  btnLoginLogout
Initial: "login_btLogin"
private String
  eSciDocUserHandle
Initial: null
private boolean
  loggedIn
Initial: false
private static Logger
  logger
Initial: Logger.getLogger(LoginHelper.class)
public static const String
  PARAMETERNAME_USERHANDLE
Initial: "eSciDocUserHandle"
private boolean
  wasLoggedIn
Initial: false
Notes: a flag for showing if the user has been logged in once. If yes, the user will be redirected to the home page after log out.
 
LoginHelper Methods
Operation Details
public
changeLanguage(
   ResourceBundle bundle):void
Sequential
Notes: changes the language in the navigation menu (according to login state)
public
checkLogin():String
Sequential
Tags: throws=IOException,ServletException,ServiceException,TechnicalException,URISyntaxException
Notes: Method checks if the user is already logged in and inserts the escidoc user handle. If not it redirects to the login page.
@return String empty navigation string for reloading the current page
public
fetchAccountUser(
   String userHandle):void
Sequential
Tags: throws=WebserverSystemException,SqlDatabaseSystemException,RemoteException,MalformedURLException,ServiceException,TechnicalException,URISyntaxException
Notes: retrieves the account user with the user handle
public
getAccountUser():AccountUserVO
Sequential
public
getBtnLoginLogout():String
Sequential
public
getESciDocUserHandle():String
Sequential
public
getIsDepositor():boolean
Sequential
Notes: JSF Wrapper for isDepositor()
@return
public
getIsMdEditor():boolean
Sequential
Notes: JSF Wrapper for isMdEditor()
@return
public
getIsModerator():boolean
Sequential
Notes: JSF Wrapper for isModerator()
@return
public
getLoggedIn():boolean
Sequential
public
getLoginLogoutLabel():String
Sequential
public
getUser():String
Sequential
public
insertLogin():String
Sequential
Tags: throws=IOException,ServiceException,TechnicalException,URISyntaxException
Notes: Method checks if the user is already logged in and inserts the escidoc user handle.
@return String empty navigation string for reloading the current page
public
isLoggedIn():boolean
Sequential
public
isWasLoggedIn():boolean
Sequential
public
login(
   String userHandle):void
Sequential
Notes: Getters and Setters
public
LoginHelper():
Sequential
Notes: Public constructor.
public
logout(
   String userHandle):void
Sequential
public
setAccountUser(
   AccountUserVO accountUser):void
Sequential
public
setBtnLoginLogout(
   String btnLoginLogout):void
Sequential
public
setESciDocUserHandle(
   String eSciDocUserHandle):void
Sequential
public
setLoggedIn(
   boolean loggedIn):void
Sequential
public
setWasLoggedIn(
   boolean wasLoggedIn):void
Sequential
public
toString():String
Sequential