|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WebScriptRequest
Web Script Request
Method Summary | |
---|---|
boolean |
forceSuccessStatus()
Force response to return SUCCESS (200) code Note: This is to support clients who cannot support non-success codes e.g. |
String |
getAgent()
Get User Agent TODO: Expand on known agents |
Content |
getContent()
Gets the request body as content |
String |
getContentType()
Gets the mimetype of the request |
String |
getContextPath()
Gets the Alfresco Context Path |
String |
getExtensionPath()
Gets the path extension beyond the path registered for this service e.g. |
String |
getFormat()
Get Requested Format |
Description.FormatStyle |
getFormatStyle()
Get the style the Format was specified in |
String |
getHeader(String name)
Gets the value of the named header |
String[] |
getHeaderNames()
Gets the names of all headers for this request |
String[] |
getHeaderValues(String name)
Gets the (array) value of the named header Note: An array of one item is returned when a "single value" named header is requested |
String |
getJSONCallback()
Get the JSON callback method |
String |
getParameter(String name)
Gets the value of the named parameter |
String[] |
getParameterNames()
Gets the names of all parameters on the Url |
String[] |
getParameterValues(String name)
Gets the (array) value of the named parameter Note: An array of one item is returned when a "single value" named parameter is requested |
String |
getPathInfo()
Gets the service specific path |
String |
getQueryString()
Gets the query String |
Runtime |
getRuntime()
Gets the initiating runtime |
String |
getServerPath()
Get server portion of the request e.g. |
String |
getServiceContextPath()
Gets the Alfresco Web Script Context Path |
Match |
getServiceMatch()
Gets the matching API Service for this request |
String |
getServicePath()
Gets the Alfresco Service Path |
String |
getURL()
Gets the full request URL |
boolean |
isGuest()
Determine if Guest User? |
Object |
parseContent()
Gets the request body as a parsed entity |
Method Detail |
---|
Match getServiceMatch()
String getServerPath()
String getContextPath()
String getServiceContextPath()
String getServicePath()
String getURL()
String getPathInfo()
String getQueryString()
String[] getParameterNames()
String getParameter(String name)
name
- parameter name
String[] getParameterValues(String name)
name
- parameter name
String[] getHeaderNames()
String getHeader(String name)
name
- header name
String[] getHeaderValues(String name)
name
- header name
String getExtensionPath()
String getContentType()
Content getContent()
Object parseContent()
boolean isGuest()
String getFormat()
Description.FormatStyle getFormatStyle()
String getAgent()
String getJSONCallback()
boolean forceSuccessStatus()
Runtime getRuntime()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |