de.hybris.platform.hmc

Class MainChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.MainChip

All Implemented Interfaces:

Chip, ExtraParamHandler, Serializable, Cloneable

public class MainChip
extends AbstractChip
implements ExtraParamHandler

Is the first chip in a session. Does display mainChip.jsp.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATE
static String	LOGIN_NOT_ALLOWED
static String	PASSWORD_PARAM
static String	SET_LOGIN
static String	SET_PASSWORD
static String	SET_REMEMBERME
static String	USER_PARAM

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip

CHIP_KEY, FALSE, FRAME_KEY, SHOW_JSP_COMMENTS, TRUE, USE_SOCKET_NAMING

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip

DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors

Constructor and Description
MainChip(DisplayState displayState, Chip parent)

Method Summary

Modifier and Type	Method and Description
Map	getExtraParams()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getPassword()
String	getUser()
void	handleExtraParams(Map extraParams) Deprecated. is no longer used, login via url is done in HMCMasterServlet
protected static boolean	hmcLoginDisabled(Collection<UserGroup> groups, Collection<UserGroup> visitedGroups)
static boolean	hmcLoginDisabled(User user)
boolean	isAutoLogin()
boolean	isLoggedIn()
boolean	isRememberMe()
void	processEvents(Map events) Handles all incoming requests for this chip.
void	setAutoLogin(boolean autoLogin)
void	setPassword(String string)
void	setUser(String string)
protected void	transferSession(JaloSession jaloSession, String login, String password) Performs the login by calling the JaloSession.transfer(Map, boolean) method.

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

addEventListener, checkValid, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueName, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, refresh, refreshChild, registerUniqueName, removeEventListener, removeInfoMessage, render, render, setClipboard, setParent, setRequestFocus, setValid, setWindowStatus, translateFormFieldToEventName, translateFormFieldToEventValue

Methods inherited from class java.lang.Object

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

Field Detail

CREATE

public static final String CREATE

See Also:

Constant Field Values

SET_LOGIN

public static final String SET_LOGIN

See Also:

Constant Field Values

SET_PASSWORD

public static final String SET_PASSWORD

See Also:

Constant Field Values

SET_REMEMBERME

public static final String SET_REMEMBERME

See Also:

Constant Field Values

USER_PARAM

public static final String USER_PARAM

See Also:

Constant Field Values

PASSWORD_PARAM

public static final String PASSWORD_PARAM

See Also:

Constant Field Values

LOGIN_NOT_ALLOWED

public static final String LOGIN_NOT_ALLOWED

See Also:

Constant Field Values

Constructor Detail

MainChip

public MainChip(DisplayState displayState,
                Chip parent)

Method Detail

isRememberMe

public boolean isRememberMe()

processEvents

public void processEvents(Map events)

Description copied from interface: Chip

Handles all incoming requests for this chip. Map contains name (String) and value (List of Strings)

Specified by:

processEvents in interface Chip

hmcLoginDisabled

public static boolean hmcLoginDisabled(User user)

hmcLoginDisabled

protected static boolean hmcLoginDisabled(Collection<UserGroup> groups,
                                          Collection<UserGroup> visitedGroups)

Since:

3.0 M2 and 3.0 M1-u4

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

Returns the URI of the JSP that this chip wants to use.

Specified by:

getJSPURI in interface Chip

handleExtraParams

@Deprecated
public void handleExtraParams(Map extraParams)

Deprecated. is no longer used, login via url is done in HMCMasterServlet

Tries to handle user and password parameters given via url.

Specified by:

handleExtraParams in interface ExtraParamHandler

isLoggedIn

public boolean isLoggedIn()

isAutoLogin

public boolean isAutoLogin()

setAutoLogin

public void setAutoLogin(boolean autoLogin)

getPassword

public String getPassword()

getUser

public String getUser()

setPassword

public void setPassword(String string)

setUser

public void setUser(String string)

getExtraParams

public Map getExtraParams()

transferSession

protected void transferSession(JaloSession jaloSession,
                               String login,
                               String password)
                        throws JaloSecurityException

Performs the login by calling the JaloSession.transfer(Map, boolean) method. Override this method if you want to customize the login procedure.

Throws:

JaloSecurityException

Since:

3.0M3