org.javaswift.joss.model

Interface Website

All Superinterfaces:

Comparable<Container>, Container, ListHolder<StoredObject>, ListSubject, ObjectStoreEntity

All Known Implementing Classes:

AbstractWebsite, WebsiteImpl, WebsiteMock

public interface Website
extends Container

A Website is a specialization of Container. The content in this Container acts as a static website. The objects within are set up using pseudo-hierarchies, meaning that object names include the full path after Container.

Author:

Robert Bor

Method Summary

Modifier and Type	Method and Description
StoredObject	getErrorPage() Gets the error page of the website.
String	getHost() Get the original host, which is a combination of the container and the original (non-configured) public host.
StoredObject	getIndexPage() Gets the index page of the website.
StoredObject	getListingCSS() Gets the CSS file to use for adding layout to the file listing.
boolean	isListing() If this value is true, the site will be shown as a file listing instead of a regular website
void	pullDirectory(File directory) Compares a local directory to the contents of the Container on the basis of MD5 hashes (ie, Etag).
void	pushDirectory(File directory) Compares a local directory to the contents of the Container on the basis of MD5 hashes (ie, Etag).
void	setErrorPage(StoredObject errorPage) Gets the error page of the website.
Website	setIgnoreFilters(String[] ignoreFilters) Passes a number of files and directories that must be ignored by the push/pull mechanism.
void	setIndexPage(StoredObject indexPage) Sets the index page of the website.
void	setListing(boolean listing) Sets whether the container must be shown as a listing.
void	setListingCSS(StoredObject listingCSS) Sets the CSS file to use for adding layout to the listing.

Methods inherited from interface org.javaswift.joss.model.Container

create, delete, exists, getAccount, getBytesUsed, getContainerReadPermission, getcontainerWritePermission, getCount, getCustomHeaders, getFormPost, getObject, getObjectSegment, isInfoRetrieved, isPublic, listDirectory, listDirectory, listDirectory, makePrivate, makePublic, reload, setBytesUsed, setContainerRights, setCount, setCustomHeaders

Methods inherited from interface org.javaswift.joss.model.ObjectStoreEntity

getMetadata, getMetadata, getPath, removeAndDoNotSaveMetadata, removeAndSaveMetadata, saveMetadata, setAndDoNotSaveMetadata, setAndSaveMetadata, setMetadata

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.javaswift.joss.model.ListHolder

getMaxPageSize, getPaginationMap, getPaginationMap, list, list, list

Methods inherited from interface org.javaswift.joss.model.ListSubject

getName, metadataSetFromHeaders

Method Detail

getIndexPage

StoredObject getIndexPage()

Gets the index page of the website. This is the page that is shown by default

Returns:

index page of the website

getErrorPage

StoredObject getErrorPage()

Gets the error page of the website. This is the page that is shown when an error occurs

Returns:

error page of the website

isListing

boolean isListing()

If this value is true, the site will be shown as a file listing instead of a regular website

Returns:

whether the site should be shown as a listing

getListingCSS

StoredObject getListingCSS()

Gets the CSS file to use for adding layout to the file listing. Only used if the site is shown as a listing

Returns:

the CSS file to use for the listing

setIndexPage

void setIndexPage(StoredObject indexPage)

Sets the index page of the website. This is the page that is shown by default

Parameters:

indexPage - index page of the website

setErrorPage

void setErrorPage(StoredObject errorPage)

Gets the error page of the website. This is the page that is shown when an error occurs

Parameters:

errorPage - error page of the website

setListing

void setListing(boolean listing)

Sets whether the container must be shown as a listing. If false, the container acts as a static website. The default is false

Parameters:

listing - true, the container is a listing, false, the container is static website

setListingCSS

void setListingCSS(StoredObject listingCSS)

Sets the CSS file to use for adding layout to the listing. Only used if the Container is a listing.

Parameters:

listingCSS - CSS file

getHost

String getHost()

Get the original host, which is a combination of the container and the original (non-configured) public host. This host can be used to configure a CNAME in your DNS settings.

Returns:

host of the website

pushDirectory

void pushDirectory(File directory)

Compares a local directory to the contents of the Container on the basis of MD5 hashes (ie, Etag). It makes a couple of potentially far-reaching decision, so be careful:

• Content exists locally, not in Container; copy to Container
• Content does not exist locally, exists in Container; delete from Container
• Content exists in both places, but is different; overwrite file in Container

Parameters:

directory - the directory to check against the Container's content

pullDirectory

void pullDirectory(File directory)

Compares a local directory to the contents of the Container on the basis of MD5 hashes (ie, Etag). It makes a couple of potentially far-reaching decision, so be careful:

• Content exists in Container, not locally; download locally
• Content does not exist in Container, exists locally; delete locally
• Content exists in both places, but is different; overwrite local file

Parameters:

directory - the directory to check against the Container's content

setIgnoreFilters

Website setIgnoreFilters(String[] ignoreFilters)

Passes a number of files and directories that must be ignored by the push/pull mechanism. Use normal path notation using the root directory as the root path.

Parameters:

ignoreFilters - files/directories to be ignored

Returns:

instance of Website