org.eclipse.dirigible.repository.api

Interface IResource

All Superinterfaces:

IEntity

public interface IResource
extends IEntity

The IResource interface represents a resource located in the repository.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE_DEFAULT The default content type - text/plain.

Method Summary

Modifier and Type	Method and Description
byte[]	getContent() Returns the content of the resource as a byte array.
String	getContentType() Getter for the content type.
IResourceVersion	getResourceVersion(int version) Retrieve a particular version of a given resource.
List<IResourceVersion>	getResourceVersions() Retrieve all the kept versions of a given resource.
boolean	isBinary() Getter for binary flag.
void	setContent(byte[] content) Sets this resource's content.
void	setContent(byte[] content, boolean isBinary, String contentType) Sets this resource's content.

Methods inherited from interface org.eclipse.dirigible.repository.api.IEntity

copyTo, create, delete, exists, getInformation, getName, getParent, getPath, getRepository, isEmpty, moveTo, renameTo

Field Detail

CONTENT_TYPE_DEFAULT

static final String CONTENT_TYPE_DEFAULT

The default content type - text/plain.

See Also:

Constant Field Values

Method Detail

getContent

byte[] getContent()
           throws RepositoryReadException

Returns the content of the resource as a byte array.

Returns:

the raw content

Throws:

RepositoryReadException - in case the content cannot be retrieved

setContent

void setContent(byte[] content)
         throws RepositoryWriteException

Sets this resource's content.

Parameters:

content - the raw content

Throws:

RepositoryWriteException - the repository write exception

setContent

void setContent(byte[] content,
                boolean isBinary,
                String contentType)
         throws RepositoryWriteException

Sets this resource's content.

Parameters:

content - the raw content

isBinary - whether it is binary

contentType - the type of the content

Throws:

RepositoryWriteException - in case the content of the IResource cannot be retrieved

isBinary

boolean isBinary()

Getter for binary flag.

Returns:

whether it is binary

getContentType

String getContentType()

Getter for the content type.

Returns:

the type of the content

getResourceVersions

List<IResourceVersion> getResourceVersions()
                                    throws RepositoryVersioningException

Retrieve all the kept versions of a given resource.

Returns:

the list of the IResourceVersion for this {link IResource}

Throws:

RepositoryVersioningException - the repository versioning exception

getResourceVersion

IResourceVersion getResourceVersion(int version)
                             throws RepositoryVersioningException

Retrieve a particular version of a given resource.

Parameters:

version - the exact version

Returns:

the IResourceVersion for this {link IResource} for this version

Throws:

RepositoryVersioningException - the repository versioning exception