Package hudson.console

Class AnnotatedLargeText<T>

java.lang.Object

org.kohsuke.stapler.framework.io.LargeText

hudson.console.AnnotatedLargeText<T>

Type Parameters:

T - Context type.

public class AnnotatedLargeText<T>
extends org.kohsuke.stapler.framework.io.LargeText

Extension to LargeText that handles annotations by ConsoleAnnotator.

In addition to run each line through ConsoleAnnotationOutputStream for adding markup, this class persists ConsoleAnnotator into a byte sequence and send it to the client as an HTTP header. The client JavaScript sends it back next time it fetches the following output.

The serialized ConsoleAnnotator is encrypted to avoid malicious clients from instantiating arbitrary ConsoleAnnotators.

Since:

1.349

Author:

Kohsuke Kawaguchi

Field Summary

Fields inherited from class org.kohsuke.stapler.framework.io.LargeText

charset

Constructor Summary

Constructors

Constructor	Description
AnnotatedLargeText(File file, Charset charset, boolean completed, T context)
AnnotatedLargeText(org.kohsuke.stapler.framework.io.ByteBuffer memory, Charset charset, boolean completed, T context)

Method Summary

Modifier and Type	Method	Description
protected boolean	delegateToWriteLogTo(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
void	doProgressiveHtml(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
void	doProgressiveHtml(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)	Deprecated. use doProgressiveHtml(StaplerRequest2, StaplerResponse2)
void	doProgressiveText(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Aliasing what I think was a wrong name in LargeText
void	doProgressiveText(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)	Deprecated. use doProgressiveText(StaplerRequest2, StaplerResponse2)
protected void	setContentType(org.kohsuke.stapler.StaplerResponse rsp)	Deprecated. use setContentType(StaplerResponse2)
protected void	setContentType(org.kohsuke.stapler.StaplerResponse2 rsp)
long	writeHtmlTo(long start, Writer w)
long	writeLogTo(long start, OutputStream out)	Strips annotations using a PlainTextConsoleOutputStream.
long	writeLogTo(long start, Writer w)
long	writeRawLogTo(long start, OutputStream out)	Calls LargeText.writeLogTo(long, OutputStream) without stripping annotations as writeLogTo(long, OutputStream) would.

Methods inherited from class org.kohsuke.stapler.framework.io.LargeText

doProgressText, doProgressText, isComplete, length, markAsComplete, readAll

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotatedLargeText

public AnnotatedLargeText(File file,
 Charset charset,
 boolean completed,
 T context)

AnnotatedLargeText

public AnnotatedLargeText(org.kohsuke.stapler.framework.io.ByteBuffer memory,
 Charset charset,
 boolean completed,
 T context)

Method Details

doProgressiveHtml

public void doProgressiveHtml(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                       throws IOException

Throws:

IOException

Since:

2.475

doProgressiveHtml

@Deprecated
@StaplerNotDispatchable
public void doProgressiveHtml(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
                       throws IOException

Deprecated.

use doProgressiveHtml(StaplerRequest2, StaplerResponse2)

Throws:

IOException

doProgressiveText

public void doProgressiveText(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                       throws IOException

Aliasing what I think was a wrong name in LargeText

Throws:

IOException

Since:

2.475

doProgressiveText

@Deprecated
public void doProgressiveText(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
                       throws IOException

Deprecated.

use doProgressiveText(StaplerRequest2, StaplerResponse2)

Throws:

IOException

setContentType

protected void setContentType(org.kohsuke.stapler.StaplerResponse2 rsp)

Overrides:

setContentType in class org.kohsuke.stapler.framework.io.LargeText

Since:

2.475

setContentType

@Deprecated
protected void setContentType(org.kohsuke.stapler.StaplerResponse rsp)

Deprecated.

use setContentType(StaplerResponse2)

Overrides:

setContentType in class org.kohsuke.stapler.framework.io.LargeText

writeLogTo

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

Overrides:

writeLogTo in class org.kohsuke.stapler.framework.io.LargeText

Throws:

IOException

delegateToWriteLogTo

protected boolean delegateToWriteLogTo(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)

Overrides:

delegateToWriteLogTo in class org.kohsuke.stapler.framework.io.LargeText

writeLogTo

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

Strips annotations using a PlainTextConsoleOutputStream.

Overrides:

writeLogTo in class org.kohsuke.stapler.framework.io.LargeText

Throws:

IOException

writeRawLogTo

@CheckReturnValue
public long writeRawLogTo(long start,
 OutputStream out)
                   throws IOException

Calls LargeText.writeLogTo(long, OutputStream) without stripping annotations as writeLogTo(long, OutputStream) would.

Throws:

IOException

Since:

1.577

writeHtmlTo

@CheckReturnValue
public long writeHtmlTo(long start,
 Writer w)
                 throws IOException

Throws:

IOException