com.opensymphony.module.sitemesh.scalability.secondarystorage

Class TempDirSecondaryStorage

java.lang.Object

com.opensymphony.module.sitemesh.scalability.secondarystorage.TempDirSecondaryStorage

All Implemented Interfaces:

SecondaryStorage

public class TempDirSecondaryStorage
extends java.lang.Object
implements SecondaryStorage

A SecondaryStorage implementation that uses the File.createTempFile() method

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
TempDirSecondaryStorage(long memoryLimitBeforeUse)
TempDirSecondaryStorage(long memoryLimitBeforeUse, java.io.File tempDirectory)

Method Summary

Modifier and Type	Method and Description
void	cleanUp() This allows you to ask the secondary storage to clean up after itself.
protected void	cleanupImplementation()
protected void	ensureIsOpen()
long	getMemoryLimitBeforeUse() Returns the number of characters that should be stored in memory before this secondary storage.
java.io.File	getTempDirectory()
protected java.io.File	getTempFile() By default creates a temporary file in getTempDirectory().
void	write(char[] chars, int off, int len)
void	write(int c)
void	write(java.lang.String str)
void	write(java.lang.String str, int off, int len)
void	writeTo(java.io.Writer out) This method will close the "secondary storage" and write the captured output to the specified output writer.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static java.util.logging.Logger logger

Constructor Detail

TempDirSecondaryStorage

public TempDirSecondaryStorage(long memoryLimitBeforeUse)

TempDirSecondaryStorage

public TempDirSecondaryStorage(long memoryLimitBeforeUse,
                               java.io.File tempDirectory)

Method Detail

getMemoryLimitBeforeUse

public long getMemoryLimitBeforeUse()

Description copied from interface: SecondaryStorage

Returns the number of characters that should be stored in memory before this secondary storage. If this value is 0 or below then it is in fact disabled.

Specified by:

getMemoryLimitBeforeUse in interface SecondaryStorage

Returns:

the memory limits in force

getTempDirectory

public java.io.File getTempDirectory()

ensureIsOpen

protected void ensureIsOpen()

getTempFile

protected java.io.File getTempFile()
                            throws java.io.IOException

By default creates a temporary file in getTempDirectory(). The Java File.createTempFile(String, String, java.io.File) ensures that the file is unique.

Returns:

a write-able temporary file

Throws:

java.io.IOException

write

public void write(int c)
           throws java.io.IOException

Specified by:

write in interface SecondaryStorage

Throws:

java.io.IOException

See Also:

Writer.write(int)

write

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

Specified by:

write in interface SecondaryStorage

Throws:

java.io.IOException

See Also:

Writer.write(char[], int, int)

write

public void write(java.lang.String str,
                  int off,
                  int len)
           throws java.io.IOException

Specified by:

write in interface SecondaryStorage

Throws:

java.io.IOException

See Also:

Writer.write(String, int, int)

write

public void write(java.lang.String str)
           throws java.io.IOException

Specified by:

write in interface SecondaryStorage

Throws:

java.io.IOException

See Also:

Writer.write(String)

writeTo

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

Description copied from interface: SecondaryStorage

This method will close the "secondary storage" and write the captured output to the specified output writer.

Specified by:

writeTo in interface SecondaryStorage

Parameters:

out - the output writer to send the stored data

Throws:

java.io.IOException - if the data cant be written

cleanUp

public void cleanUp()

Description copied from interface: SecondaryStorage

This allows you to ask the secondary storage to clean up after itself. A try / finally would be a good place to put this.
This should be able to be called multiple times because we want to be able to always cleanup in case of exceptions as well an blue sky paths.
Really no exceptions should be propagated from this method.

Specified by:

cleanUp in interface SecondaryStorage

cleanupImplementation

protected void cleanupImplementation()
                              throws java.io.IOException

Throws:

java.io.IOException