com.ibm.cloud.objectstorage.services.s3.model

Class BucketPolicy

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.model.BucketPolicy

All Implemented Interfaces:

Serializable

public class BucketPolicy
extends Object
implements Serializable

Represents a Amazon S3 bucket policy. Bucket policies provide access control management at the bucket level for both the bucket resource and contained object resources. Only one policy may be specified per bucket.

Buckets have no policy text until one is explicitly specified. Requesting the bucket policy for a newly created bucket will return a policy object with null policy text.

See the Amazon S3 User Guide for more information on forming bucket polices.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BucketPolicy()

Method Summary

Modifier and Type	Method and Description
String	getPolicyText() Gets the raw policy JSON text as returned by Amazon S3.
void	setPolicyText(String policyText) Sets the raw policy JSON text.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BucketPolicy

public BucketPolicy()

Method Detail

getPolicyText

public String getPolicyText()

Gets the raw policy JSON text as returned by Amazon S3. If no policy has been applied to the specified bucket, the policy text will be null.

Returns:

The raw policy JSON text as returned by Amazon S3. If no policy has been applied to the specified bucket, this method returns null policy text.

See Also:

BucketPolicy.setPolicyText(String)

setPolicyText

public void setPolicyText(String policyText)

Sets the raw policy JSON text. A bucket will have no policy text unless the policy text is explicitly provided through this method.

Parameters:

policyText - The raw policy JSON text.

See Also:

BucketPolicy.getPolicyText()