Package com.mendix.core.action.user

Class LoginAction

java.lang.Object

com.mendix.core.actionmanagement.internal.InternalCoreAction<R>

com.mendix.core.actionmanagement.CoreAction<R>

com.mendix.systemwideinterfaces.core.UserAction<ISession>

com.mendix.core.action.user.LoginAction

All Implemented Interfaces:

ICoreAction<ISession>, java.util.concurrent.Callable<ISession>

public class LoginAction
extends UserAction<ISession>

Represents an action that will perform a login when executed.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CURRENT_REQUEST
static java.lang.String	CURRENT_SESSION_ID_PARAM
static java.lang.String	PASSWORD_PARAM
static java.lang.String	SESSION_MANAGER_PARAM
static java.lang.String	USER_NAME_PARAM

Constructor Summary

Constructors

Constructor	Description
LoginAction(IContext context, java.util.Map<java.lang.String,? extends java.lang.Object> params)	Creates a login action with a context and parameters.

Method Summary

Modifier and Type	Method	Description
ISession	executeAction()	Implement this method, this method will be called when this action is executed.
java.lang.String	getUserName()	Returns the username of this login action.

Methods inherited from class com.mendix.systemwideinterfaces.core.UserAction

context, execute

Methods inherited from class com.mendix.core.actionmanagement.CoreAction

getUnwrappedAction

Methods inherited from class com.mendix.core.actionmanagement.internal.InternalCoreAction

addDatavalidationFeedback, addDataValidationFeedback, call, clone, getActionName, getClonedContext, getContext, getEventObjects, getException, getMetaInfo, getState, handleConcurrentExecution, setActionName, setAllowsConcurrentExecution, setContext, setEventObjects, setException, setMetaInfo, setState

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_MANAGER_PARAM

public static final java.lang.String SESSION_MANAGER_PARAM

See Also:

Constant Field Values

USER_NAME_PARAM

public static final java.lang.String USER_NAME_PARAM

See Also:

Constant Field Values

PASSWORD_PARAM

public static final java.lang.String PASSWORD_PARAM

See Also:

Constant Field Values

CURRENT_SESSION_ID_PARAM

public static final java.lang.String CURRENT_SESSION_ID_PARAM

See Also:

Constant Field Values

CURRENT_REQUEST

public static final java.lang.String CURRENT_REQUEST

See Also:

Constant Field Values

Constructor Detail

LoginAction

public LoginAction(IContext context,
                   java.util.Map<java.lang.String,? extends java.lang.Object> params)

Creates a login action with a context and parameters.

The parameters can contain the following values (the userName and password are mandatory; the others are optional):

• userName - the name of the user (mandatory)
• password - the password of the user (mandatory)
• currentSessionId - the ID of the session to reuse for this login instead of creating a new one
• request - the current runtime request (of type IMxRuntimeRequest), which is used for logging the origin of the login

Parameters:

context - the context for executing the action and checking access

params - the parameters for the login action, which must include userName and password

Method Detail

executeAction

public ISession executeAction()
                       throws java.lang.Exception

Description copied from class: UserAction

Implement this method, this method will be called when this action is executed.

Specified by:

executeAction in class UserAction<ISession>

Returns:

returns the result of the execution

Throws:

java.lang.Exception

getUserName

public java.lang.String getUserName()

Returns the username of this login action.

Returns:

the name of the user to login