org.ametys.cms.data

Class Resource

java.lang.Object

org.ametys.cms.data.Resource

Direct Known Subclasses:

NamedResource, RichText

public class Resource
extends Object

Class representing a resource

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	_buffer Buffer for small-sized data
protected String	_encoding The resource's encoding
protected ZonedDateTime	_lastModificationDate The resource's last modification date
protected String	_mimeType The resource's mime type
protected RepositoryData	_repositoryData The resource's repository data
protected File	_tmpFile Underlying tmp file
private static byte[]	EMPTY_BYTE_ARRAY Empty array
private static int	MAX_BUFFER_SIZE Max size for keeping temporary data in memory

Constructor Summary

Constructors

Constructor and Description
Resource() Default constructor
Resource(RepositoryData repositoryData) Constructor to use when reading the resource from the repository

Method Summary

Modifier and Type	Method and Description
protected void	closeOutputStream(ByteArrayOutputStream outputStream) Closes the given OutputStream
String	getEncoding() Retrieves the encoding of the resource's data
InputStream	getInputStream() Retrieve the resource's data If the data has already been read, the stream is reseted so it can be read again from the start
ZonedDateTime	getLastModificationDate() Retrieves the last modification date of the resource's data
long	getLength() Retrieves the length of the resource's data
String	getMimeType() Retrieves the mime type of the resource's data
OutputStream	getOutputStream() Retrieves an output stream that allows to modify the resource's data
void	setEncoding(String encoding) Sets the encoding of the resource's data
void	setInputStream(InputStream in) Sets the resource's data
void	setLastModificationDate(ZonedDateTime lastModificationDate) Sets the last modification date of the resource's data
void	setMimeType(String mimeType) Sets the mime type of the resource's data

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_BYTE_ARRAY

private static final byte[] EMPTY_BYTE_ARRAY

Empty array

MAX_BUFFER_SIZE

private static final int MAX_BUFFER_SIZE

Max size for keeping temporary data in memory

See Also:

Constant Field Values

_mimeType

protected String _mimeType

The resource's mime type

_encoding

protected String _encoding

The resource's encoding

_lastModificationDate

protected ZonedDateTime _lastModificationDate

The resource's last modification date

_tmpFile

protected File _tmpFile

Underlying tmp file

_buffer

protected byte[] _buffer

Buffer for small-sized data

_repositoryData

protected RepositoryData _repositoryData

The resource's repository data

Constructor Detail

Resource

public Resource()

Default constructor

Resource

public Resource(RepositoryData repositoryData)

Constructor to use when reading the resource from the repository

Parameters:

repositoryData - the repository data containing the resource's data

Method Detail

getInputStream

public InputStream getInputStream()
                           throws AmetysRepositoryException

Retrieve the resource's data If the data has already been read, the stream is reseted so it can be read again from the start

Returns:

the resource's data, or null if there is no data

Throws:

AmetysRepositoryException - if an error occurs while reading the data in the repository

getLength

public long getLength()
               throws AmetysRepositoryException

Retrieves the length of the resource's data

Returns:

the length of the resource's data

Throws:

AmetysRepositoryException - if an error occurs while reading the data in the repository

setInputStream

public void setInputStream(InputStream in)
                    throws IOException

Sets the resource's data

Parameters:

in - the data to set

Throws:

IOException - if an error occurs while reading the input stream

getOutputStream

public OutputStream getOutputStream()

Retrieves an output stream that allows to modify the resource's data

Returns:

the output stream

closeOutputStream

protected void closeOutputStream(ByteArrayOutputStream outputStream)
                          throws IOException

Closes the given OutputStream

Parameters:

outputStream - the OutputStream to close

Throws:

IOException - if an error occurs while registering the stream

getMimeType

public String getMimeType()

Retrieves the mime type of the resource's data

Returns:

the mime type of the resource's data

setMimeType

public void setMimeType(String mimeType)

Sets the mime type of the resource's data

Parameters:

mimeType - the mime type to set

getEncoding

public String getEncoding()

Retrieves the encoding of the resource's data

Returns:

the encoding of the resource's data

setEncoding

public void setEncoding(String encoding)

Sets the encoding of the resource's data

Parameters:

encoding - the encoding to set

getLastModificationDate

public ZonedDateTime getLastModificationDate()

Retrieves the last modification date of the resource's data

Returns:

the last modification date of the resource's data

setLastModificationDate

public void setLastModificationDate(ZonedDateTime lastModificationDate)

Sets the last modification date of the resource's data

Parameters:

lastModificationDate - the last modification date to set