Package org.kohsuke.stapler.framework.io

Class LargeText

java.lang.Object

org.kohsuke.stapler.framework.io.LargeText

public class LargeText
extends Object

Represents a large text data.

This class defines methods for handling progressive text update.

Usage

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LargeText.Session	Represents the read session of the LargeText.Source.
static interface	LargeText.Source	Represents the data source of this text.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Charset	charset
protected static final String	SEARCH_STOP_PARAMETER	For multipart/form-data streaming mode: Enable searching for the first new line character after the provided ?start and abort searching at the given position.

Constructor Summary

Constructors

Constructor	Description
LargeText(File file, boolean completed)
LargeText(File file, boolean completed, boolean transparentGunzip)
LargeText(File file, Charset charset, boolean completed)
LargeText(File file, Charset charset, boolean completed, boolean transparentGunzip)
LargeText(ByteBuffer memory, boolean completed)
LargeText(ByteBuffer memory, Charset charset, boolean completed)
LargeText(LargeText.Source source, Charset charset, boolean completed)

Method Summary

Modifier and Type	Method	Description
protected boolean	delegateToWriteLogTo(StaplerRequest2 req, StaplerResponse2 rsp)	Whether doProgressText(StaplerRequest2, StaplerResponse2) should delegate to writeLogTo(long, Writer).
void	doProgressText(StaplerRequest2 req, StaplerResponse2 rsp)	Implements the progressive text handling.
void	doProgressText(StaplerRequest req, StaplerResponse rsp)	Deprecated. use doProgressText(StaplerRequest2, StaplerResponse2)
boolean	isComplete()
boolean	isStreamingRequest(StaplerRequest2 req)	Detect use of streaming mode.
long	length()
void	markAsComplete()
protected void	putStreamingMeta(String key, Object value)	Add additional meta data to a streaming response.
Reader	readAll()	Returns Reader for reading the raw bytes.
protected void	setContentType(StaplerResponse rsp)	Deprecated. use setContentType(StaplerResponse2)
protected void	setContentType(StaplerResponse2 rsp)
long	writeLogTo(long start, OutputStream out)	Writes the tail portion of the file to the OutputStream.
long	writeLogTo(long start, Writer w)

Methods inherited from class java.lang.Object

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

Field Details

SEARCH_STOP_PARAMETER

protected static final String SEARCH_STOP_PARAMETER

For multipart/form-data streaming mode: Enable searching for the first new line character after the provided ?start and abort searching at the given position.

See Also:

• Constant Field Values

charset

protected final Charset charset

Constructor Details

LargeText

public LargeText(File file,
 boolean completed)

LargeText

public LargeText(File file,
 boolean completed,
 boolean transparentGunzip)

Parameters:

transparentGunzip - if set to true, this class will detect if the given file is compressed with GZIP. If so, it will transparently uncompress its content during read-access. Do note that the underlying file is not altered and remains compressed.

Since:

1.196

LargeText

public LargeText(File file,
 Charset charset,
 boolean completed)

LargeText

public LargeText(File file,
 Charset charset,
 boolean completed,
 boolean transparentGunzip)

Parameters:

transparentGunzip - if set to true, this class will detect if the given file is compressed with GZIP. If so, it will transparently uncompress its content during read-access. Do note that the underlying file is not altered and remains compressed.

Since:

1.196

LargeText

public LargeText(ByteBuffer memory,
 boolean completed)

LargeText

public LargeText(ByteBuffer memory,
 Charset charset,
 boolean completed)

LargeText

public LargeText(LargeText.Source source,
 Charset charset,
 boolean completed)

Method Details

markAsComplete

public void markAsComplete()

isComplete

public boolean isComplete()

length

public long length()

readAll

public Reader readAll()
               throws IOException

Returns Reader for reading the raw bytes.

Throws:

IOException

writeLogTo

public long writeLogTo(long start,
 Writer w)
                throws IOException

Throws:

IOException

writeLogTo

public long writeLogTo(long start,
 OutputStream out)
                throws IOException

Writes the tail portion of the file to the OutputStream.

Parameters:

start - The byte offset in the input file where the write operation starts.

Returns:

if the file is still being written, this method writes the file until the last newline character and returns the offset to start the next write operation.

Throws:

EOFException - if the start position is larger than the file size

IOException

doProgressText

public void doProgressText(StaplerRequest2 req,
 StaplerResponse2 rsp)
                    throws IOException

Implements the progressive text handling. This method is used as a "web method" with progressiveText.jelly.

Throws:

IOException

doProgressText

@Deprecated
public void doProgressText(StaplerRequest req,
 StaplerResponse rsp)
                    throws IOException

Deprecated.

use doProgressText(StaplerRequest2, StaplerResponse2)

Implements the progressive text handling. This method is used as a "web method" with progressiveText.jelly.

Throws:

IOException

isStreamingRequest

public boolean isStreamingRequest(StaplerRequest2 req)

Detect use of streaming mode.

Parameters:

req - The current request.

Returns:

true if the new streaming mode is requested.

putStreamingMeta

protected void putStreamingMeta(String key,
 Object value)

Add additional meta data to a streaming response.

Parameters:

key - The field to (over)write meta data for.

value - The meta data value.

delegateToWriteLogTo

protected boolean delegateToWriteLogTo(StaplerRequest2 req,
 StaplerResponse2 rsp)

Whether doProgressText(StaplerRequest2, StaplerResponse2) should delegate to writeLogTo(long, Writer).

Returns:

true if so (more compatible and allows extra HTTP headers to be set, but less efficient); false (default) for efficiency

setContentType

protected void setContentType(StaplerResponse2 rsp)

setContentType

@Deprecated
protected void setContentType(StaplerResponse rsp)

Deprecated.

use setContentType(StaplerResponse2)