com.esri.gpt.control.rest
Class ManageDocumentServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          com.esri.gpt.framework.context.BaseServlet
              com.esri.gpt.control.rest.ManageDocumentServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

public class ManageDocumentServlet
extends BaseServlet

Provides an HTTP REST interface for the management of an XML based metadata document.

The URL pattern for this end-point is:
http://host:port/application/rest/manage/document

Four HTTP methods are supported:

• GET - gets an XML document from the catalog
  • the subject document must be specified within the URL
  • the XML is returned within the body of the HTTP response
• PUT - publishes an XML document to the catalog
  • the XML must be supplied within the body of the HTTP request.
  • if no document provided, that means this is resource registration request.
  • returns HTTP 200 when a document is replaced
  • returns HTTP 201 when a document is created
• POST - same as PUT
• DELETE - deletes a document from the catalog
  • the subject document must be specified within the URL
  • returns HTTP 200 when a document is deleted

The subject document can be specified within the URL as follows:

• .../rest/manage/document/identifier
• .../rest/manage/document?id=identifier
• identifier can be the catalog's UUID for the document, or the file identifier internal to the XML document
• identifier must be properly URL encoded

Attributes applicable for resource registration:

• url - resource URL (required)
• uuid - UUID of the resource (optional). If provided this is an update of the already existing resource
• name - resource name/title (optional)
• protocol - protocol type (optional: res,arcgis,arcims,csw,oai,waf). Default: res
• frequency - frequency (optional: Monthly, BiWeekly, Weekly, Dayly, Hourly, Once, Skip). Default: Skip
• sendNotification - to send notification (optional: true,false). Default: false
• updateContent - to harvest content during synchronization (optional: true,false). Default: true
• updateDefinition - to update definition during synchronization (optional: true,false). Default: true
• autoApprove - to automatically approve newly acquired metadata (optional: true,false). Default: true
• findable - to make this resource findable when searching for metadata (optional: true, false), Default: true
• searchable - to make this resource to act as distributed search endpoint (only if csw) (optional: true, false), Default: true
• synchronizable - to make this resource synchronizable (optional: true, false), Default: true
• username - user name required to access protected resource (optional)
• password - password required to access protected resource (optional)
• soapurl - (ARCGIS only) resource SOAP URL
• profile - (CSW only) profile
• set - (OAI only) set
• prefix - (OAI only) prefix
• service - (ARCIMS only) service
• port - (ARCIMS only) port
• rootFolder - (ARCIMS only) root folder

Exceptions applicable to all methods:

• HTTP 401 Unauthorized - indicates that valid credentials must be supplied to access this URL
• HTTP 403 The document is owned by another user. - when an attempt is made to access a document owned by another user

Exceptions applicable to GET/DETETE:

• HTTP 404 Document not found.. - when the document specified within the request URL could not be located within the catalog

Exceptions applicable to PUT/POST:

• HTTP 400 IOException while reading request body. - when characters could not be read from the request body
• HTTP 409 Document was empty. - when the request body was empty
• HTTP 409 Unable to parse document as XML. - when the content of the request body cannot be parsed as XML
• HTTP 409 Unrecognized metadata schema. - when the supplied XML does not match a configured XML standard for the catalog
• HTTP 409 Document failed to validate.. - when the supplied XML is invalid with respect to the configured validation rules for the catalog
• HTTP 409 XSD violation. - when the supplied XML is invalid with respect to it's XSD
• HTTP 409 Duplicated resource URL. - when registering new resource with URL as another already registered resource

See Also:

Serialized Form

Constructor Summary

ManageDocumentServlet()

Method Summary

protected void	doDelete(HttpServletRequest request, HttpServletResponse response) Deletes a document from the catalog.
protected void	doGet(HttpServletRequest request, HttpServletResponse response) Gets an XML document from the catalog.
protected void	doPost(HttpServletRequest request, HttpServletResponse response) Handles a POST request.
protected void	doPut(HttpServletRequest request, HttpServletResponse response) Publishes an XML document to the catalog.
protected void	execute(HttpServletRequest request, HttpServletResponse response, RequestContext context) Provides a concrete executeUpdate() method to fulfill the sub-class requirement of the parent BaseServlet class.

Methods inherited from class com.esri.gpt.framework.context.BaseServlet

authenticate, getCredentials, getLogger, getParameterValue, getRealm, readInputCharacters, writeCharacterResponse, writeHtmlResponse, writeXmlResponse

Methods inherited from class javax.servlet.http.HttpServlet

doHead, doOptions, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManageDocumentServlet

public ManageDocumentServlet()

Method Detail

doDelete

protected void doDelete(HttpServletRequest request,
                        HttpServletResponse response)
                 throws ServletException,
                        IOException

Deletes a document from the catalog.
An HTTP 200 response code is set when a document is successfully deleted.

Overrides:

doDelete in class HttpServlet

Parameters:

request - the servlet request

response - the servlet response

Throws:

ServletException - if the request cannot be handled

IOException - if an I/O error occurs while handling the request

doGet

protected void doGet(HttpServletRequest request,
                     HttpServletResponse response)
              throws ServletException,
                     IOException

Gets an XML document from the catalog.
The XML is returned within the body of the HTTP response.

Overrides:

doGet in class BaseServlet

Parameters:

request - the servlet request

response - the servlet response

Throws:

ServletException - if the request cannot be handled

IOException - if an I/O error occurs while handling the request

doPost

protected void doPost(HttpServletRequest request,
                      HttpServletResponse response)
               throws ServletException,
                      IOException

Handles a POST request.
Same as doPut().

Overrides:

doPost in class BaseServlet

Parameters:

request - the servlet request

response - the servlet response

Throws:

ServletException - if the request cannot be handled

IOException - if an I/O error occurs while handling the request

doPut

protected void doPut(HttpServletRequest request,
                     HttpServletResponse response)
              throws ServletException,
                     IOException

Publishes an XML document to the catalog.
The XML must be supplied within the body of the HTTP request.
An HTTP 200 response code is set when a document is successfully replaced.
An HTTP 201 response code is set when a document is successfully created.

Overrides:

doPut in class HttpServlet

Parameters:

request - the servlet request

response - the servlet response

Throws:

ServletException - if the request cannot be handled

IOException - if an I/O error occurs while handling the request

execute

protected void execute(HttpServletRequest request,
                       HttpServletResponse response,
                       RequestContext context)
                throws Exception

Provides a concrete executeUpdate() method to fulfill the sub-class requirement of the parent BaseServlet class. This method is never invoked, all work is handled through doGet(), doPut(), doPost() and doDelete().

Specified by:

execute in class BaseServlet

Parameters:

request - the HTTP request

response - HTTP response

context - request context

Throws:

Exception - if an exception occurs