org.jets3t.service.model
Class S3BucketLoggingStatus

java.lang.Object
  extended by org.jets3t.service.model.S3BucketLoggingStatus

public class S3BucketLoggingStatus
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
S3BucketLoggingStatus()
           
S3BucketLoggingStatus(java.lang.String targetBucketName, java.lang.String logfilePrefix)
           
 
Method Summary
 void addTargetGrant(GrantAndPermission targetGrant)
           
 java.lang.String getLogfilePrefix()
           
 java.lang.String getTargetBucketName()
           
 GrantAndPermission[] getTargetGrants()
           
 boolean isLoggingEnabled()
           
 void setLogfilePrefix(java.lang.String logfilePrefix)
           
 void setTargetBucketName(java.lang.String targetBucketName)
           
 void setTargetGrants(GrantAndPermission[] targetGrants)
           
 java.lang.String toString()
           
 java.lang.String toXml()
           
 com.jamesmurty.utils.XMLBuilder toXMLBuilder()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

S3BucketLoggingStatus

public S3BucketLoggingStatus()

S3BucketLoggingStatus

public S3BucketLoggingStatus(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)

getTargetGrants

public GrantAndPermission[] getTargetGrants()

setTargetGrants

public void setTargetGrants(GrantAndPermission[] targetGrants)

addTargetGrant

public void addTargetGrant(GrantAndPermission targetGrant)

toString

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

toXml

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

toXMLBuilder

public 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