com.atlassian.gadgets.publisher.internal
Interface GadgetProcessor

All Known Implementing Classes:

GadgetProcessorImpl

public interface GadgetProcessor

Represents preprocessing operations applied to a gadget XML spec before being served to a client or persisted to a store. Relevant operations are Atlassian-specific and are used to integrate better with Atlassian applications that host the gadget dashboard.

Method Summary

void	process(InputStream in, OutputStream out) Applies an implementation-defined transformation to the XML stream provided by the specified InputStream while writing the result to the specified OutputStream.

Method Detail

process

void process(InputStream in,
             OutputStream out)
             throws IOException,
                    GadgetParsingException

Applies an implementation-defined transformation to the XML stream provided by the specified InputStream while writing the result to the specified OutputStream. The InputStream is guaranteed to be read at most once in this implementation. Neither the InputStream nor the OutputStream may be null.

Parameters:

in - source of the gadget spec XML to process

out - destination for the processed XML

Throws:

NullPointerException - if any argument is null

IOException - if an error occurs in I/O processing

GadgetParsingException - if an error is detected in the gadget XML