|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.infront.content.RequestParamUserStateBuilder
public class RequestParamUserStateBuilder
Builds UserState objects from parameter values present in the
HttpServletRequest
.
Field Summary | |
---|---|
protected String |
mDateParam
|
protected String |
mUserAgentParam
|
protected String |
mUserSegmentParam
|
Constructor Summary | |
---|---|
RequestParamUserStateBuilder()
|
Method Summary | |
---|---|
UserState |
createUserState(javax.servlet.http.HttpServletRequest request)
Returns a UserState object by parsing the information present in the
HttpServletRequest . |
protected String |
parseDate(javax.servlet.http.HttpServletRequest request)
Returns the date parameter value, using the parameter name set by setDateParam(String) . |
protected String |
parseUserAgent(javax.servlet.http.HttpServletRequest request)
Returns the user agent parameter value, using the parameter name set by setUserAgentParam(String) . |
protected String |
parseUserSegments(javax.servlet.http.HttpServletRequest request)
Returns the user segment parameter value, using the parameter name set by setUserSegmentsParam(String) . |
void |
setDateParam(String param)
Sets the name of the parameter used for obtaining the date information from the HttpServletRequest . |
void |
setUserAgentParam(String param)
Sets the name of the parameter used for obtaining the user agent information from the HttpServletRequest . |
void |
setUserSegmentsParam(String param)
Sets the name of the parameter used for obtaining the user segment information from the HttpServletRequest . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected String mUserSegmentParam
protected String mDateParam
protected String mUserAgentParam
Constructor Detail |
---|
public RequestParamUserStateBuilder()
Method Detail |
---|
public void setUserSegmentsParam(String param)
HttpServletRequest
. Note that the format of the user segments value
must be String
user segment names separated by pipe characters ('|'). For example,
"preferred|standard".
Note that if this class is being used in a production environment, it is highly
recommended that the user segment parameter be removed from the navigation URL by adding
the user segment parameter name to UrlNavigationStateBuilder.setRemoveAlways(java.util.List)
.
param
- a String
specifying the name of the user segment parameter.
If null, no user segment information will be read from the HttpServletRequest
.parseUserSegments(javax.servlet.http.HttpServletRequest)
public void setDateParam(String param)
HttpServletRequest
. Note that the format of the date value
must be recognizable by UserState.setDateAsString(String)
.
Note that if this class is being used in a production environment, it is highly
recommended that the user segment parameter be removed from the navigation URL by adding
the user segment parameter name to UrlNavigationStateBuilder.setRemoveAlways(java.util.List)
.
param
- a String
specifying the name of the date parameter.
If null, no date information will be read from the HttpServletRequest
.parseDate(javax.servlet.http.HttpServletRequest)
,
UserState.setDateAsString(String)
public void setUserAgentParam(String param)
HttpServletRequest
. Note that user agent must be properly encoded.
Note that if this class is being used in a production environment, it is highly
recommended that the user agent parameter be removed from the navigation URL by adding
the user agent parameter name to UrlNavigationStateBuilder.setRemoveAlways(java.util.List)
.
param
- a String
specifying the name of the user agent parameter.
If null, no user agent information will be read from the HttpServletRequest
.parseUserAgent(HttpServletRequest)
public UserState createUserState(javax.servlet.http.HttpServletRequest request) throws ContentException
UserState
object by parsing the information present in the
HttpServletRequest
.
ContentException
- if the date cannot be parsed into a Date
.protected String parseUserSegments(javax.servlet.http.HttpServletRequest request)
setUserSegmentsParam(String)
.
protected String parseDate(javax.servlet.http.HttpServletRequest request)
setDateParam(String)
.
protected String parseUserAgent(javax.servlet.http.HttpServletRequest request)
setUserAgentParam(String)
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |