Package com.levigo.jadice.server.core.util

Class StreamUtils

java.lang.Object

com.levigo.jadice.server.core.util.StreamUtils

public final class StreamUtils
extends Object

Utility methods for handling Streams. As this class depends on apache-common-io it is distributed only on the server side.

Since:

jadice server 4.3.1.1

Field Summary

Fields

Modifier and Type	Field	Description
static char[]	ILLEGAL_FILENAME_CHARACTERS	Characters that are not legal as filename (control characters are filtered separately)

Method Summary

Modifier and Type	Method	Description
static String	createSanitizedFilename(StreamDescriptor descriptor, String fallbackFilename)	Utility method for retrieving a sanitized filename out of the data provided in the stream descriptor.
static File	dumpWithUniqueName(Stream stream, File directory, String fallbackFilename)	Dump the given stream.

Methods inherited from class java.lang.Object

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

Field Detail

ILLEGAL_FILENAME_CHARACTERS

public static final char[] ILLEGAL_FILENAME_CHARACTERS

Characters that are not legal as filename (control characters are filtered separately)

See Also:

#see

Method Detail

createSanitizedFilename

public static String createSanitizedFilename(StreamDescriptor descriptor,
                                             String fallbackFilename)

Utility method for retrieving a sanitized filename out of the data provided in the stream descriptor. Definition: A sanitized name contains only a base name and an extension, but no information about paths or such.

The priority for the base name is:

1. base name from StreamDescriptor.getFileName()
2. base name from the fallbackFilename

The priority for the filename extension is:

1. extension that was determined in the StreamAnalysisNode
2. extension from StreamDescriptor.getFileName()
3. extension from the fallbackFilename

Parameters:

descriptor - Contains the filename information

fallbackFilename - is used when no other information was provided

Returns:

a sanitized filename

Since:

4.3.1.1

dumpWithUniqueName

public static File dumpWithUniqueName(Stream stream,
                                      File directory,
                                      String fallbackFilename)
                               throws IOException

Dump the given stream. Several considerations are made:

• The filename will be created as defined in createSanitizedFilename(StreamDescriptor, String)
• The file will be stored in the given directory
• If there is already another file in the given directory, it will be stored in a new sub-directory with the stream's UUID.

Parameters:

stream - The Stream to dump

directory - The top-level directory where to store the stream

fallbackFilename - A fallback filename, see createSanitizedFilename(StreamDescriptor, String)

Returns:

The location where the file was dumped

Throws:

IOException - in case of an I/O error