public class

BucketWebsiteConfiguration

extends Object
implements Serializable
java.lang.Object
   ↳ org.mule.module.s3.model.BucketWebsiteConfiguration

Summary

Constants
long serialVersionUID
Fields
private String errorDocument The complete path to the document to serve for 4xx errors.
private String indexDocumentSuffix The document to serve when a directory is specified (ex: index.html).
private RedirectRule redirectAllRequestsTo Container for redirect information where all requests will be redirect to.
private List<RoutingRule> routingRules The list of routing rules that can be used for configuring redirects if certain conditions are meet.
Public Constructors
BucketWebsiteConfiguration()
Creates a new BucketWebsiteConfiguration.
BucketWebsiteConfiguration(String indexDocumentSuffix)
Creates a new BucketWebsiteConfiguration with the specified index document suffix.
BucketWebsiteConfiguration(String indexDocumentSuffix, String errorDocument)
Creates a new BucketWebsiteConfiguration with the specified index document suffix and error document.
Public Methods
String getErrorDocument()
Returns the complete path to the document to serve for 4xx errors, or null if no error document has been configured.
String getIndexDocumentSuffix()
Returns the document to serve when a directory is specified (ex: index.html).
RedirectRule getRedirectAllRequestsTo()
Return the redirect information where all requests will be redirect to.
List<RoutingRule> getRoutingRules()
Return the list of routing rules that can be used for configuring redirects if certain conditions are meet.
void setErrorDocument(String errorDocument)
Sets the complete path to the document to serve for 4xx errors.
void setIndexDocumentSuffix(String indexDocumentSuffix)
Sets the document to serve when a directory is specified (ex: index.html).
void setRedirectAllRequestsTo(RedirectRule redirectAllRequestsTo)
Sets the redirect information where all requests will be redirect to.
void setRoutingRules(List<RoutingRule> routingRules)
Set the list of routing rules that can be used for configuring redirects if certain conditions are meet.
BucketWebsiteConfiguration withRedirectAllRequestsTo(RedirectRule redirectAllRequestsTo)
Sets the redirect information where all requests will be redirect to and returns a reference to this object(BucketWebsiteConfiguration) for method chaining.
BucketWebsiteConfiguration withRoutingRules(List<RoutingRule> routingRules)
Set the list of routing rules that can be used for configuring redirects if certain conditions are meet and returns a reference to this object(BucketWebsiteConfiguration) for method chaining.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

private static final long serialVersionUID

Constant Value: 4830454719255515406 (0x430938f96cd5910e)

Fields

private String errorDocument

The complete path to the document to serve for 4xx errors.

private String indexDocumentSuffix

The document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.

private RedirectRule redirectAllRequestsTo

Container for redirect information where all requests will be redirect to. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return. .

private List<RoutingRule> routingRules

The list of routing rules that can be used for configuring redirects if certain conditions are meet.

Public Constructors

public BucketWebsiteConfiguration ()

Creates a new BucketWebsiteConfiguration.

public BucketWebsiteConfiguration (String indexDocumentSuffix)

Creates a new BucketWebsiteConfiguration with the specified index document suffix.

Parameters
indexDocumentSuffix The document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.

public BucketWebsiteConfiguration (String indexDocumentSuffix, String errorDocument)

Creates a new BucketWebsiteConfiguration with the specified index document suffix and error document.

Parameters
indexDocumentSuffix The document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.
errorDocument The complete path to the document to serve for 4xx errors.

Public Methods

public String getErrorDocument ()

Returns the complete path to the document to serve for 4xx errors, or null if no error document has been configured.

Returns
  • The complete path to the document to serve for 4xx errors, or null if no error document has been configured.

public String getIndexDocumentSuffix ()

Returns the document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.

Returns
  • The document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.

public RedirectRule getRedirectAllRequestsTo ()

Return the redirect information where all requests will be redirect to.

public List<RoutingRule> getRoutingRules ()

Return the list of routing rules that can be used for configuring redirects if certain conditions are meet.

public void setErrorDocument (String errorDocument)

Sets the complete path to the document to serve for 4xx errors.

Parameters
errorDocument The complete path to the document to serve for 4xx errors.

public void setIndexDocumentSuffix (String indexDocumentSuffix)

Sets the document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.

Parameters
indexDocumentSuffix The document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.

public void setRedirectAllRequestsTo (RedirectRule redirectAllRequestsTo)

Sets the redirect information where all requests will be redirect to.

Parameters
redirectAllRequestsTo The Redirect information where all requests will be redirect to.

public void setRoutingRules (List<RoutingRule> routingRules)

Set the list of routing rules that can be used for configuring redirects if certain conditions are meet.

Parameters
routingRules The list of routing rules that can be used for configuring redirects.

public BucketWebsiteConfiguration withRedirectAllRequestsTo (RedirectRule redirectAllRequestsTo)

Sets the redirect information where all requests will be redirect to and returns a reference to this object(BucketWebsiteConfiguration) for method chaining.

Parameters
redirectAllRequestsTo The Redirect information where all requests will be redirect to.
Returns
  • a reference to this object(BucketWebsiteConfiguration) for method chaining.

public BucketWebsiteConfiguration withRoutingRules (List<RoutingRule> routingRules)

Set the list of routing rules that can be used for configuring redirects if certain conditions are meet and returns a reference to this object(BucketWebsiteConfiguration) for method chaining.

Parameters
routingRules The list of routing rules that can be used for configuring redirects.
Returns
  • A reference to this object(BucketWebsiteConfiguration) for method chaining.