ddf.catalog.resource.data

Class ReliableResource

java.lang.Object

ddf.catalog.resource.data.ReliableResource

All Implemented Interfaces:

BinaryContent, Resource, Serializable

public class ReliableResource
extends Object
implements Resource, Serializable

The resource that will be stored in the ResourceCacheImpl cache map.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReliableResource(String key, String filePath, MimeType mimeType, String name, Metacard metacard)

Method Summary

Modifier and Type	Method and Description
byte[]	getByteArray() Deprecated.
String	getFilePath()
InputStream	getInputStream() Gets the input stream.
String	getKey() Key is also filename of where file is stored.
long	getLastTouchedMillis()
Metacard	getMetacard()
MimeType	getMimeType()
String	getMimeTypeValue() Gets the String format MimeType
String	getName() Gets the name of the Resource.
long	getSize() Get the size if known.
boolean	hasProduct() Returns true if the product file exists in the product cache directory.
void	setLastTouchedMillis(long lastTouchedMillis)
void	setMimeType(MimeType mimeType)
void	setName(String name)
void	setSize(long size)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReliableResource

public ReliableResource(String key,
                        String filePath,
                        MimeType mimeType,
                        String name,
                        Metacard metacard)

Method Detail

getFilePath

public String getFilePath()

getKey

public String getKey()

Key is also filename of where file is stored.

Returns:

key

getByteArray

@Deprecated
public byte[] getByteArray()
                                throws IOException

Deprecated.

Description copied from interface: BinaryContent

Convenience method to attempt to read the contents of the InputStream into a byte array.

Note that BinaryContent.getByteArray() should be idempotent if BinaryContent.getInputStream() has not been initially invoked.

Specified by:

getByteArray in interface BinaryContent

Returns:

byte[]

Throws:

IOException - if the stream can not be read into the array

getInputStream

public InputStream getInputStream()

Gets the input stream.

Note that the binary from the InputStream can only be accessed once. Thus, when you call BinaryContent.getInputStream() and retrieve the InputStream object, it can only be used once to extract the content. If it is necessary that the bytes of the InputStream object are needed again, use the BinaryContent.getByteArray() method instead. Creates a new inputStream upon request.

Specified by:

getInputStream in interface BinaryContent

Returns:

InputStream of the product, otherwise null if could not be retrieved.

hasProduct

public boolean hasProduct()

Returns true if the product file exists in the product cache directory.

Returns:

getMimeType

public MimeType getMimeType()

Specified by:

getMimeType in interface BinaryContent

Returns:

the mime type of the information in the InputStream

setMimeType

public void setMimeType(MimeType mimeType)

getMimeTypeValue

public String getMimeTypeValue()

Description copied from interface: BinaryContent

Gets the String format MimeType

Specified by:

getMimeTypeValue in interface BinaryContent

Returns:

the mime type as a String

getSize

public long getSize()

Description copied from interface: BinaryContent

Get the size if known.

Specified by:

getSize in interface BinaryContent

Returns:

the amount of bytes as a long, -1 if unknown

setSize

public void setSize(long size)

getName

public String getName()

Description copied from interface: Resource

Gets the name of the Resource. Examples of this are the name of a file or the title of the Resource URL.

Specified by:

getName in interface Resource

Returns:

the name of the Resource. Null if the name is unknown

setName

public void setName(String name)

toString

public String toString()

Overrides:

toString in class Object

getLastTouchedMillis

public long getLastTouchedMillis()

setLastTouchedMillis

public void setLastTouchedMillis(long lastTouchedMillis)

getMetacard

public Metacard getMetacard()