planetj.dataengine.security.http
Class SignOnRequest

java.lang.Object
  planetj.magic.AbstractMagicRequest
      planetj.magic.MagicRequest
          planetj.dataengine.security.http.SignOnRequest

All Implemented Interfaces:

IFeature, IMagicRequest, java.io.Serializable

public class SignOnRequest

extends MagicRequest

A magic request for signing a user on to an application

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.dataengine.IFeature

IFeature.OperationCountFeature

Field Summary

Fields inherited from interface planetj.magic.IMagicRequest

IS_COMPLETE, MAGIC_REQUEST, MAGIC_REQUEST_CLASS, MAGIC_REQUEST_PARAM1, MAGIC_REQUEST_RC, SAME_URI, TYPE, TYPE_PAGE, TYPE_SESSION, TYPE_STATIC, USER_REQUEST_ATTRIBUTES_STORED

Fields inherited from interface planetj.dataengine.IFeature

DEFAULT_MESSAGE_FEATURE, FEATURE_DELETE, FEATURE_INSERT, FEATURE_LEVEL_ENTERPRISE, FEATURE_LEVEL_ENTRY, FEATURE_LEVEL_PROFESSIONAL, FEATURE_LEVEL_STANDARD, FEATURE_UPDATE, MESSAGE_END, MESSAGE_START

Constructor Summary

SignOnRequest(ISecured secured, HttpServletRequest request, HttpServletResponse response)
SignOnRequest constructor comment.

SignOnRequest(java.lang.String id, ISecured secured, HttpServletRequest request, HttpServletResponse response)
Deprecated. - id no longer needed

Method Summary

java.lang.StringBuffer	appendUnsupportedHTMLMessage(java.lang.StringBuffer html) Appends the default unsupported message
IMagicRequest	execute(HttpServletRequest request, HttpServletResponse response, DataEngineServlet servlet) Signs the user on to the current Application
int	getFeatureLevel() Gets the minimum feature level requried to execute this operation
void	setNextURI(java.lang.String uri) Set the URI of the next page to call.
void	setSecured(ISecured secured, HttpServletRequest request)

Methods inherited from class planetj.magic.MagicRequest

getCurrentMagicRequest, getPrimaryMagicRequest, getType, store

Methods inherited from class planetj.magic.AbstractMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, changeMode, clone, clone, equals, executeAll, getAnchorName, getBaseField, getBaseRow, getBaseRowCollection, getCurrentURI, getDefaultEndNavigationGroup, getDefaultPageType, getFailMessage, getFirstRequest, getId, getKey, getLastRequest, getMagicRequestParameter, getMagicServletURI, getMagicURI, getNextURI, getPleaseWaitJSP, getPleaseWaitOperation, getRequestAttribute, getRequestParameter, getRequestParameterValues, getSessionAttribute, getSharedSessionAttribute, getSuccessMessage, hasLinkedRequestsAfter, hasLinkedRequestsBefore, isApplicable, isCompleted, isEndNavigationGroup, isLoadParameterValuesFromRequest, isOverridePrimaryNavigation, isPleaseWait, isPopup, isRepeatable, isReturnToRequester, isSaveResults, isStartNewNavigationGroup, postexecute, postExecute, preexecute, preExecute, processPleaseWait, removeRequestAttribute, removeSessionAttribute, removeSharedSessionAttribute, setAnchorName, setBaseField, setBaseRow, setBaseRowCollection, setCompleted, setEndNavigationGroup, setFailMessage, setId, setLoadParameterValuesFromRequest, setNextURI, setNextURI, setNextURIs, setOverridePrimaryNavigation, setPopup, setRepeatable, setRequestGroupAttribute, setRequestPageAttribute, setRequestPersistentAttribute, setRequestTransientAttribute, setReturnToRequester, setRowEventListener, setSessionAttribute, setSessionSharedAttribute, setStartNewNavigationGroup, setSuccessMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface planetj.magic.IMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, executeAll, getBaseField, getBaseRow, getCurrentURI, getFirstRequest, getId, getKey, getLastRequest, getMagicRequestParameter, getMagicURI, getNextURI, isCompleted, isEndNavigationGroup, isOverridePrimaryNavigation, isRepeatable, isReturnToRequester, isSaveResults, isStartNewNavigationGroup, postExecute, preExecute, setBaseField, setBaseRow, setBaseRowCollection, setEndNavigationGroup, setNextURI, setOverridePrimaryNavigation, setRepeatable, setRowEventListener, setStartNewNavigationGroup

Methods inherited from interface planetj.dataengine.IFeature

isApplicable

Constructor Detail

SignOnRequest

public SignOnRequest(ISecured secured,
                     HttpServletRequest request,
                     HttpServletResponse response)

SignOnRequest constructor comment.

SignOnRequest

public SignOnRequest(java.lang.String id,
                     ISecured secured,
                     HttpServletRequest request,
                     HttpServletResponse response)

Deprecated. - id no longer needed

SignOnRequest constructor comment.

Method Detail

appendUnsupportedHTMLMessage

public java.lang.StringBuffer appendUnsupportedHTMLMessage(java.lang.StringBuffer html)

Appends the default unsupported message

Specified by:

appendUnsupportedHTMLMessage in interface IFeature

Overrides:

appendUnsupportedHTMLMessage in class AbstractMagicRequest

execute

public IMagicRequest execute(HttpServletRequest request,
                             HttpServletResponse response,
                             DataEngineServlet servlet)
                      throws CMException

Signs the user on to the current Application

Specified by:

execute in interface IMagicRequest

Specified by:

execute in class AbstractMagicRequest

Throws:

CMException

getFeatureLevel

public int getFeatureLevel()

Gets the minimum feature level requried to execute this operation

Specified by:

getFeatureLevel in interface IFeature

Overrides:

getFeatureLevel in class AbstractMagicRequest

setNextURI

public void setNextURI(java.lang.String uri)

Set the URI of the next page to call. This method counters any template pages previously set. When the magic request finishes executing, the uri parameter will be called. If the uri should be included in a template, then setNextURI(String, String) should be called.

Overrides:

setNextURI in class AbstractMagicRequest

setSecured

public void setSecured(ISecured secured,
                       HttpServletRequest request)