|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectatg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.nucleus.TimedOperationService
atg.servlet.pipeline.PipelineableServletImpl
atg.servlet.pipeline.InsertableServletImpl
atg.userprofiling.ProfileRequestServlet
public class ProfileRequestServlet
Field Summary | |
---|---|
static java.lang.String |
AUTO_LOGIN_FLAG
value: AutoLogin The default name used to access the AllowAutoLogin flag. |
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
LOGOUT_PARAM
value: DPSLogout A parameter with this name will come in on the request directly after a logout.. |
static java.lang.String |
SEND_COOKIE_FLAG
value: SendCookie The default name used to access the SendCookie flag. |
protected static java.util.ResourceBundle |
sResourceBundle
|
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
ProfileRequestServlet()
Constructs an instanceof ProfileRequestServlet |
Method Summary | |
---|---|
void |
addDataListener(DataListener pListener)
Adds a listener to the list of data listeners |
void |
allowAutoLogin(javax.servlet.http.HttpServletRequest pRequest)
Allows this user's session to auto-login via URL paramater. |
void |
allowSendCookie(javax.servlet.http.HttpServletRequest pRequest)
Allows this user's session to send back a cookie. |
void |
disableAutoLogin(javax.servlet.http.HttpServletRequest pRequest)
Does not allow this user's session to auto-login via URL paramater. |
void |
disableSendCookie(javax.servlet.http.HttpServletRequest pRequest)
Does not allow this user's session to send back a cookie Binds Boolean.FALSE in the session to the key defined by the constant SEND_COOKIE_FLAG , |
protected void |
expireProfileCookies(Profile pProfile,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Expire any cookies associated with the given profile |
int |
getDataListenerCount()
Returns the number of data listeners |
DataListener[] |
getDataListeners()
Returns the list of data listeners as an array property |
java.lang.String |
getNewProfileType()
Returns property NewProfileType |
protected Profile |
getProfile(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns a Profile object for the user if one already exists. |
java.lang.String |
getProfilePath()
Returns property ProfilePath |
protected ProfileRequest |
getProfileRequest(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Constructs and configures a ProfileRequest |
java.lang.String |
getProfileRequestPath()
Returns property ProfileRequestPath |
atg.userprofiling.ProfileRequestProcessor[] |
getProfileRequestProcessors()
Returns property profileRequestProcessors |
ProfileRequestTools |
getProfileRequestTools()
Returns property ProfileRequestTools |
ProfileTools |
getProfileTools()
Returns property ProfileTools |
protected boolean |
initializeNewProfile(Profile pProfile,
ProfileRequest pProfileRequest,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Initializes the Profile object by extracting the correct information out of the ProfileRequest |
protected boolean |
initializeProfile(Profile pProfile,
ProfileRequest pProfileRequest,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Initializes the Profile. |
protected boolean |
initializeProfileFromRequest(Profile pProfile,
ProfileRequest pProfileRequest,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Initializes the Profile object by extracting the correct information out of the ProfileRequest |
protected boolean |
initProfileAfterAutoLogin(Profile pProfile,
ProfileRequest pProfileRequest,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Initialize the profile after an auto-login operation has occured. |
protected boolean |
initUserAfterAutoLogin(Profile pProfile,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Initialize the User object after an auto-login operation has occured, populating the User object with appropriate persona. |
boolean |
isAllowAutoLogin(javax.servlet.http.HttpServletRequest pRequest)
Returns true if the session associated with this request is allowed to auto-login |
boolean |
isBuildProfile()
Returns property BuildProfile |
boolean |
isPersistAfterLogout()
|
boolean |
isPersistentAnonymousProfiles()
|
boolean |
isSendCookie(javax.servlet.http.HttpServletRequest pRequest)
Returns true if the session associated with this request is allowed to send a cookie |
boolean |
isSendCookie(Profile pProfile)
Returns true is the profile wants cookies sent |
boolean |
isSendLoginEventForNewPersistentAnonymousProfiles()
|
boolean |
isVerifyBasicAuthentication()
Returns property VerifyBasicAuthentication |
void |
removeDataListener(DataListener pListener)
Removes a listener from the list of data listeners |
void |
sendDataItem(java.lang.Object pDataItem)
Sends a data item to all of the listeners |
protected void |
sendProfileCookies(Profile pProfile,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Sends any cookies associated with the given profile |
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Attaches the profile to the request/session, sends any profile cookies, then passes the request onto the next servlet |
protected void |
serviceProfilingRequest(Profile pProfile,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Builds and places the profile into the Nucleus namespace for later retrieval. |
void |
setBuildProfile(boolean pBuildProfile)
Sets property BuildProfile |
void |
setNewProfileType(java.lang.String pNewProfileType)
Sets property NewProfileType |
void |
setPersistAfterLogout(boolean pPersistAfterLogout)
Sets the property PersistAfterLogout. |
void |
setPersistentAnonymousProfiles(boolean pPersistentAnonymousProfiles)
Sets the property PersistentAnonymousProfiles. |
void |
setProfilePath(java.lang.String pProfilePath)
Sets property ProfilePath |
void |
setProfileRequestPath(java.lang.String pProfileRequestPath)
Sets property ProfileRequestPath |
void |
setProfileRequestProcessors(atg.userprofiling.ProfileRequestProcessor[] pProfileRequestProcessors)
Sets property profileRequestProcessors |
void |
setProfileRequestTools(ProfileRequestTools pProfileRequestTools)
Sets property ProfileRequestTools |
void |
setProfileTools(ProfileTools pProfileTools)
Sets property ProfileTools |
void |
setSendLoginEventForNewPersistentAnonymousProfiles(boolean pSendEvent)
Sets the property sendLoginEventForNewPersistentAnonymousProfiles. |
void |
setVerifyBasicAuthentication(boolean pVerifyBasicAuthentication)
Sets property VerifyBasicAuthentication |
protected void |
verifyBasicAuthentication(Profile pProfile,
ProfileRequest pProfileRequest,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Checks to make sure the login name for the given profile matches the currently required login for Basic Authentication. |
Methods inherited from class atg.servlet.pipeline.InsertableServletImpl |
---|
doStartService, getInsertAfterServlet, setInsertAfterServlet |
Methods inherited from class atg.servlet.pipeline.PipelineableServletImpl |
---|
createAdminServlet, destroy, getAdminServlet, getNextServlet, getServletConfig, getServletInfo, init, isUsePathInfo, passRequest, passRequest, service, service, setNextServlet, setServletInfo, setUsePathInfo |
Methods inherited from class atg.nucleus.TimedOperationService |
---|
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface atg.servlet.pipeline.PipelineableServlet |
---|
getNextServlet, passRequest, setNextServlet |
Methods inherited from interface javax.servlet.Servlet |
---|
destroy, getServletConfig, getServletInfo, init, service |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final java.lang.String LOGOUT_PARAM
value: DPSLogout
public static final java.lang.String AUTO_LOGIN_FLAG
value: AutoLogin
public static final java.lang.String SEND_COOKIE_FLAG
value: SendCookie
protected static java.util.ResourceBundle sResourceBundle
Constructor Detail |
---|
public ProfileRequestServlet()
Method Detail |
---|
public void setBuildProfile(boolean pBuildProfile)
public boolean isBuildProfile()
public void setProfileRequestPath(java.lang.String pProfileRequestPath)
public java.lang.String getProfileRequestPath()
public void setProfilePath(java.lang.String pProfilePath)
public java.lang.String getProfilePath()
public void setNewProfileType(java.lang.String pNewProfileType)
public java.lang.String getNewProfileType()
public void setProfileTools(ProfileTools pProfileTools)
public ProfileTools getProfileTools()
public void setProfileRequestTools(ProfileRequestTools pProfileRequestTools)
public ProfileRequestTools getProfileRequestTools()
public void setVerifyBasicAuthentication(boolean pVerifyBasicAuthentication)
public boolean isVerifyBasicAuthentication()
public void setPersistentAnonymousProfiles(boolean pPersistentAnonymousProfiles)
public boolean isPersistentAnonymousProfiles()
public void setPersistAfterLogout(boolean pPersistAfterLogout)
public boolean isPersistAfterLogout()
public void setSendLoginEventForNewPersistentAnonymousProfiles(boolean pSendEvent)
public boolean isSendLoginEventForNewPersistentAnonymousProfiles()
public void sendDataItem(java.lang.Object pDataItem)
public void addDataListener(DataListener pListener)
public void removeDataListener(DataListener pListener)
public DataListener[] getDataListeners()
public int getDataListenerCount()
public void setProfileRequestProcessors(atg.userprofiling.ProfileRequestProcessor[] pProfileRequestProcessors)
profileRequestProcessors
pProfileRequestProcessors
- a list of processors that run
before and after the profile request has determined the profilepublic atg.userprofiling.ProfileRequestProcessor[] getProfileRequestProcessors()
profileRequestProcessors
public void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
service
in class PipelineableServletImpl
javax.servlet.ServletException
- if an error occurred while processing
the servlet request
java.io.IOException
- if an error occurred while reading or writing
the servlet requestprotected void serviceProfilingRequest(Profile pProfile, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
protected void sendProfileCookies(Profile pProfile, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
protected void expireProfileCookies(Profile pProfile, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
protected ProfileRequest getProfileRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
protected Profile getProfile(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
protected boolean initializeProfile(Profile pProfile, ProfileRequest pProfileRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
protected boolean initializeProfileFromRequest(Profile pProfile, ProfileRequest pProfileRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
protected boolean initProfileAfterAutoLogin(Profile pProfile, ProfileRequest pProfileRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
protected boolean initUserAfterAutoLogin(Profile pProfile, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
public void allowAutoLogin(javax.servlet.http.HttpServletRequest pRequest)
AUTO_LOGIN_FLAG
,
public void disableAutoLogin(javax.servlet.http.HttpServletRequest pRequest)
AUTO_LOGIN_FLAG
,
public boolean isAllowAutoLogin(javax.servlet.http.HttpServletRequest pRequest)
public void allowSendCookie(javax.servlet.http.HttpServletRequest pRequest)
SEND_COOKIE_FLAG
,
public void disableSendCookie(javax.servlet.http.HttpServletRequest pRequest)
SEND_COOKIE_FLAG
,
public boolean isSendCookie(javax.servlet.http.HttpServletRequest pRequest)
public boolean isSendCookie(Profile pProfile)
protected void verifyBasicAuthentication(Profile pProfile, ProfileRequest pProfileRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
protected boolean initializeNewProfile(Profile pProfile, ProfileRequest pProfileRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |