org.jboss.as.repository

Interface ContentRepository

All Known Implementing Classes:

SelfContainedContentRepository

public interface ContentRepository

Repository for deployment content and other managed content.

Author:

John Bailey

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ContentRepository.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELETED_CONTENT
static String	MARKED_CONTENT
static long	OBSOLETE_CONTENT_TIMEOUT Time after which a marked obsolete content will be removed.
static org.jboss.msc.service.ServiceName	SERVICE_NAME Standard ServiceName under which a service controller for an instance of

Method Summary

Modifier and Type	Method and Description
byte[]	addContent(InputStream stream) Add the given content to the repository along with a reference tracked by name.
void	addContentReference(ContentReference reference) Adds a reference to the content.
Map<String,Set<String>>	cleanObsoleteContent() Clean content that is not referenced from the repository.
org.jboss.vfs.VirtualFile	getContent(byte[] hash) Get the content as a virtual file.
boolean	hasContent(byte[] hash) Gets whether content with the given hash is stored in the repository.
void	removeContent(ContentReference reference) Remove the given content from the repository.
boolean	syncContent(ContentReference reference) Synchronize content with the given reference.

Field Detail

SERVICE_NAME

static final org.jboss.msc.service.ServiceName SERVICE_NAME

Standard ServiceName under which a service controller for an instance of

OBSOLETE_CONTENT_TIMEOUT

static final long OBSOLETE_CONTENT_TIMEOUT

Time after which a marked obsolete content will be removed. Currently 5 minutes.

DELETED_CONTENT

static final String DELETED_CONTENT

See Also:

Constant Field Values

MARKED_CONTENT

static final String MARKED_CONTENT

See Also:

Constant Field Values

Method Detail

addContent

byte[] addContent(InputStream stream)
           throws IOException

Add the given content to the repository along with a reference tracked by name.

Parameters:

stream - stream from which the content can be read. Cannot be null

Returns:

the hash of the content that will be used as an internal identifier for the content. Will not be null

Throws:

IOException - if there is a problem reading the stream

addContentReference

void addContentReference(ContentReference reference)

Adds a reference to the content.

Parameters:

reference - a reference to the content to be referenced. This is also used in removeContent(ContentReference reference)

getContent

org.jboss.vfs.VirtualFile getContent(byte[] hash)

Get the content as a virtual file.

Parameters:

hash - the hash. Cannot be null

Returns:

the content as a virtual file

hasContent

boolean hasContent(byte[] hash)

Gets whether content with the given hash is stored in the repository.

Parameters:

hash - the hash. Cannot be null

Returns:

true if the repository has content with the given hash.

syncContent

boolean syncContent(ContentReference reference)

Synchronize content with the given reference. This may be used in favor of hasContent(byte[]) to explicitly allow additional operations to synchronize the local content with some external repository.

Parameters:

reference - the reference to be synchronized. Cannot be null

Returns:

true if the repository has content with the given reference

removeContent

void removeContent(ContentReference reference)

Remove the given content from the repository. Remove the given content from the repository. The reference will be removed, and if there are no references left the content will be totally removed.

Parameters:

reference - a reference to the content to be unreferenced. This is also used in addContentReference(ContentReference reference)

cleanObsoleteContent

Map<String,Set<String>> cleanObsoleteContent()

Clean content that is not referenced from the repository. Remove the contents that are no longer referenced from the repository.

Returns:

the list of obsolete contents that were removed and the list of obsolete contents that were marked to be removed.