org.olat.core.gui
Class UserRequest

java.lang.Object
  org.olat.core.gui.UserRequest

public class UserRequest
extends java.lang.Object

is the "thing" generated by one user-click. It contains mainly the servlet request and response and the usersession, and it should not be assigned to an instance variable.

Author:

Felix Jost

Field Summary

static java.lang.String

PARAM_DELIM PARAM_DELIM

Constructor Summary

UserRequest(java.lang.String uriPrefix, javax.servlet.http.HttpServletRequest httpReq, javax.servlet.http.HttpServletResponse httpResp)

Method Summary

java.lang.String	getComponentID() Only getter provided.
java.lang.String	getComponentTimestamp()
DispatchResult	getDispatchResult()
javax.servlet.http.HttpServletRequest	getHttpReq()
javax.servlet.http.HttpServletResponse	getHttpResp()
Identity	getIdentity() convenience method
java.util.Locale	getLocale() convenience method
int	getMode()
java.lang.String	getModuleURI()
java.lang.String	getNonParsedUri()
java.lang.String	getParameter(java.lang.String key)
java.util.Set	getParameterSet()
java.lang.String	getTimestampID() Only getter provided.
UserSession	getUserSession()
java.lang.String	getWindowID() Only getter provided.
boolean	isValidDispatchURI()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PARAM_DELIM

public static final java.lang.String PARAM_DELIM

PARAM_DELIM

See Also:

Constant Field Values

Constructor Detail

UserRequest

public UserRequest(java.lang.String uriPrefix,
                   javax.servlet.http.HttpServletRequest httpReq,
                   javax.servlet.http.HttpServletResponse httpResp)

Parameters:

uriPrefix -

httpReq -

httpResp -

Method Detail

getParameter

public java.lang.String getParameter(java.lang.String key)

Parameters:

key -

Returns:

the value of the parameter with key 'key'

getParameterSet

public java.util.Set getParameterSet()

Returns:

the Set of parameters

getHttpReq

public javax.servlet.http.HttpServletRequest getHttpReq()

Returns:

the http request

getUserSession

public UserSession getUserSession()

Returns:

the usersession

getHttpResp

public javax.servlet.http.HttpServletResponse getHttpResp()

Returns:

HttpServletResponse

getLocale

public java.util.Locale getLocale()

convenience method

Returns:

Locale

getIdentity

public Identity getIdentity()

convenience method

Returns:

Subject

getModuleURI

public java.lang.String getModuleURI()

Returns:

String

getWindowID

public java.lang.String getWindowID()

Only getter provided. User URLBuilder to set the resulting respond's windowID.

Returns:

the windowid

getTimestampID

public java.lang.String getTimestampID()

Only getter provided. User URLBuilder to set the resulting respond's timestampID.

Returns:

the timestamp

getComponentID

public java.lang.String getComponentID()

Only getter provided. User URLBuilder to set the resulting respond's componentID.

Returns:

the component id

getComponentTimestamp

public java.lang.String getComponentTimestamp()

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

isValidDispatchURI

public boolean isValidDispatchURI()

Returns:

true if the url containing the encoded params for timestamp, windowid, and component id; and false if the url was e.g. an url like /olat/auth/go/course

getNonParsedUri

public java.lang.String getNonParsedUri()

Returns:

the uri; never null, but may be an empty string

getDispatchResult

public DispatchResult getDispatchResult()

Returns:

Returns the dispatchResult.

getMode

public int getMode()

Returns:

Returns the mode.