org.deegree.services.csw
Class CSWController

java.lang.Object
  org.deegree.services.controller.AbstractOGCServiceController
      org.deegree.services.csw.CSWController

All Implemented Interfaces:

OWS

public class CSWController
extends AbstractOGCServiceController

Implementation of the OpenGIS Catalogue Service server protocol.

Supported CSW protocol versions:

• 2.0.2

Version:

$Revision: $, $Date: $

Author:

Steffen Thomas, last edited by: $Author: thomas $

See Also:

CSWService, AbstractOGCServiceController, OGCFrontController

Field Summary

Fields inherited from class org.deegree.services.controller.AbstractOGCServiceController

mainControllerConf, mainMetadataConf, offeredVersions

Constructor Summary

CSWController()

Method Summary

void	destroy() Called by the OGCFrontController to indicate to this OWS that it is being taken out of service.
void	doKVP(java.util.Map<java.lang.String,java.lang.String> normalizedKVPParams, javax.servlet.http.HttpServletRequest request, HttpResponseBuffer response, java.util.List<org.apache.commons.fileupload.FileItem> multiParts) Called by the OGCFrontController to allow this OWS to handle an OGC-KVP request.
void	doSOAP(org.apache.axiom.soap.SOAPEnvelope soapDoc, javax.servlet.http.HttpServletRequest request, HttpResponseBuffer response, java.util.List<org.apache.commons.fileupload.FileItem> multiParts, org.apache.axiom.soap.SOAPFactory factory) Called by the OGCFrontController to allow this AbstractOGCServiceController to handle a SOAP request.
void	doXML(javax.xml.stream.XMLStreamReader xmlStream, javax.servlet.http.HttpServletRequest request, HttpResponseBuffer response, java.util.List<org.apache.commons.fileupload.FileItem> multiParts) Called by the OGCFrontController to allow this OWS to handle an OGC-XML request.
org.deegree.commons.utils.Pair<XMLExceptionSerializer<OWSException>,java.lang.String>	getExceptionSerializer(org.deegree.commons.tom.ows.Version requestVersion) Returns the ExceptionSerializer and mime-type suitable for the given request version.
void	init(org.deegree.commons.xml.XMLAdapter controllerConf, DeegreeServicesMetadataType serviceMetadata, DeegreeServiceControllerType mainConf) Called by the OGCFrontController to indicate to this OWS that it is being taken into service.

Methods inherited from class org.deegree.services.controller.AbstractOGCServiceController

beginSOAPResponse, checkConfigVersion, checkOrCreateDCPGetURL, checkOrCreateDCPPostURL, checkVersion, endSOAPResponse, getHandledNamespaces, getHandledRequests, getOfferedVersions, getOfferedVersionsString, init, negotiateVersion, sendException, sendSOAPException, synchronizeServiceIdentificationWithMainController, synchronizeServiceProviderWithMainControllerConf, unmarshallConfig, unmarshallConfig, validateAndSetOfferedVersions

Methods inherited from class java.lang.Object

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

Constructor Detail

CSWController

public CSWController()

Method Detail

init

public void init(org.deegree.commons.xml.XMLAdapter controllerConf,
                 DeegreeServicesMetadataType serviceMetadata,
                 DeegreeServiceControllerType mainConf)
          throws ControllerInitException

Description copied from interface: OWS

Called by the OGCFrontController to indicate to this OWS that it is being taken into service.

Parameters:

controllerConf - provides access to the (always xml-based) configuration of the controller

serviceMetadata - services metadata from the main service configuration for all services

mainConf - from the main.xml

Throws:

ControllerInitException - indicates that the initialization failed

doKVP

public void doKVP(java.util.Map<java.lang.String,java.lang.String> normalizedKVPParams,
                  javax.servlet.http.HttpServletRequest request,
                  HttpResponseBuffer response,
                  java.util.List<org.apache.commons.fileupload.FileItem> multiParts)
           throws javax.servlet.ServletException,
                  java.io.IOException

Description copied from interface: OWS

Called by the OGCFrontController to allow this OWS to handle an OGC-KVP request.

Parameters:

normalizedKVPParams - request parameters (keys are uppercased), never null

request - provides access to all information of the original HTTP request (NOTE: may be GET or POST), never null

response - response that is sent to the client, never null

multiParts - A list of multiparts contained in the request. If the request was not a multipart request the list will be null. If multiparts were found, the requestDoc will be the first (xml-lized) FileItem in the list.

Throws:

javax.servlet.ServletException

java.io.IOException

doXML

public void doXML(javax.xml.stream.XMLStreamReader xmlStream,
                  javax.servlet.http.HttpServletRequest request,
                  HttpResponseBuffer response,
                  java.util.List<org.apache.commons.fileupload.FileItem> multiParts)
           throws javax.servlet.ServletException,
                  java.io.IOException,
                  SecurityException

Description copied from interface: OWS

Called by the OGCFrontController to allow this OWS to handle an OGC-XML request.

Parameters:

xmlStream - provides access to the XML request, cursor points to the START_ELEMENT event of the root element, never null

request - provides access to all information of the original HTTP request (NOTE: may be GET or POST), never null

response - response that is sent to the client, never null

multiParts - A list of multiparts contained in the request. If the request was not a multipart request the list will be null. If multiparts were found, the xmlStream will provide access to the first (xml-lized) FileItem in the list of multi parts

Throws:

javax.servlet.ServletException

java.io.IOException

SecurityException

doSOAP

public void doSOAP(org.apache.axiom.soap.SOAPEnvelope soapDoc,
                   javax.servlet.http.HttpServletRequest request,
                   HttpResponseBuffer response,
                   java.util.List<org.apache.commons.fileupload.FileItem> multiParts,
                   org.apache.axiom.soap.SOAPFactory factory)
            throws org.apache.axiom.om.OMException,
                   javax.servlet.ServletException

Description copied from class: AbstractOGCServiceController

Called by the OGCFrontController to allow this AbstractOGCServiceController to handle a SOAP request.

Specified by:

doSOAP in interface OWS

Overrides:

doSOAP in class AbstractOGCServiceController

Parameters:

soapDoc - XMLAdapter for parsing the SOAP request document

request - provides access to all information of the original HTTP request (NOTE: may be GET or POST)

response - response that is sent to the client

multiParts - A list of multiparts contained in the request. If the request was not a multipart request the list will be null. If multiparts were found, the requestDoc will be the first (xml-lized) FileItem in the list.

factory - initialized to the soap version of the request.

Throws:

javax.servlet.ServletException

org.apache.axiom.om.OMException

destroy

public void destroy()

Description copied from interface: OWS

Called by the OGCFrontController to indicate to this OWS that it is being taken out of service.

getExceptionSerializer

public org.deegree.commons.utils.Pair<XMLExceptionSerializer<OWSException>,java.lang.String> getExceptionSerializer(org.deegree.commons.tom.ows.Version requestVersion)

Description copied from class: AbstractOGCServiceController

Returns the ExceptionSerializer and mime-type suitable for the given request version.

Overrides:

getExceptionSerializer in class AbstractOGCServiceController

Parameters:

requestVersion - version of the request for which the exception has to be produced, may be null (implies that the serializer and mime type for the highest supported version shall be returned)

Returns:

an OWSCommon 1.1.0 XML adapter by default, never null