com.collabnet.tracker.ws.handler
Class UpdateArtifactListHandler

java.lang.Object
  com.collabnet.tracker.ws.handler.UpdateArtifactListHandler

All Implemented Interfaces:

DocumentHandler

public class UpdateArtifactListHandler
extends java.lang.Object
implements DocumentHandler

Handler for [XMLConstants.NAMESPACE]updateArtifactList documents.

The format of the request document is the following:

 <updateArtifactList xmlns="urn:ws.tracker.collabnet.com">
   <artifactList>
     <ns1:{artifactTypeXMLName} xmlns:ns1="{urn:xmlURI}">
        [attributes-to-update]
        <id>{unique-id}</id>
        <modifiedBy>{login-name}</modifiedBy>
        <lastReadOn>{last-read-in-ms}</lastReadOn>
        <reason>{reason}</reason>
     </ns1:artifactType>
     <!-- more artifacts to update, maximum 25 -->
   </artifactList>
   <sendMail>true | false</sendMail>
 </updateArtifactList>
 

where

• {artifactTypeXMLName} is the xml name of the artifact type
• {urn:xmlURI} is the namespace URI of the artifact type
• [attributes-to-update] is the definition of attributes as described in ArtifactListXMLHelper
• modifiedBy is an optional element. If specified, must be the login name of the user who is making the change. If not specified, then the system will use the current user's login name.
• lastReadOn is a required tag that specifies when the currently updated artifact was last read by the external system. The actual value does not matter, it just must be greater than or equal to the modification time of the artifact. If lastReadOn is less than the last modification time of the artifact, then the artifact will not be updated.
• id is a required element that specifies the unique id (e.g., SC1) of the artifact.
• The sendMail element is an optional element. If true, then email will be sent for each change. If set to false or omitted, then no emails will be sent.
• The reason element may be required, depending on the attributes being changed.

The format of the response document generated by the handle method is described in GetArtifactListHandler. Note, that the <artifactList> document will not contain a <pageInfo> element, since the list of artifacts is not a result of a query.

A few notes on updating URL 'pseudo-attributes':

• To remove a URL 'pseudo-attribute' you must specify the following:

     <url>
       <id>
       <removed>true</removed>
     </url>
   

• To update the URL value of a URL 'pseudo-attribtue', you must specify the following:

     <url>
       <id>
       <name>{the-url}</name>
     </url>
   

Author:

sszego

SEND_EMAIL_XPATH

public static final java.lang.String SEND_EMAIL_XPATH

The XPath to the sendEmail element

See Also:

Constant Field Values

REQUEST_ROOT_ELEMENT_NAME

public static final java.lang.String REQUEST_ROOT_ELEMENT_NAME

The root element of the updateArtifactList document

See Also:

Constant Field Values

UpdateArtifactListHandler

public UpdateArtifactListHandler()

handle

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

Handles {XMLConstants.NAMESPACE}updateArtifactList documents. (non-Javadoc)

Specified by:

handle in interface DocumentHandler

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

Returns the references to the schemas used by artifactList and updateArtifactList documents. (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 [XMLConstants.NAMESPACE]updateArtifactList DocumentType (non-Javadoc)

Specified by:

getHandledDocumentTypes in interface DocumentHandler

See Also:

DocumentHandler.getHandledDocumentTypes()

produceSchema

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

Generates the schema for updateArtifactList and artifactList documents. (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)