com.collabnet.core.ws.dispatcher
Interface XMLResponse

All Known Implementing Classes:

DomXMLResponse

public interface XMLResponse

Encapsulates the response to send back via the DocumentAPIDispatcher.

Provides the XMLVisitor to use to construct the response document and also provides facilities to add attachments to the SOAP response.

Author:

sszego

getXMLVisitor

XMLVisitor getXMLVisitor()
                         throws VisitorFactoryConfigurationException

Returns the XML Visitor to use

Returns:

the XML visitor

Throws:

VisitorFactoryConfigurationException

addAttachment

void addAttachment(javax.activation.DataSource attachment)
                   throws java.io.IOException

Adds an attachment to the response

Parameters:

attachment - the attachment

Throws:

java.io.IOException

addAttachment

void addAttachment(java.lang.String data,
                   java.lang.String type,
                   java.lang.String location)
                   throws java.io.IOException

Adds the attachment to the SOAP response

Parameters:

data - the attachment

type - the mime type

location - the location

Throws:

java.io.IOException

addAttachment

void addAttachment(byte[] data,
                   java.lang.String type,
                   java.lang.String location)
                   throws java.io.IOException

Adds the attachment to the SOAP response

Parameters:

data - the attachment

type - the mime type

location - the location

Throws:

java.io.IOException