com.collabnet.tracker.ws.handler
Class GetArtifactByIdHandler

java.lang.Object
  extended by com.collabnet.tracker.ws.handler.GetArtifactByIdHandler
All Implemented Interfaces:
DocumentHandler
public class GetArtifactByIdHandler
extends java.lang.Object
implements DocumentHandler

Handler for getArtifactById type requests

The request document looks like: 

 <getArtifactById xmlns="urn:ws.tracker.collabnet.com">
   <id>{unique id, like SC1}</id>
   <id>...</id>
 </getArtifactById>

The result document is an artifactList document; see ArtifactListXMLHelper. Note, the artifactList returned by this handler does not contain paging information, because the list is not the result of a query.

Author:
sszego

Constructor Summary
GetArtifactByIdHandler()
           
 
Method Summary
 DocumentType[] getHandledDocumentTypes()
          Returns the DocumentType representing the get artifact by id handler.
 java.util.List getSchemaReferences(Callcontext context, XMLRequest request)
          (non-Javadoc)
 void handle(Callcontext context, XMLRequest request, XMLResponse response)
          Handles "getArtifactById" requests.
 void produceSchema(Callcontext context, XMLRequest request, SchemaVisitor visitor)
          (non-Javadoc)
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetArtifactByIdHandler

public GetArtifactByIdHandler()
Method Detail

handle

public void handle(Callcontext context,
                   XMLRequest request,
                   XMLResponse response)
            throws java.lang.Exception
Handles "getArtifactById" requests.

Specified by:
handle in interface DocumentHandler
Parameters:
context - the context of the current request
request - the request 'document'
response - the response
Throws:
java.lang.Exception
See Also:
DocumentHandler.handle(com.collabnet.core.ws.services.Callcontext, com.collabnet.core.ws.dispatcher.XMLRequest, com.collabnet.core.ws.dispatcher.XMLResponse)

getSchemaReferences

public java.util.List getSchemaReferences(Callcontext context,
                                          XMLRequest request)
                                   throws SchemaReferenceException
(non-Javadoc)

Specified by:
getSchemaReferences in interface DocumentHandler
Throws:
SchemaReferenceException
See Also:
DocumentHandler.getSchemaReferences(com.collabnet.core.ws.services.Callcontext, com.collabnet.core.ws.dispatcher.XMLRequest)

getHandledDocumentTypes

public DocumentType[] getHandledDocumentTypes()
Returns the DocumentType representing the get artifact by id handler.

Specified by:
getHandledDocumentTypes in interface DocumentHandler
See Also:
DocumentHandler.getHandledDocumentTypes()

produceSchema

public void produceSchema(Callcontext context,
                          XMLRequest request,
                          SchemaVisitor visitor)
                   throws SchemaGenerationException
(non-Javadoc)

Specified by:
produceSchema in interface DocumentHandler
Throws:
SchemaGenerationException
See Also:
DocumentHandler.produceSchema(com.collabnet.core.ws.services.Callcontext, com.collabnet.core.ws.dispatcher.XMLRequest, com.collabnet.core.xml.SchemaVisitor)