|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.userprofiling.ProfileRequest
public class ProfileRequest
This represents Profile information associated with a request in an HTTP-specific usage of profiles. This contains information about how the request was associated with that Profile, including what profile id was requested and how that id was requested.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected java.lang.Object |
mRequestedId
Returns the object used in the attempt to request a profile. |
protected int |
mRequestSource
An identifier signifying where the request for a profile originated from. |
protected int |
mStatus
An identifier signifying the status of the profile for this request. |
static int |
PRFSRC_BASICAUTH
Profile request came from HTTP Basic Authentication. |
static int |
PRFSRC_CERTIFICATE
Profile request came from a X.509 Certificate. |
static int |
PRFSRC_COOKIE
Profile request came from a cookie. |
static int |
PRFSRC_NONE
No source in the request for a profile. |
static int |
PRFSRC_URL
Profile request came from a URL parameter, including form submissions. |
static int |
PRFSTATUS_ERROR
There was some error during the request for the profile. |
static int |
PRFSTATUS_NEW
The profile is new. |
static int |
PRFSTATUS_OLD
The profile is old. |
static int |
PRFSTATUS_REFUSED
A ProfileRequestFilter denied the creation of a new profile. |
static int |
PRFSTATUS_UNKNOWN
The profile status is unknown. |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.userprofiling.ProfileRequestConstants |
---|
PROFILE_PARAMETER_NAME, PROFILE_VERFICATION_PARAMETER_NAME |
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 | |
---|---|
ProfileRequest()
Constructs an instanceof ProfileRequest |
Method Summary | |
---|---|
void |
doStartService()
Invokes the service method to initialize the object |
protected java.lang.String |
extractId(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns the user id for a profile from the given request. |
CookieManager |
getCookieManager()
Returns property CookieManager |
DynamoHttpServletRequest |
getOriginatingRequest()
Returns property OriginatingRequest |
java.lang.Object |
getRequestedId()
Returns the object used in the attempt to request a profile. |
int |
getRequestSource()
Returns an identifier signifying where the request for a profile originated from. |
int |
getStatus()
Returns an identifier signifying the status the profile for this request. |
boolean |
isExtractProfileFromBasicAuthentication()
Returns property ExtractProfileFromBasicAuthentication |
boolean |
isExtractProfileFromCookieParameter()
Returns property ExtractProfileFromCookieParameter |
boolean |
isExtractProfileFromPostParameter()
Returns property ExtractProfileFromPostParameter |
boolean |
isExtractProfileFromQueryParameter()
Returns property ExtractProfileFromQueryParameter |
boolean |
isExtractProfileFromURLParameter()
Returns property ExtractProfileFromURLParameter |
boolean |
isRequestInvalid()
Returns true if the request for a profile was invalid. |
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Decodes the necessary information out of the request and fills the appropriate properties |
void |
setCookieManager(CookieManager pCookieManager)
Sets property CookieManager |
void |
setExtractProfileFromBasicAuthentication(boolean pExtractProfileFromBasicAuthentication)
Sets property ExtractProfileFromBasicAuthentication |
void |
setExtractProfileFromCookieParameter(boolean pExtractProfileFromCookieParameter)
Sets property ExtractProfileFromCookieParameter |
void |
setExtractProfileFromPostParameter(boolean pExtractProfileFromPostParameter)
Sets property ExtractProfileFromPostParameter |
void |
setExtractProfileFromQueryParameter(boolean pExtractProfileFromQueryParameter)
Sets property ExtractProfileFromQueryParameter |
void |
setExtractProfileFromURLParameter(boolean pExtractProfileFromURLParameter)
Sets property ExtractProfileFromURLParameter |
void |
setOriginatingRequest(DynamoHttpServletRequest pOriginatingRequest)
Sets property OriginatingRequest |
void |
setRequestInvalid(boolean pRequestInvalid)
Sets property RequestInvalid |
void |
setStatusCode(int pCode)
A "property setter" for the status
property which is only available by other profiler classes. |
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 |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final int PRFSRC_NONE
0
#getProfileRequestSource
,
Constant Field Valuespublic static final int PRFSRC_COOKIE
1
#getProfileRequestSource
,
Constant Field Valuespublic static final int PRFSRC_URL
2
#getProfileRequestSource
,
Constant Field Valuespublic static final int PRFSRC_BASICAUTH
3
#getProfileRequestSource
,
Constant Field Valuespublic static final int PRFSRC_CERTIFICATE
4
#getProfileRequestSource
,
Constant Field Valuespublic static final int PRFSTATUS_UNKNOWN
0
#getProfileStatus
,
Constant Field Valuespublic static final int PRFSTATUS_NEW
1
#getProfileStatus
,
Constant Field Valuespublic static final int PRFSTATUS_OLD
2
#getProfileStatus
,
Constant Field Valuespublic static final int PRFSTATUS_REFUSED
3
#getProfileStatus
,
Constant Field Valuespublic static final int PRFSTATUS_ERROR
4
#getProfileStatus
,
Constant Field Valuesprotected java.lang.Object mRequestedId
requestedId
property.
getRequestedId()
protected int mRequestSource
requestSource
property.
Default value is PRFSRC_NONE;
PRFSRC_NONE
,
PRFSRC_COOKIE
,
PRFSRC_URL
,
PRFSRC_BASICAUTH
,
PRFSRC_CERTIFICATE
,
getRequestSource
protected int mStatus
status
property.
PRFSTATUS_NEW
,
PRFSTATUS_OLD
,
getStatus()
Constructor Detail |
---|
public ProfileRequest()
Method Detail |
---|
public int getStatus()
PRFSTATUS_NEW
,
PRFSTATUS_OLD
public void setStatusCode(int pCode)
status
property which is only available by other profiler classes.
public java.lang.Object getRequestedId()
public void setRequestInvalid(boolean pRequestInvalid)
public boolean isRequestInvalid()
public int getRequestSource()
PRFSRC_NONE
,
PRFSRC_COOKIE
,
PRFSRC_URL
,
PRFSRC_BASICAUTH
,
PRFSRC_CERTIFICATE
public void setOriginatingRequest(DynamoHttpServletRequest pOriginatingRequest)
public DynamoHttpServletRequest getOriginatingRequest()
public void setCookieManager(CookieManager pCookieManager)
public CookieManager getCookieManager()
public void setExtractProfileFromQueryParameter(boolean pExtractProfileFromQueryParameter)
public boolean isExtractProfileFromQueryParameter()
public void setExtractProfileFromPostParameter(boolean pExtractProfileFromPostParameter)
public boolean isExtractProfileFromPostParameter()
public void setExtractProfileFromURLParameter(boolean pExtractProfileFromURLParameter)
public boolean isExtractProfileFromURLParameter()
public void setExtractProfileFromCookieParameter(boolean pExtractProfileFromCookieParameter)
public boolean isExtractProfileFromCookieParameter()
public void setExtractProfileFromBasicAuthentication(boolean pExtractProfileFromBasicAuthentication)
public boolean isExtractProfileFromBasicAuthentication()
public void doStartService() throws ServiceException
service
method to initialize the object
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
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 java.lang.String extractId(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 |