com.plumtree.uiinfrastructure.activityspace
Interface ILoginControl

All Superinterfaces:

IControl, IManagedObject, IMVCObject

All Known Implementing Classes:

CreateAccountControl, DefaultLoginControl, EditDefaultProfileRepostControl, LoginControl, LoginDevicesControl, SetEditDefaultProfileControl

public interface ILoginControl
extends IControl

This interface should only be implemented to provide login functionality for the portal. This is a special case.

Author:

Don Hayler

Method Summary

boolean	DoGetSession() This method is called by the Interpreter to determine whether or not to subsequently call GetSession and perform login/logout code.
java.lang.Object	GetSession() This method is called by the Interpreter after calling Execute on the LoginControl.
void	SetRedirectForUseAfterLogin(Redirect r) This method sets a redirect on the login control for use after a successful login.

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IControl

CheckActionSecurityAndExecute, Init

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject

GetName

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IManagedObject

Create

Method Detail

DoGetSession

boolean DoGetSession()

This method is called by the Interpreter to determine whether or not to subsequently call GetSession and perform login/logout code. If this returns false, the session will remain unchanged.

Returns:

boolean true implies GetSession() will be called

GetSession

java.lang.Object GetSession()

This method is called by the Interpreter after calling Execute on the LoginControl. The User Session returned will be stored on the user's HTTPSession. If null is returned, the user's session will be removed from the HTTPSession for logout.

Returns:

Object null implies logoff session implies login as this session

SetRedirectForUseAfterLogin

void SetRedirectForUseAfterLogin(Redirect r)

This method sets a redirect on the login control for use after a successful login. This allows a user to be bounced from a page if they are not logged in, and then return to that page after they log in.

Parameters:

Redirect - the space the original URL pointed to.