com.plumtree.uiinfrastructure.login
Class LoginPEIContainer

java.lang.Object
  com.plumtree.uiinfrastructure.login.LoginPEIContainer

All Implemented Interfaces:

ILoginActions, ILoginActions2

public class LoginPEIContainer
extends java.lang.Object
implements ILoginActions2

This helper object wraps up Login PEIs that implement either ILoginActions or ILoginActions2 and makes them behave the same.

Author:

DonH

Field Summary

protected ILoginActions2	m_LoginActions2PEI
protected ILoginActions	m_LoginActionsPEI

Constructor Summary

LoginPEIContainer(ILoginActions _pei)

Method Summary

Redirect	OnAfterLogin(java.lang.Object _oUserSession, ApplicationData _appData) This function allows for some functionality to occur once the user has successfully logged in and then possibly do a redirect to someplace other than the MyPage.
Redirect	OnBeforeLogin(ApplicationData _appData, java.lang.String _strUserName) This functions allows for some functionality to occur before the user has logged in to the Portal.
Redirect	OnBeforeLogout(java.lang.Object _oUserSession, ApplicationData _appData) This function allows for some functionality to occur once the user has clicked on the Logoff link.
java.lang.String	OnFailedLogin(ApplicationData _appData, java.lang.String _strUserName, XPException _xpError) This function allows for some functionality to occur if a user should not login successfully.
Redirect	OnFailedLoginDoRedirect(ApplicationData _appData, java.lang.String _strUserName, XPException _xpError) This function allows for some functionality to occur if a user should not login successfully and then possibly do a redirect to someplace other than the standard Login page.
java.lang.String	toString() This method is overridden so that when we try to display the contents of the PEI lists we get an appropriate value instead of just seeing wrapper objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_LoginActionsPEI

protected ILoginActions m_LoginActionsPEI

m_LoginActions2PEI

protected ILoginActions2 m_LoginActions2PEI

Constructor Detail

LoginPEIContainer

public LoginPEIContainer(ILoginActions _pei)

Method Detail

OnFailedLoginDoRedirect

public Redirect OnFailedLoginDoRedirect(ApplicationData _appData,
                                        java.lang.String _strUserName,
                                        XPException _xpError)

Description copied from interface: ILoginActions2

This function allows for some functionality to occur if a user should not login successfully and then possibly do a redirect to someplace other than the standard Login page.

Specified by:

OnFailedLoginDoRedirect in interface ILoginActions2

Parameters:

_appData - - This parameter provides access to some of the application data that would normally be available through the current Activity Space

_strUserName - - This is the name of the user who failed on login..

_xpError - - the error that caused login to fail. May be null

Returns:

Redirect - Location that the User will be redirected after the functionality has completed.

See Also:

com.plumtree.uiinfrastructure.pei.ILoginActions2#OnFailedLoginDoRedirect(com.plumtree.uiinfrastructure.login.ApplicationData, java.lang.String, com.plumtree.openfoundation.util.XPException)

OnAfterLogin

public Redirect OnAfterLogin(java.lang.Object _oUserSession,
                             ApplicationData _appData)

Description copied from interface: ILoginActions

This function allows for some functionality to occur once the user has successfully logged in and then possibly do a redirect to someplace other than the MyPage.

Specified by:

OnAfterLogin in interface ILoginActions

Parameters:

_oUserSession - - Session object for the current user

_appData - - This parameter provides access to some of the application data that would normally be available through the current Activity Space

Returns:

Redirect - Location that the User will be redirected after the functionality has completed. This redirect will be ignored if we are attempting to login the guest user.

See Also:

ILoginActions.OnAfterLogin(java.lang.Object, com.plumtree.uiinfrastructure.login.ApplicationData)

OnBeforeLogout

public Redirect OnBeforeLogout(java.lang.Object _oUserSession,
                               ApplicationData _appData)

Description copied from interface: ILoginActions

This function allows for some functionality to occur once the user has clicked on the Logoff link. This is not called when the guest user is logged off in order to log in a normal user. This method is also not called when a user session is timed out by the application server. It is only called when a user clicks directly on the logout link.

Specified by:

OnBeforeLogout in interface ILoginActions

Parameters:

_oUserSession - - Session object for the current user

_appData - - This parameter provides access to some of the application data that would normally be available through the current Activity Space

Returns:

Redirect - Location that the User will be redirected after the functionality has completed.

See Also:

ILoginActions.OnBeforeLogout(java.lang.Object, com.plumtree.uiinfrastructure.login.ApplicationData)

OnBeforeLogin

public Redirect OnBeforeLogin(ApplicationData _appData,
                              java.lang.String _strUserName)

Description copied from interface: ILoginActions

This functions allows for some functionality to occur before the user has logged in to the Portal.

WARNING: The user name in argument (_strUserName) will be empty if this is an auto-login. It will have a valid value in all other cases (through the Login Page, SSO Login, Guest Login).

Specified by:

OnBeforeLogin in interface ILoginActions

Parameters:

_appData - - This parameter provides access to some of the application data that would normally be available through the current Activity Space

_strUserName - - This is the name of the user that is about to log in. This is blank if this is an auto-login. It will be "Guest" if it is the guest user (This value will always be the same, even if you rename the guest user).

Returns:

Redirect - Location that the User will be redirected after the functionality has completed. This redirect will be ignored if we are attempting to login the guest user and it is an internal redirect (These kinds of redirects should be done from OnAfterLogin since you can't access the portal if you're not even logged in as Guest).

See Also:

ILoginActions.OnBeforeLogin(com.plumtree.uiinfrastructure.login.ApplicationData, java.lang.String)

OnFailedLogin

public java.lang.String OnFailedLogin(ApplicationData _appData,
                                      java.lang.String _strUserName,
                                      XPException _xpError)

Description copied from interface: ILoginActions

This function allows for some functionality to occur if a user should not login successfully. NOTE: To return a Redirect object on a failed login event, implement the ILoginActions2 interface instead in your LoginActions PEI, and use the OnFailedLoginDoRedirect method. PEIs implementing the ILoginActions2 interface are loaded exactly the same as PEIs implementing the ILoginActions interface. If a FailedLoginRedirect is returned by OnFailedLoginDoRedirect, then the error message returned by this method may or may not be displayed, depending upon where the user is redirected to.

Specified by:

OnFailedLogin in interface ILoginActions

Parameters:

_appData - - This parameter provides access to some of the application data that would normally be available through the current Activity Space

_strUserName - - This is the name of the user who failed on login..

_xpError - - the error that caused login to fail. May be null

Returns:

String - Any kind of specialized error message that needs to be returned to the user because of the failed login. This will override the error message from the exception it is not null or "".

See Also:

com.plumtree.uiinfrastructure.pei.ILoginActions#OnFailedLogin(com.plumtree.uiinfrastructure.login.ApplicationData, java.lang.String, com.plumtree.openfoundation.util.XPException)

toString

public java.lang.String toString()

This method is overridden so that when we try to display the contents of the PEI lists we get an appropriate value instead of just seeing wrapper objects.

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()