com.wrq.vhi.script.api

Interface AuthenticateUserEvent

All Superinterfaces:

Event, LifeCycleEvent

public interface AuthenticateUserEvent
extends LifeCycleEvent

Authenticate user event information.

See Also:

LifeCycleEventHandler.authenticateUser(com.wrq.vhi.script.api.AuthenticateUserEvent)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPassword() Gets the password provided in the connection request.
java.lang.String	getUser() Gets the username provided in the connection request.
java.util.Set	getVariableNames() Gets the names of the model variables.
java.lang.String	getVariableValue(java.lang.String name) Gets the value of a model variable.
void	setVariableValue(java.lang.String name, java.lang.String value) Changes the value of a model variable.

Methods inherited from interface com.wrq.vhi.script.api.LifeCycleEvent

getModelContext

Methods inherited from interface com.wrq.vhi.script.api.Event

checkForTimeout, createErrorMessage, createErrorMessage, createHostSession, createUserErrorMessage, getEventStack, getHandlerProperty, getLogger, isDesignEnvironment

Method Detail

getUser

java.lang.String getUser()

Gets the username provided in the connection request.

Returns:

username

getPassword

java.lang.String getPassword()

Gets the password provided in the connection request.

Returns:

password

getVariableNames

java.util.Set getVariableNames()

Gets the names of the model variables.

Returns:

list of variable names (String objects)

getVariableValue

java.lang.String getVariableValue(java.lang.String name)
                           throws ApptrieveException

Gets the value of a model variable.

Parameters:

name - the variable name

Returns:

the variable value

Throws:

ApptrieveException - if the variable is not defined in the model

setVariableValue

void setVariableValue(java.lang.String name,
                      java.lang.String value)
               throws ApptrieveException

Changes the value of a model variable.

Parameters:

name - the variable name

value - the variable value

Throws:

ApptrieveException - if the variable is not defined in the model or the variable is marked as read-only