public interface AgreementRequest
An Agreement Request is passed to the AgreementHandler#service
,
which uses the information conteined in the request to check the agreements
validity, with respect to the end user. If the handler can't validate its
agreement, it will typically abort the request.
The request itself conteins information about cookies, parameters, attributes, and whether or not the user attempted a log in, and if so, the user name and password.
For any of the information to be made available to the AgreementHandler the corresponding AgreementConfig instance must indicate this.
Modifier and Type | Method and Description |
---|---|
void |
addCookie(String name,
String value) |
void |
addHeader(String name,
String value) |
void |
addRequestAttribute(String name,
Object value) |
void |
addRequestParameter(String name,
String value) |
void |
addSessionAttribute(String name,
Object value) |
String |
getAgreementText() |
String |
getCookie(String name)
Return the cookie of the given name, if it exists in the incoming request.
|
String |
getCredentials()
Return the credentials of the login, if any such login was attempted.
|
String |
getHeader(String name) |
Object |
getRequestAttribute(String name) |
String |
getRequestParameter(String name)
Return the request parameter of the given name, if it exists in the
incoming request, and if the AgreementConfig corresponding to the
|
Section |
getSection() |
Object |
getSessionAttribute(String name) |
String |
getUrl() |
String |
getUserName()
Return the user name of the login, if any such login was attempted.
|
void |
setAgreementText(String text) |
void |
setCredentials(String pCredentials) |
void |
setSection(Section pSection) |
void |
setUrl(String pUrl) |
void |
setUserName(String pName) |
String getUserName()
If the AgreementHandler is to use user names and credentials, then its AgreementConfig must specify that it uses authentication.
void setUserName(String pName)
String getCredentials()
If the AgreementHandler is to use user names and credentials, then its AgreementConfig must specify that it uses authentication.
void setCredentials(String pCredentials)
String getCookie(String name)
name
- the name of the cookieString getRequestParameter(String name)
name
- the name of the cookievoid setAgreementText(String text)
String getAgreementText()
void setSection(Section pSection)
Section getSection()
void setUrl(String pUrl)
String getUrl()
© 1998- 2018 Stibo DX