atg.rest.processor

Interface RestProcessor

All Known Implementing Classes:

BeanProcessor, GenericRestProcessor, RepositoryProcessor, RestSecurityProcessor

public interface RestProcessor

An interface for exposing methods to handle each of the URL request types for processing REST web service requests.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Methods

Modifier and Type	Method and Description
void	doRESTDelete(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when a DELETE" request is made.
void	doRESTGet(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when a "GET" request is made.
void	doRESTPost(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when a "POST" request is made.
void	doRESTPut(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method is called when a "PUT" request is made.
void	setParentServlet(RestPipelineServlet pServlet) This method sets the parent rest pipeline servlet

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

setParentServlet

void setParentServlet(RestPipelineServlet pServlet)

This method sets the parent rest pipeline servlet

Parameters:

pServlet - the parent pipeline servlet for this processor

doRESTGet

void doRESTGet(DynamoHttpServletRequest pRequest,
             DynamoHttpServletResponse pResponse)
               throws java.io.IOException,
                      RestException

This method is called when a "GET" request is made.

Parameters:

pRequest - the servlet request

pResponse - the servlet response

Throws:

RestException - if an error occurs processing the REST request

java.io.IOException - if an input or output stream exception occurs

doRESTPost

void doRESTPost(DynamoHttpServletRequest pRequest,
              DynamoHttpServletResponse pResponse)
                throws java.io.IOException,
                       RestException

This method is called when a "POST" request is made.

Parameters:

pRequest - the servlet request

pResponse - the servlet response

Throws:

RestException - if an error occurs processing the REST request

java.io.IOException - if an input or output stream exception occurs

doRESTPut

void doRESTPut(DynamoHttpServletRequest pRequest,
             DynamoHttpServletResponse pResponse)
               throws java.io.IOException,
                      RestException

This method is called when a "PUT" request is made.

Parameters:

pRequest - the servlet request

pResponse - the servlet response

Throws:

RestException - if an error occurs processing the REST request

java.io.IOException - if an input or output stream exception occurs

doRESTDelete

void doRESTDelete(DynamoHttpServletRequest pRequest,
                DynamoHttpServletResponse pResponse)
                  throws java.io.IOException,
                         RestException

This method is called when a DELETE" request is made.

Parameters:

pRequest - the servlet request

pResponse - the servlet response

Throws:

RestException - if an error occurs processing the REST request

java.io.IOException - if an input or output stream exception occurs