|
|||||||||
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.rest.processor.GenericRestProcessor atg.rest.processor.BeanProcessor
public class BeanProcessor
The base type for processing bean property based rest requests. This class handles GET, POST, and PUT requests. DELETE requests pass through this servlet to the next servlet in the chain.
GenericRestProcessor
,
RestProcessor
Nested Class Summary | |
---|---|
class |
BeanProcessor.FormHandlerExceptions
|
class |
BeanProcessor.FormHandlerOutputObject
|
class |
BeanProcessor.FormHandlerProperties
|
class |
BeanProcessor.FormHandlerPropertiesAndExceptions
|
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
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 | |
---|---|
BeanProcessor()
Constructor |
Method Summary | |
---|---|
void |
doRESTDelete(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method handles a REST "DELETE" request. |
void |
doRESTGet(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method handles the processing for a rest GET request. |
void |
doRESTPost(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method handles the processing for a rest POST resource request. |
void |
doRESTPut(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method handles the processing for a rest PUT request. |
protected java.lang.reflect.Method |
findMethodByParameterCount(java.util.List<java.lang.reflect.Method> pAllMethods)
Try to find a method by comparing the number of supplied parameters with the number of parameters the method accepts. |
protected java.lang.reflect.Method |
findMethodBySignature(java.util.List<java.lang.reflect.Method> pAllMethods,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Attempts to find a method by method signature if the "atg-rest-method" parameter was supplied |
java.lang.String[] |
getAdditionalFormHandlerClassNames()
This property is a list of fully qualified class names which represent form handler classes which do not extend atg.droplet.DropletFormHandler or atg.droplet.ObjectFormHandler. |
protected java.lang.Object[] |
getMethodArguments(java.lang.reflect.Method pMethod,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method gets the method arguments from either the input stream or url parameters |
RestSecurityManager |
getRestSecurityManager()
|
RestSecurityProcessor |
getRestSecurityProcessor()
|
boolean |
isReturnFormHandlerExceptionsByDefault()
get ReturnFormHandlerExceptionsByDefault |
boolean |
isReturnFormHandlerPropertiesByDefault()
get ReturnFormHandlerPropertiesByDefault |
void |
setAdditionalFormHandlerClassNames(java.lang.String[] pAdditionalFormHandlerClassNames)
|
void |
setRestSecurityManager(RestSecurityManager pRestSecurityManager)
|
void |
setRestSecurityProcessor(RestSecurityProcessor pRestSecurityProcessor)
|
void |
setReturnFormHandlerExceptionsByDefault(boolean pReturnFormHandlerExceptionsByDefault)
set ReturnFormHandlerExceptionsByDefault |
void |
setReturnFormHandlerPropertiesByDefault(boolean pReturnFormHandlerPropertiesByDefault)
set ReturnFormHandlerPropertiesByDefault |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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
Constructor Detail |
---|
public BeanProcessor()
Method Detail |
---|
public java.lang.String[] getAdditionalFormHandlerClassNames()
public void setAdditionalFormHandlerClassNames(java.lang.String[] pAdditionalFormHandlerClassNames)
pAdditionalFormHandlerClassNames
- the additionalFormHandlerClassNames to setpublic void setReturnFormHandlerPropertiesByDefault(boolean pReturnFormHandlerPropertiesByDefault)
pReturnFormHandlerPropertiesByDefault
- the ReturnFormHandlerPropertiesByDefaultpublic boolean isReturnFormHandlerPropertiesByDefault()
public void setReturnFormHandlerExceptionsByDefault(boolean pReturnFormHandlerExceptionsByDefault)
pReturnFormHandlerExceptionsByDefault
- the ReturnFormHandlerExceptionsByDefaultpublic boolean isReturnFormHandlerExceptionsByDefault()
public RestSecurityProcessor getRestSecurityProcessor()
public void setRestSecurityProcessor(RestSecurityProcessor pRestSecurityProcessor)
pRestSecurityProcessor
- - set restSecurityProcessorpublic RestSecurityManager getRestSecurityManager()
public void setRestSecurityManager(RestSecurityManager pRestSecurityManager)
pRestSecurityManager
- - set restSecurityManagerpublic void doRESTGet(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pRequest
- the servlet requestpResponse
- the servlet response
RestException
- if an error occurs processing the REST request
java.io.IOException
- if an input or output stream exception occurspublic void doRESTPost(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pRequest
- the servlet requestpResponse
- the servlet response
RestException
- if an error occurs processing the REST request
java.io.IOException
- if an input or output stream exception occursprotected java.lang.Object[] getMethodArguments(java.lang.reflect.Method pMethod, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException
pMethod
- the method for which to get the argumentspRequest
- the servlet requestpResponse
- the servlet response
RestException
- if an unexpected error occursprotected java.lang.reflect.Method findMethodBySignature(java.util.List<java.lang.reflect.Method> pAllMethods, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException
pAllMethods
- a list of all the methods to look through. This is a list of methods that have the same name.pRequest
- the servlet requestpResponse
- the servlet response
RestException
- if an invalid method signature is suppliedprotected java.lang.reflect.Method findMethodByParameterCount(java.util.List<java.lang.reflect.Method> pAllMethods)
pAllMethods
- a list of all the methods to look through
public void doRESTPut(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pRequest
- the servlet requestpResponse
- the servlet response
RestException
- if an error occurs processing the REST request
java.io.IOException
- if an input or output stream exception occurspublic void doRESTDelete(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, RestException
pRequest
- the servlet requestpResponse
- the servlet response
RestException
- if an error occurs processing the REST request
java.io.IOException
- if an input or output stream exception occursRestProcessor#handleRESTDeleteRequest(java.lang.String, atg.servlet.DynamoHttpServletRequest, atg.servlet.DynamoHttpServletResponse)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |