org.jclouds.cloudfiles

Interface CloudFilesClient

All Superinterfaces:

CommonSwiftClient, SwiftClient

public interface CloudFilesClient
extends SwiftClient

Provides access to Cloud Files via their REST API.

Author:

Adrian Cole

See Also:

Cloud Files

Method Summary

Methods

Modifier and Type	Method and Description
boolean	disableCDN(String container) Remove the container from the CDN.
URI	enableCDN(String container)
URI	enableCDN(String container, long ttl)
URI	enableCDN(String container, long ttl, boolean logRetention) Before a container can be CDN-enabled, it must exist in the storage system.
ContainerCDNMetadata	getCDNMetadata(String container) Get the CDN attributes of the container.
Set<ContainerCDNMetadata>	listCDNContainers(ListCdnContainerOptions... options) Retrieve a list of existing CDN-enabled containers.
boolean	purgeCDNObject(String container, String object)
boolean	purgeCDNObject(String container, String object, Iterable<String> emails) You can purge a CDN-enabled object when you find it absolutely necessary to remove the object from public access and you cannot wait for the TTL to expire.
boolean	setCDNStaticWebsiteError(String container, String error) You may create and set custom error pages for visitors to your website; currently, only 401 (Unauthorized) and 404 (Not Found) errors are supported.
boolean	setCDNStaticWebsiteIndex(String container, String index) You may use your Cloud Files account to create a static website on the World Wide Web.
URI	updateCDN(String container, boolean logRetention)
URI	updateCDN(String container, long ttl)
URI	updateCDN(String container, long ttl, boolean logRetention)

Methods inherited from interface org.jclouds.openstack.swift.CommonSwiftClient

containerExists, copyObject, createContainer, createContainer, deleteContainerIfEmpty, deleteContainerMetadata, getAccountStatistics, getContainerMetadata, getObject, getObjectInfo, listContainers, listObjects, newSwiftObject, objectExists, putObject, putObjectManifest, removeObject, setContainerMetadata, setObjectInfo

Method Detail

listCDNContainers

Set<ContainerCDNMetadata> listCDNContainers(ListCdnContainerOptions... options)

Retrieve a list of existing CDN-enabled containers.

getCDNMetadata

ContainerCDNMetadata getCDNMetadata(String container)

Get the CDN attributes of the container. If the container is (or ever has been) CDN-enabled, the URL, TTL, enabled status, and log retention status are returned in the response headers. Its CDN URL can be combined with any object name within the container to form the publicly accessible URL for that object for distribution over a CDN system. The TTL value is the number of seconds that the object will be cached in the CDN system before being refetched. The enabled status indicates whether the container is currently marked to allow public serving of objects via CDN. The log_retention setting specifies whether the CDN access logs should be collected and stored in the Cloud Files storage system.

enableCDN

URI enableCDN(String container,
            long ttl,
            boolean logRetention)

Before a container can be CDN-enabled, it must exist in the storage system. When a container is CDN-enabled, any objects stored in it are publicly accessible over the Content Delivery Network by combining the container's CDN URL with the object name. Any CDN-accessed objects are cached in the CDN for the specified amount of time called the TTL, or Time to Live. The default TTL value is 259200 seconds, or 72 hours. Each time the object is accessed after the TTL expires, the CDN refetches and caches the object for the TTL period. You specify the TTL for an object via the ttl parameter. Setting the TTL is the same as setting the HTTP Expires and Cache-Control headers for the cached object. The minimum TTL is 15 minutes and the maximum is 1 year for a range of 900 to 31536000 seconds. Setting a TTL for a long time, however, does not guarantee that the content will stay populated on CDN edge servers for the entire period. The most popular objects stay cached based on the edge location's logic.

enableCDN

URI enableCDN(String container,
            long ttl)

See Also:

enableCDN(String, long, boolean)

enableCDN

URI enableCDN(String container)

See Also:

enableCDN(String, long, boolean)

updateCDN

URI updateCDN(String container,
            long ttl,
            boolean logRetention)

See Also:

enableCDN(String, long, boolean)

updateCDN

URI updateCDN(String container,
            boolean logRetention)

See Also:

enableCDN(String, long, boolean)

updateCDN

URI updateCDN(String container,
            long ttl)

See Also:

enableCDN(String, long, boolean)

disableCDN

boolean disableCDN(String container)

Remove the container from the CDN. Please note, however, that objects remain public until their TTL expires.

purgeCDNObject

boolean purgeCDNObject(String container,
                     String object,
                     Iterable<String> emails)

You can purge a CDN-enabled object when you find it absolutely necessary to remove the object from public access and you cannot wait for the TTL to expire. You should limit object purges to situations where there could be serious personal, business, or security consequences if it remained in the CDN. For example, someone published your company's quarterly earnings too early. You can manually purge CDN-enabled objects without having to wait for the TTL to expire, and you can optionally be notified by email that the object has been purged. However, you may only DELETE up to 25 objects per day. Any attempt to delete more than this will result in a 498 status code error (Rate Limited). There are two ways you may purge objects from the edge: (1) individually using purgeCDNObject() in the API or (2) by creating a support ticket to purge entire containers. The 25-object limit does not apply when purging an entire container via Support.

purgeCDNObject

boolean purgeCDNObject(String container,
                     String object)

See Also:

purgeCDNObject(String, String, Iterable)

setCDNStaticWebsiteIndex

boolean setCDNStaticWebsiteIndex(String container,
                               String index)

You may use your Cloud Files account to create a static website on the World Wide Web. First, you must CDN-enable a storage container. Any HTML or static web pages in the container will become available through a static website once you set the parameter index to "index.html" or other index page of your choice. You may also create subdirectories in your website by creating pseudo-directories (objects with a '/' in the name). The page you set for index becomes the index page for every subdirectory in your website; each of your pseudo-directories should contain a file with that name. So, if you set index to "index.html", you should have an index.html page in each pseudo-directory. If you do not have the named index page, visits to myhost/subdir/ will return a 404 error. To setup a domain name for your static website, create a CNAME with your DNS Server (or name server). This is the domain name of your site (such as www.example.com). Your CNAME is set up with your individual DNS Server, which is outside the scope of this documentation. Once you have your CNAME established, map your domain name to your Cloud Files CDN URL to get your site up and running on the Web.

setCDNStaticWebsiteError

boolean setCDNStaticWebsiteError(String container,
                               String error)

You may create and set custom error pages for visitors to your website; currently, only 401 (Unauthorized) and 404 (Not Found) errors are supported. To do this, set the error parameter. Error pages are served with the code prepended to the name of the error page you set. For instance, if you set error to "error.html", 401 errors will display the page 401error.html. Similarly, 404 errors will display 404error.html. You must have both of these pages created in your container when you set the error parameter, or your site will display generic error pages. You need only set the error parameter once for your entire static website.