com.github.cafdataprocessing.utilities.taskreceiver.taskoutput

Class OutputHelper

java.lang.Object

com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.OutputHelper

public class OutputHelper
extends Object

Provides methods to output data to the storage medium.

Constructor Summary

Constructors

Constructor and Description
OutputHelper()

Method Summary

Modifier and Type	Method and Description
String	createFolderFromDocument(com.github.cafdataprocessing.worker.policy.handlers.shared.document.SharedDocument document, String outputDirectory) Makes and returns the appropriate folder to output the provided document to.
String	createFolderFromTaskMessageId(com.hpe.caf.api.worker.TaskMessage message, String outputDirectory) Creates a folder in the specified directory, using the ID of the provided task message.
void	outputStream(String messageOutputDir, String filename, InputStream streamToOutput) Outputs provided input stream to a specified file in the destination provided.
void	outputString(String outputDestination, String filename, String fileContent) Outputs provided string content to a specified file in the destination provided.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutputHelper

public OutputHelper()

Method Detail

outputString

public void outputString(String outputDestination,
                         String filename,
                         String fileContent)
                  throws IOException

Outputs provided string content to a specified file in the destination provided.

Parameters:

outputDestination - Folder to write output file to.

filename - Filename to give output file.

fileContent - Content for output file.

Throws:

IOException

outputStream

public void outputStream(String messageOutputDir,
                         String filename,
                         InputStream streamToOutput)
                  throws IOException

Outputs provided input stream to a specified file in the destination provided.

Parameters:

messageOutputDir - Folder to write output file to.

filename - Filename to give output file.

streamToOutput - Stream containing content to write to the output file.

Throws:

IOException

createFolderFromTaskMessageId

public String createFolderFromTaskMessageId(com.hpe.caf.api.worker.TaskMessage message,
                                            String outputDirectory)

Creates a folder in the specified directory, using the ID of the provided task message.

Parameters:

message - Task Message to pull ID from.

outputDirectory - Directory to create new folder.

Returns:

Path to the new folder.

createFolderFromDocument

public String createFolderFromDocument(com.github.cafdataprocessing.worker.policy.handlers.shared.document.SharedDocument document,
                                       String outputDirectory)

Makes and returns the appropriate folder to output the provided document to.

Parameters:

document - Document to determine folder for.

outputDirectory - Directory under which the document folder should be placed.

Returns:

Path to the folder document data should be output to.