atg.rest.processor
Interface RestProcessor

All Known Implementing Classes:

BeanProcessor, GenericRestProcessor, RepositoryProcessor, RestSecurityProcessor, ServiceProcessor

public interface RestProcessor

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

Author:

mannyp

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

void	doRESTDelete(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called when a DELETE" request is made.
void	doRESTGet(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called when a "GET" request is made.
void	doRESTPost(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called when a "POST" request is made.
void	doRESTPut(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.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(atg.servlet.DynamoHttpServletRequest pRequest,
               atg.servlet.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(atg.servlet.DynamoHttpServletRequest pRequest,
                atg.servlet.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(atg.servlet.DynamoHttpServletRequest pRequest,
               atg.servlet.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(atg.servlet.DynamoHttpServletRequest pRequest,
                  atg.servlet.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