BinaryPage (Hippo Site Toolkit 4.1.0 API)

java.lang.Object
- org.hippoecm.hst.servlet.utils.BinaryPage

All Implemented Interfaces:

Serializable
```
public class BinaryPage
extends Object
implements Serializable
```
A Serializable representation of a resource from the repository as a html page. The binary page uses the absolute resource path as identifier. The binary data is optionally stored in a byte array. When done so the binary must be able to fit in memory.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BinaryPage.CacheKey

Nested Classes
Modifier and Type	Class and Description
`static class`	`BinaryPage.CacheKey`

Constructor Summary

Constructors
Constructor and Description

BinaryPage(String resourcePath)
Create a new binary page.

Constructors
Constructor and Description
`BinaryPage(String resourcePath)` Create a new binary page.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsData()` Check if the BinaryPage also contains the data next to the meta data.
`boolean`	`equals(Object o)`
`BinaryPage.CacheKey`	`getCacheKey()`
`long`	`getCreationTime()` Get the time the binary page cache object was create in milliseconds since epoch.
`String`	`getETag()` Get the ETag
`String`	`getFileName()` Get the unencoded file name to be used for Content-Disposition header
`long`	`getLastModified()` Get the last modified date in milliseconds since epoch.
`long`	`getLength()` Get the data length which can be used for the Content-Length header or cache checks.
`String`	`getMimeType()` Get the mime type for the resource.
`long`	`getNextValidityCheckTimeStamp()` Get the next Validity Check TimeStamp (millis since epoch)
`String`	`getRepositoryPath()` Gets the absolute path of the repository.
`String`	`getResourcePath()`
`int`	`getStatus()` Get the HTTP status for the resource.
`InputStream`	`getStream()` Get the `InputStream` to the byte buffer of the data.
`int`	`hashCode()`
`boolean`	`isCacheable()`
`void`	`loadDataFromStream(InputStream input)` Read the data from the input stream and close the stream when done.
`void`	`setCacheable(boolean cacheable)`
`void`	`setCacheKey(BinaryPage.CacheKey cacheKey)`
`void`	`setFileName(String fileName)` Set the (un-encoded) file name for the Content-Disposition header.
`void`	`setLastModified(long lastModified)` Set the last modification time in milliseconds since epoch.
`void`	`setLength(long length)` Set the size of the binary data.
`void`	`setMimeType(String mimeType)` Set the mime type.
`void`	`setNextValidityCheckTime(long nextValidityCheckTimeStamp)` Set the next validity check timestamp since epoch.
`void`	`setRepositoryPath(String repositoryPath)` Sets the absolute path of the repository.
`void`	`setStatus(int status)` Set the HTTP status.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BinaryPage
```
public BinaryPage(String resourcePath)
```
    Create a new binary page. This will just create the page holder. The fields have to be set explicitly after the object creation.
    
    Parameters:
    
    resourcePath - the absolute path of the resource in the repository.
- Method Detail
  - getResourcePath
```
public String getResourcePath()
```
    Returns:
    
    the absolute path
  - getRepositoryPath
```
public String getRepositoryPath()
```
    Gets the absolute path of the repository. Note that this can be different than getResourcePath() in case when there are resourceContainers that modify the resourcePath to a different repository path
    
    Returns:
    
    the absolute repository path
  - setRepositoryPath
```
public void setRepositoryPath(String repositoryPath)
```
    Sets the absolute path of the repository. Note that this can be a different path than getResourcePath() in case when there are resourceContainers that modify the resourcePath to a different repository path
  - getStatus
```
public int getStatus()
```
    Get the HTTP status for the resource.
    
    Returns:
    
    the HTTP status
  - getMimeType
```
public String getMimeType()
```
    Get the mime type for the resource. Could be null.
    
    Returns:
    
    the mime type or null when unknown.
  - getFileName
```
public String getFileName()
```
    Get the unencoded file name to be used for Content-Disposition header
    
    Returns:
    
    the file name or null when not set.
  - getETag
```
public String getETag()
```
    Get the ETag
    
    Returns:
    
    the ETag
  - getLastModified
```
public long getLastModified()
```
    Get the last modified date in milliseconds since epoch.
    
    Returns:
    
    the last modified date or -1 if unknown
  - getCreationTime
```
public long getCreationTime()
```
    Get the time the binary page cache object was create in milliseconds since epoch.
    
    Returns:
    
    creation time
  - getNextValidityCheckTimeStamp
```
public long getNextValidityCheckTimeStamp()
```
    Get the next Validity Check TimeStamp (millis since epoch)
    
    Returns:
    
    the nextValidityCheckTimeStamp time
  - getLength
```
public long getLength()
```
    Get the data length which can be used for the Content-Length header or cache checks.
    
    Returns:
    
    the length of the binary data
  - containsData
```
public boolean containsData()
```
    Check if the BinaryPage also contains the data next to the meta data.
    
    Returns:
    
    true if the BinaryPage contains the data as well as the meta data
  - getStream
```
public InputStream getStream()
```
    Get the InputStream to the byte buffer of the data.
    
    Returns:
    
    the input stream
  - loadDataFromStream
```
public void loadDataFromStream(InputStream input)
                        throws IOException
```
    Read the data from the input stream and close the stream when done.
    
    Parameters:
    
    input - the input stream to read the data from.
    
    Throws:
    
    IOException - when an error occurs while copying. The stream will be closed.
  - isCacheable
```
public boolean isCacheable()
```
  - getCacheKey
```
public BinaryPage.CacheKey getCacheKey()
```
  - setStatus
```
public void setStatus(int status)
```
    Set the HTTP status. The status is not checked for validity.
    
    Parameters:
    
    status -
  - setMimeType
```
public void setMimeType(String mimeType)
```
    Set the mime type.
    
    Parameters:
    
    mimeType -
  - setFileName
```
public void setFileName(String fileName)
```
    Set the (un-encoded) file name for the Content-Disposition header.
    
    Parameters:
    
    fileName -
  - setNextValidityCheckTime
```
public void setNextValidityCheckTime(long nextValidityCheckTimeStamp)
```
    Set the next validity check timestamp since epoch.
    
    Parameters:
    
    nextValidityCheckTimeStamp -
  - setLastModified
```
public void setLastModified(long lastModified)
```
    Set the last modification time in milliseconds since epoch.
    
    Parameters:
    
    lastModified -
  - setLength
```
public void setLength(long length)
```
    Set the size of the binary data. This method should only be used when the data is not stored in the BinaryData object.
    
    Parameters:
    
    length - the length of the data.
  - setCacheable
```
public void setCacheable(boolean cacheable)
```
  - setCacheKey
```
public void setCacheKey(BinaryPage.CacheKey cacheKey)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class BinaryPage

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BinaryPage

Method Detail

getResourcePath

getRepositoryPath

setRepositoryPath

getStatus

getMimeType

getFileName

getETag

getLastModified

getCreationTime

getNextValidityCheckTimeStamp

getLength

containsData

getStream

loadDataFromStream

isCacheable

getCacheKey

setStatus

setMimeType

setFileName

setNextValidityCheckTime

setLastModified

setLength

setCacheable

setCacheKey

toString

equals

hashCode