Interface ToolContext
public interface ToolContext
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Request a document based on the standard input stream.Request a document based on the input stream.Request the standard input stream.getInputStream
(String id) Request an input stream.getParameter
(String name) String[]
getParameters
(String name) getUserObject
(String key) boolean
hasParameter
(String name) void
sendDocument
(String id, Document doc) void
sendDocument
(Document doc) void
setUserObject
(String key, Object o)
-
Method Details
-
getInputStream
Request an input stream.- Parameters:
id
- the id of the stream in the streams sections of the tool's definition document.- Throws:
ToolException
-
getInputStream
Request the standard input stream.- Throws:
ToolException
-
getInputDocument
Request a document based on the input stream. This is only returned if the mime type of incoming stream is xml.- Throws:
ToolException
-
getInputDocument
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
- Throws:
ToolException
-
getOutputStream
- Throws:
ToolException
-
getParameter
- Throws:
ToolException
-
getParameters
- Throws:
ToolException
-
hasParameter
- Throws:
ToolException
-
sendDocument
-
sendDocument
-
executePipeline
void executePipeline() -
setUserObject
-
getUserObject
-