org.apache.cxf.io

Class CachedWriter

java.lang.Object

java.io.Writer

org.apache.cxf.io.CachedWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

Direct Known Subclasses:

XSLTOutInterceptor.XSLTCachedWriter

public class CachedWriter
extends java.io.Writer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.Writer	currentStream
protected boolean	outputLocked

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
CachedWriter()
CachedWriter(long threshold)

Method Summary

Modifier and Type	Method and Description
void	close()
void	deregisterCallback(CachedWriterCallback cb)
protected void	doClose() Perform any actions required on stream closure (handle response etc.)
protected void	doFlush() Perform any actions required on stream flush (freeze headers, reset output stream ...
boolean	equals(java.lang.Object obj)
void	flush()
java.util.List<CachedWriterCallback>	getCallbacks()
char[]	getChars()
java.io.Writer	getOut()
java.io.Reader	getReader()
java.io.File	getTempFile()
int	hashCode()
void	holdTempFile()
void	lockOutputStream() Locks the output stream to prevent additional writes, but maintains a pointer to it so an InputStream can be obtained
protected void	onWrite()
protected void	postClose() Perform any actions required after stream closure (close the other related stream etc.)
void	registerCallback(CachedWriterCallback cb)
void	releaseTempFileHold()
void	resetOut(java.io.Writer out, boolean copyOldContent) Replace the original stream with the new one, optionally copying the content of the old one into the new one.
void	setCipherTransformation(java.lang.String cipherTransformation)
static void	setDefaultCipherTransformation(java.lang.String n)
static void	setDefaultMaxSize(long l)
static void	setDefaultThreshold(int i)
void	setMaxSize(long maxSize)
void	setOutputDir(java.io.File outputDir)
void	setThreshold(long threshold)
long	size()
java.lang.String	toString()
void	write(char[] cbuf, int off, int len)
void	writeCacheTo(java.lang.StringBuilder out)
void	writeCacheTo(java.lang.StringBuilder out, long limit)
void	writeCacheTo(java.io.Writer out)

Methods inherited from class java.io.Writer

append, append, append, write, write, write, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

outputLocked

protected boolean outputLocked

currentStream

protected java.io.Writer currentStream

Constructor Detail

CachedWriter

public CachedWriter()

CachedWriter

public CachedWriter(long threshold)

Method Detail

holdTempFile

public void holdTempFile()

releaseTempFileHold

public void releaseTempFileHold()

registerCallback

public void registerCallback(CachedWriterCallback cb)

deregisterCallback

public void deregisterCallback(CachedWriterCallback cb)

getCallbacks

public java.util.List<CachedWriterCallback> getCallbacks()

doFlush

protected void doFlush()
                throws java.io.IOException

Perform any actions required on stream flush (freeze headers, reset output stream ... etc.)

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException

doClose

protected void doClose()
                throws java.io.IOException

Perform any actions required on stream closure (handle response etc.)

Throws:

java.io.IOException

postClose

protected void postClose()
                  throws java.io.IOException

Perform any actions required after stream closure (close the other related stream etc.)

Throws:

java.io.IOException

lockOutputStream

public void lockOutputStream()
                      throws java.io.IOException

Locks the output stream to prevent additional writes, but maintains a pointer to it so an InputStream can be obtained

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

resetOut

public void resetOut(java.io.Writer out,
                     boolean copyOldContent)
              throws java.io.IOException

Replace the original stream with the new one, optionally copying the content of the old one into the new one. When with Attachment, needs to replace the xml writer stream with the stream used by AttachmentSerializer or copy the cached output stream to the "real" output stream, i.e. onto the wire.

Parameters:

out - the new output stream

copyOldContent - flag indicating if the old content should be copied

Throws:

java.io.IOException

size

public long size()

getChars

public char[] getChars()
                throws java.io.IOException

Throws:

java.io.IOException

writeCacheTo

public void writeCacheTo(java.io.Writer out)
                  throws java.io.IOException

Throws:

java.io.IOException

writeCacheTo

public void writeCacheTo(java.lang.StringBuilder out,
                         long limit)
                  throws java.io.IOException

Throws:

java.io.IOException

writeCacheTo

public void writeCacheTo(java.lang.StringBuilder out)
                  throws java.io.IOException

Throws:

java.io.IOException

getOut

public java.io.Writer getOut()

Returns:

the underlying output stream

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

onWrite

protected void onWrite()
                throws java.io.IOException

Throws:

java.io.IOException

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws java.io.IOException

Specified by:

write in class java.io.Writer

Throws:

java.io.IOException

getTempFile

public java.io.File getTempFile()

getReader

public java.io.Reader getReader()
                         throws java.io.IOException

Throws:

java.io.IOException

setOutputDir

public void setOutputDir(java.io.File outputDir)
                  throws java.io.IOException

Throws:

java.io.IOException

setThreshold

public void setThreshold(long threshold)

setMaxSize

public void setMaxSize(long maxSize)

setCipherTransformation

public void setCipherTransformation(java.lang.String cipherTransformation)

setDefaultMaxSize

public static void setDefaultMaxSize(long l)

setDefaultThreshold

public static void setDefaultThreshold(int i)

setDefaultCipherTransformation

public static void setDefaultCipherTransformation(java.lang.String n)