oracle.panama.portal
Class RequestController

java.lang.Object
  |
  +--oracle.panama.portal.RequestController

All Implemented Interfaces:

java.io.Serializable

public class RequestController

extends java.lang.Object

implements java.io.Serializable

RequestController handles request/session related operations. Each user session needs to be established by calling RequesetController.login. After the session is created, each following request needs to be initialized by calling RequestController.initRequest. RequestController.runService provides the functionality to run the current requested service. At the end of each session, RequestController.logout is called to invalidate current session.

See Also:

Serialized Form

Field Summary

Type	Field
static java.lang.String	PAPZ_DEVICE name string constant to identify portal device.
static java.lang.String	PASSWORD request url parameter name for passing password.
static java.lang.String	RESULTADAPTER request url PAt parameter value for view adapter result
static java.lang.String	RESULTDEVICE request url PAt parameter value for view adapter result
static java.lang.String	RESULTSIMPLE request url PAt parameter value for view simple result
static java.lang.String	RESULTTYPE request url PAt parameter name for view result
static java.lang.String	USERNAME request url parameter name for passing user name.
static java.lang.String	WML_DEVICE name string constant to identify wml device.
static Device	wmlDevice Device for wml device with device name of "WML11".

Method Summary

Type	Method
Request	checkSSOLogin(javax.servlet.http.HttpServletRequest request, long sessionDuration) Check the Single-Sign-On authentication
void	freeRequest(Request apiRequest) free Request and recycle db connections.
Device[]	getAvailableDevices() get all available Device
Session	getCurrentSession(javax.servlet.http.HttpServletRequest request) Get the current validated session.
static RequestController	getInstance() The singleton thread-safe getter.
java.lang.String	getLogicalDeviceEncoding() Get the current portal device encoding.
User	getLoginUser(Request request) Get Login User.
Request	initRequest(javax.servlet.http.HttpServletRequest request) Initialize Request and Session.
Request	login(javax.servlet.http.HttpServletRequest request, long sessionDuration) Login and authenticate user.
void	logout(javax.servlet.http.HttpServletRequest request) logout and invalidate the session.
java.lang.String	runService(Request apiRequest) Invoke the current requested service.
boolean	supportDeprecatedAlert() Check if support the deprecated alert / alert address
void	switchUser(Request request, java.lang.String userName) Switch user.
java.lang.String	testService(java.lang.String resultType, java.lang.String deviceIdString, javax.servlet.http.HttpServletRequest request) test the current requested service.

Methods inherited from class java.lang.Object

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

Field Detail

USERNAME

public static final java.lang.String USERNAME

request url parameter name for passing user name.

PASSWORD

public static final java.lang.String PASSWORD

request url parameter name for passing password.

RESULTTYPE

public static final java.lang.String RESULTTYPE

request url PAt parameter name for view result

RESULTSIMPLE

public static final java.lang.String RESULTSIMPLE

request url PAt parameter value for view simple result

RESULTADAPTER

public static final java.lang.String RESULTADAPTER

request url PAt parameter value for view adapter result

RESULTDEVICE

public static final java.lang.String RESULTDEVICE

request url PAt parameter value for view adapter result

PAPZ_DEVICE

public static final java.lang.String PAPZ_DEVICE

name string constant to identify portal device.

WML_DEVICE

public static final java.lang.String WML_DEVICE

name string constant to identify wml device.

wmlDevice

public static final Device wmlDevice

Device for wml device with device name of "WML11".

Method Detail

getInstance

public static RequestController getInstance()

The singleton thread-safe getter.

Returns:

the RequestController singleton interface.

checkSSOLogin

public Request checkSSOLogin(javax.servlet.http.HttpServletRequest request,
                             long sessionDuration)
                      throws PortalException

Check the Single-Sign-On authentication

Parameters:

request - the current HttpServletRequest.

sessionDuration - the session duration

Returns:

validated Request

login

public Request login(javax.servlet.http.HttpServletRequest request,
                     long sessionDuration)
              throws PortalException

Login and authenticate user. Invoked at the beginning of each session.

Parameters:

request - current HttpServletRequest.

sessionDuration - allowed time before session expires, in milliseconds, if value is -1, the session will not expire until the web server session expires.

Returns:

the current Request created for this HttpServeltRequest.

switchUser

public void switchUser(Request request,
                       java.lang.String userName)
                throws PortalException

Switch user. Only for Administrator & HelpDesk

Parameters:

request - current HttpServletRequest.

userName - the user name that is going to switch to.

getLoginUser

public User getLoginUser(Request request)
                  throws PortalException

Get Login User.

Parameters:

request - current Request.

Returns:

the current Logged in user object.

initRequest

public Request initRequest(javax.servlet.http.HttpServletRequest request)
                    throws PortalException

Initialize Request and Session. Invoked at the begining of each request.

Parameters:

request - current HttpServletRequest.

Returns:

validated Request.

freeRequest

public void freeRequest(Request apiRequest)

free Request and recycle db connections.

Parameters:

request - current Request.

logout

public void logout(javax.servlet.http.HttpServletRequest request)
            throws PortalException

logout and invalidate the session.

Parameters:

request - current HttpServletRequest.

getCurrentSession

public Session getCurrentSession(javax.servlet.http.HttpServletRequest request)
                          throws PortalException

Get the current validated session.

Parameters:

request - current HttpServletRequest.

Returns:

current validated Session.

getLogicalDeviceEncoding

public java.lang.String getLogicalDeviceEncoding()

Get the current portal device encoding.

Returns:

current portal encoding String.

runService

public java.lang.String runService(Request apiRequest)
                            throws PortalException

Invoke the current requested service. The current service is the service identified by the PAoid value in the request url.

Parameters:

apiRequest - current validated Request.

Returns:

the result string from invoking the current service.

testService

public java.lang.String testService(java.lang.String resultType,
                                    java.lang.String deviceIdString,
                                    javax.servlet.http.HttpServletRequest request)
                             throws PortalException,
                                    PanamaException

test the current requested service. The current service is the service identified by the PAoid value in the request url.

Parameters:

resultType - result type to identify it is Adapter Result, Simple Result or Device Result.

deviceIdString - device ID (used when requesting device result).

request - current HttpServletRequest.

Returns:

the result string from testing the current service.

getAvailableDevices

public Device[] getAvailableDevices()
                             throws PortalException

get all available Device

Parameters:

apiRequest - current validated Request.

Returns:

available Device array

supportDeprecatedAlert

public boolean supportDeprecatedAlert()

Check if support the deprecated alert / alert address

Returns:

the boolean value of system attribute "DeprecatedAlertSupport"