Package com.cloudbees.jenkins.support.api

Class UnfilteredFileContent

java.lang.Object

com.cloudbees.jenkins.support.api.Content

com.cloudbees.jenkins.support.api.UnfilteredFileContent

public class UnfilteredFileContent
extends Content

Content that is stored as a file on disk and is not filtered. If you want the content to be filtered, use the FileContent class.

Author:

Stephen Connolly, M Ramón León

Field Summary

Fields

Modifier and Type	Field	Description
protected File	file

Constructor Summary

Constructors

Constructor	Description
UnfilteredFileContent(String name, File file)
UnfilteredFileContent(String name, File file, long maxSize)
UnfilteredFileContent(String name, String[] filterableParameters, File file)
UnfilteredFileContent(String name, String[] filterableParameters, File file, long maxSize)

Method Summary

Modifier and Type	Method	Description
protected InputStream	getInputStream()	Instantiates the InputStream for the file.
long	getTime()
boolean	shouldBeFiltered()	Indicates if this Content should be filtered when anonymization is enabled.
void	writeTo(OutputStream os)

Methods inherited from class com.cloudbees.jenkins.support.api.Content

getFilterableParameters, getName

Methods inherited from class java.lang.Object

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

Field Detail

file

protected final File file

Constructor Detail

UnfilteredFileContent

public UnfilteredFileContent(String name,
                             File file)

UnfilteredFileContent

public UnfilteredFileContent(String name,
                             File file,
                             long maxSize)

UnfilteredFileContent

public UnfilteredFileContent(String name,
                             String[] filterableParameters,
                             File file)

UnfilteredFileContent

public UnfilteredFileContent(String name,
                             String[] filterableParameters,
                             File file,
                             long maxSize)

Method Detail

writeTo

public void writeTo(OutputStream os)
             throws IOException

Specified by:

writeTo in class Content

Throws:

IOException

getTime

public long getTime()
             throws IOException

Overrides:

getTime in class Content

Throws:

IOException

getInputStream

protected InputStream getInputStream()
                              throws IOException

Instantiates the InputStream for the file.

Returns:

the InputStream for the file.

Throws:

IOException - if something goes wrong while creating the stream for reading #file.

shouldBeFiltered

public boolean shouldBeFiltered()

Description copied from class: Content

Indicates if this Content should be filtered when anonymization is enabled. When true, the contents written via Content.writeTo(OutputStream) may be filtered by a ContentFilter. When false, the contents are written without any filtering applied.

Overrides:

shouldBeFiltered in class Content