Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Apache CXF API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.cxf.tools.common.toolspec
Interface ToolContext

public interface ToolContext

Method Summary
 void executePipeline()
           
 Document getInputDocument()
          Request a document based on the standard input stream.
 Document getInputDocument(String id)
          Request a document based on the input stream.
 InputStream getInputStream()
          Request the standard input stream.
 InputStream getInputStream(String id)
          Request an input stream.
 OutputStream getOutputStream()
           
 OutputStream getOutputStream(String id)
           
 String getParameter(String name)
           
 String[] getParameters(String name)
           
 Object getUserObject(String key)
           
 boolean hasParameter(String name)
           
 void sendDocument(Document doc)
           
 void sendDocument(String id, Document doc)
           
 void setUserObject(String key, Object o)
           
 

Method Detail

getInputStream

InputStream getInputStream(String id)
                           throws ToolException
Request an input stream.

Parameters:
id - the id of the stream in the streams sections of the tool's definition document.
Throws:
ToolException

getInputStream

InputStream getInputStream()
                           throws ToolException
Request the standard input stream.

Throws:
ToolException

getInputDocument

Document getInputDocument(String id)
                          throws ToolException
Request a document based on the input stream. This is only returned if the mime type of incoming stream is xml.

Throws:
ToolException

getInputDocument

Document getInputDocument()
                          throws ToolException
Request a document based on the standard input stream. This is only returned if the mime type of incoming stream is xml.

Throws:
ToolException

getOutputStream

OutputStream getOutputStream(String id)
                             throws ToolException
Throws:
ToolException

getOutputStream

OutputStream getOutputStream()
                             throws ToolException
Throws:
ToolException

getParameter

String getParameter(String name)
                    throws ToolException
Throws:
ToolException

getParameters

String[] getParameters(String name)
                       throws ToolException
Throws:
ToolException

hasParameter

boolean hasParameter(String name)
                     throws ToolException
Throws:
ToolException

sendDocument

void sendDocument(String id,
                  Document doc)

sendDocument

void sendDocument(Document doc)

executePipeline

void executePipeline()

setUserObject

void setUserObject(String key,
                   Object o)

getUserObject

Object getUserObject(String key)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Apache CXF API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Apache CXF