org.onehippo.cms7.services.webfiles

Interface WebFileBundle

public interface WebFileBundle

A collection of WebFiles, i.e. binary data objects. Each WebFile is identified by an absolute path starting at the WebFiles root. Paths start with a slash and consist of elements separated by slashes (e.g. "/css/style.css").

Method Summary

Modifier and Type	Method and Description
WebFile	create(String absPath, Binary content) Creates a new WebFile at the given location.
String	createTag() Creates a new tag for this entire WebFileBundle
void	delete(String absPath) Removes the WebFile at absPath
boolean	exists(String absPath)
WebFile	get(String absPath)
WebFile	get(String absPath, String tagName)
String	getAntiCacheValue()
String	getLatestTagName() e
List<String>	getTagNames()
WebFile	update(String absPath, Binary content) Updates the content of this WebFile.

Method Detail

exists

boolean exists(String absPath)

Parameters:

absPath - the absolute path to the WebFile, starting at the WebFiles root. The path must start with a slash.

Returns:

whether a WebFile exists at the given path.

get

WebFile get(String absPath)
     throws WebFileNotFoundException

Parameters:

absPath - the absolute path starting with a slash to the WebFile, relative to this WebFileBundle

Returns:

the WebFile head located at the given path.

Throws:

WebFileNotFoundException - if no WebFile exists at the given path.

create

WebFile create(String absPath,
               Binary content)
        throws WebFileException,
               IllegalArgumentException

Creates a new WebFile at the given location.

Parameters:

absPath - the absolute path starting with a slash to the WebFile, relative to this WebFileBundle

content - the content of the new WebFile.

Returns:

the created WebFile.

Throws:

WebFileException - if another (web) resource already exists at the given location.

IllegalArgumentException - if the given binary is null.

WebFileException - in case of insufficient authorization

update

WebFile update(String absPath,
               Binary content)
        throws WebFileNotFoundException,
               IllegalArgumentException

Updates the content of this WebFile.

Parameters:

absPath - the absolute path starting with a slash to the WebFile, relative to this WebFileBundle

content - the binary data to store.

Returns:

the updated WebFile

Throws:

WebFileNotFoundException - if no WebFile exists at the given path.

IllegalArgumentException - if the given binary is null.

WebFileException - in case of insufficient authorization

delete

void delete(String absPath)
     throws WebFileException

Removes the WebFile at absPath

Parameters:

absPath - the absolute path starting with a slash to the WebFile, relative to this WebFileBundle

Throws:

WebFileException - in case the delete did not occur, for example because the resource is not there any more, insufficient authorization, locking, etc

getLatestTagName

String getLatestTagName()
                 throws WebFileException

e

Returns:

the latest tagName or in case not yet tagged or tagging is not supported, return null

Throws:

WebFileException

getTagNames

List<String> getTagNames()
                  throws WebFileException

Returns:

The immutable List ordered list of tag names for this WebFileBundle or empty List in case there are no tags for this WebFileBundle or tagging is not supported (for this WebFileBundle)

Throws:

WebFileException

get

WebFile get(String absPath,
            String tagName)
     throws WebFileNotFoundException,
            WebFileTagNotFoundException

Parameters:

absPath - the absolute path to the WebFile, starting at the WebFiles root. The path must start with a slash when not null.

tagName - the WebFile for tagName. When tagName is null, the head WebFile is returned, the same as get(String)

Returns:

the WebFile tag located at the given path for tagName.

Throws:

WebFileNotFoundException - if no WebFile exists at the given path for tagName.

WebFileTagNotFoundException

createTag

String createTag()
          throws WebFileException

Creates a new tag for this entire WebFileBundle

Returns:

the name of the newly created tag

Throws:

WebFileException

getAntiCacheValue

String getAntiCacheValue()

Returns:

the anti-cache value of this WebFileBundle, useful to be able to cache resources in the client (browser) : Whenever the client needs new resources, the anti cache value changes resulting in different URLs for the resources. Only chars allowed are [a-z] and [0-9] to avoid encoding/decoding problems when used in URLs