org.tangram.mutable

Class CodeHelper

java.lang.Object

org.tangram.mutable.CodeHelper

public final class CodeHelper
extends java.lang.Object

Static helper methods to deal with CodeResource items.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAnnotation(java.lang.String filename) Derive annotation from pseudo filename.
static java.util.Set<java.lang.String>	getCodeMimeTypes() Return the set of mime types known and handled by this class.
static java.lang.String	getExtension(java.lang.String mimeType) Derive filename extension from mime type.
static java.lang.String	getFolder(java.lang.String mimeType) Get a pseudo folder name for a given mime type.
static java.lang.String	getMimetype(java.lang.String directoryName) Get mime type from pseudo directory name.
static void	updateCode(MutableBeanFactory beanFactory, org.tangram.content.CodeResourceCache codeResourceCache, java.lang.String mimetype, java.lang.String filename, byte[] contents, long modificationTime) Update or create a code entry in the repository.

Methods inherited from class java.lang.Object

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

Method Detail

getCodeMimeTypes

public static java.util.Set<java.lang.String> getCodeMimeTypes()

Return the set of mime types known and handled by this class.

Returns:

set of mime types

getExtension

public static java.lang.String getExtension(java.lang.String mimeType)

Derive filename extension from mime type.

Parameters:

mimeType - mime type to get extension for

Returns:

filename extension

getFolder

public static java.lang.String getFolder(java.lang.String mimeType)

Get a pseudo folder name for a given mime type. Only mime types dealing with known code types to tangram are mapped. Other text mime types are mapped to their subtype, while all other types are mapped to themselves as a folder name

Parameters:

mimeType - mime type to map to a folder name.

Returns:

pseudo folder name

getMimetype

public static java.lang.String getMimetype(java.lang.String directoryName)

Get mime type from pseudo directory name. There are no directories in the repository, so a fixed set of directory names directly describes a folder. All other folder names are mapped to text/plain.

Parameters:

directoryName - one of a fixed set of directory names

Returns:

mime type for a code resource

getAnnotation

public static java.lang.String getAnnotation(java.lang.String filename)

Derive annotation from pseudo filename.

Parameters:

filename - pseudo file name for code resource

Returns:

annotation value for a code resource derived from the filename

updateCode

public static void updateCode(MutableBeanFactory beanFactory,
                              org.tangram.content.CodeResourceCache codeResourceCache,
                              java.lang.String mimetype,
                              java.lang.String filename,
                              byte[] contents,
                              long modificationTime)
                       throws java.lang.Exception

Update or create a code entry in the repository. This one really takes too many parameters, but presents common code for ftp access and tool handler to deal with updating of codes.

Parameters:

beanFactory - mutable bean factory to be used

codeResourceCache - code resource cache instance to fetch existing items from

mimetype - mimetype of the code item

filename - filename of the file describing the code item

contents - contents in UTF-8 encoded characters

modificationTime - time of last modification of the code item in milliseconds since the epoche

Throws:

java.lang.Exception - IO and class lookup related exceptions may occur but are unlikely