org.jets3t.service.model
Class StorageBucketLoggingStatus

java.lang.Object
  extended by org.jets3t.service.model.StorageBucketLoggingStatus
Direct Known Subclasses:
GSBucketLoggingStatus, S3BucketLoggingStatus

public abstract class StorageBucketLoggingStatus
extends java.lang.Object

Represents Bucket Logging Status settings used to control bucket-based Server Access Logging in S3.

For logging to be enabled for a bucket both the targetBucketName and logfilePrefix must be non-null, and the named bucket must exist. When both variables are non-null, this object represents an enabled logging status (as indicated by isLoggingEnabled()) and the XML document generated by toXml() will enable logging for the named bucket when provided to S3Service.setBucketLoggingStatus(String, S3BucketLoggingStatus, boolean).

If either the targetBucketName or logfilePrefix are null, this object will represent a disabled logging status (as indicated by isLoggingEnabled()) and the XML document generated by toXml() will disable logging for the named bucket when provided to S3Service.setBucketLoggingStatus(String, S3BucketLoggingStatus, boolean).


Constructor Summary
StorageBucketLoggingStatus()
           
StorageBucketLoggingStatus(java.lang.String targetBucketName, java.lang.String logfilePrefix)
           
 
Method Summary
 java.lang.String getLogfilePrefix()
           
 java.lang.String getTargetBucketName()
           
 boolean isLoggingEnabled()
           
 void setLogfilePrefix(java.lang.String logfilePrefix)
           
 void setTargetBucketName(java.lang.String targetBucketName)
           
 java.lang.String toString()
           
 java.lang.String toXml()
           
abstract  com.jamesmurty.utils.XMLBuilder toXMLBuilder()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StorageBucketLoggingStatus

public StorageBucketLoggingStatus()

StorageBucketLoggingStatus

public StorageBucketLoggingStatus(java.lang.String targetBucketName,
                                  java.lang.String logfilePrefix)
Method Detail

isLoggingEnabled

public boolean isLoggingEnabled()

getLogfilePrefix

public java.lang.String getLogfilePrefix()

setLogfilePrefix

public void setLogfilePrefix(java.lang.String logfilePrefix)

getTargetBucketName

public java.lang.String getTargetBucketName()

setTargetBucketName

public void setTargetBucketName(java.lang.String targetBucketName)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toXml

public java.lang.String toXml()
                       throws ServiceException
Returns:
An XML representation of the object suitable for use as an input to the REST/HTTP interface.
Throws:
S3ServiceException
ServiceException

toXMLBuilder

public abstract com.jamesmurty.utils.XMLBuilder toXMLBuilder()
                                                      throws javax.xml.parsers.ParserConfigurationException,
                                                             javax.xml.parsers.FactoryConfigurationError,
                                                             javax.xml.transform.TransformerException
Throws:
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError
javax.xml.transform.TransformerException