mirror of https://github.com/apache/jclouds.git
Merge pull request #1123 from rackspace/rax-cdn-doc-fix
Fixed Javadoc for Rackspace Cloud Files CDN. Links were broken.
This commit is contained in:
Adrian Cole
commit
2fe9a60e56
|
|
@ -26,77 +26,124 @@ import org.jclouds.openstack.swift.CommonSwiftClient;
|
|||
|
||||
/**
|
||||
* Provides access to Cloud Files via their REST API.
|
||||
* <p/>
|
||||
* All commands return a Future of the result from Cloud Files. Any exceptions incurred during
|
||||
* processing will be backend in an {@link ExecutionException} as documented in {@link Future#get()}.
|
||||
*
|
||||
* @author Adrian Cole
|
||||
* @see <a href="http://www.rackspacecloud.com/cf-devguide-20090812.pdf" />
|
||||
* @see <a href="http://docs.rackspace.com/files/api/v1/cf-devguide/content/index.html">Cloud Files</a>
|
||||
*/
|
||||
public interface CloudFilesClient extends CommonSwiftClient {
|
||||
|
||||
/**
|
||||
* See http://docs.rackspace.com/files/api/v1/cf-devguide/content/List_CDN-Enabled_Containers-d1e2414.html
|
||||
* Retrieve a list of existing CDN-enabled containers.
|
||||
*/
|
||||
Set<ContainerCDNMetadata> listCDNContainers(ListCdnContainerOptions... options);
|
||||
|
||||
/**
|
||||
* See http://docs.rackspace.com/files/api/v1/cf-devguide/content/List_CDN-Enabled_Container_Metadata-d1e2711.html
|
||||
* 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.
|
||||
*/
|
||||
ContainerCDNMetadata getCDNMetadata(String container);
|
||||
|
||||
/**
|
||||
* See http://docs.rackspace.com/files/api/v1/cf-devguide/content/CDN-Enabled_Container-d1e2665.html
|
||||
* 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.
|
||||
*/
|
||||
URI enableCDN(String container, long ttl, boolean logRetention);
|
||||
|
||||
/**
|
||||
* See http://docs.rackspace.com/files/api/v1/cf-devguide/content/CDN-Enabled_Container-d1e2665.html
|
||||
* @see CloudFilesClient#enableCDN(String, long, boolean)
|
||||
*/
|
||||
URI enableCDN(String container, long ttl);
|
||||
|
||||
/**
|
||||
* See http://docs.rackspace.com/files/api/v1/cf-devguide/content/CDN-Enabled_Container-d1e2665.html
|
||||
* @see CloudFilesClient#enableCDN(String, long, boolean)
|
||||
*/
|
||||
URI enableCDN(String container);
|
||||
|
||||
/**
|
||||
* See http://docs.rackspace.com/files/api/v1/cf-devguide/content/Update_CDN-Enabled_Container_Metadata-d1e2787.html
|
||||
* @see CloudFilesClient#enableCDN(String, long, boolean)
|
||||
*/
|
||||
URI updateCDN(String container, long ttl, boolean logRetention);
|
||||
|
||||
/**
|
||||
* See http://docs.rackspace.com/files/api/v1/cf-devguide/content/Update_CDN-Enabled_Container_Metadata-d1e2787.html
|
||||
* @see CloudFilesClient#enableCDN(String, long, boolean)
|
||||
*/
|
||||
URI updateCDN(String container, boolean logRetention);
|
||||
|
||||
/**
|
||||
* See http://docs.rackspace.com/files/api/v1/cf-devguide/content/Update_CDN-Enabled_Container_Metadata-d1e2787.html
|
||||
* @see CloudFilesClient#enableCDN(String, long, boolean)
|
||||
*/
|
||||
URI updateCDN(String container, long ttl);
|
||||
|
||||
/**
|
||||
* See http://docs.rackspace.com/files/api/v1/cf-devguide/content/CDN-Enabled_Container-d1e2665.html
|
||||
* Remove the container from the CDN. Please note, however, that objects remain public until their TTL expires.
|
||||
*/
|
||||
boolean disableCDN(String container);
|
||||
|
||||
/**
|
||||
* See http://docs.rackspace.com/files/api/v1/cf-devguide/content/Purge_CDN-Enabled_Objects-d1e3858.html
|
||||
* 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.
|
||||
*/
|
||||
boolean purgeCDNObject(String container, String object, Iterable<String> emails);
|
||||
|
||||
/**
|
||||
* See http://docs.rackspace.com/files/api/v1/cf-devguide/content/Purge_CDN-Enabled_Objects-d1e3858.html
|
||||
* @see CloudFilesClient#purgeCDNObject(String, String, Iterable)
|
||||
*/
|
||||
boolean purgeCDNObject(String container, String object);
|
||||
|
||||
/**
|
||||
* http://docs.rackspace.com/files/api/v1/cf-devguide/content/Create_Static_Website-dle4000.html
|
||||
* 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.
|
||||
*/
|
||||
boolean setCDNStaticWebsiteIndex(String container, String index);
|
||||
|
||||
/**
|
||||
* http://docs.rackspace.com/files/api/v1/cf-devguide/content/Set_Error_Pages_for_Static_Website-dle4005.html
|
||||
* 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 <status> 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.
|
||||
*/
|
||||
boolean setCDNStaticWebsiteError(String container, String error);
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue