com.jcabi.s3

Interface Bucket

All Superinterfaces:

Comparable<Bucket>

All Known Implementing Classes:

Bucket.Prefixed, CdBucket, MkBucket, ReBucket

@Immutable
public interface Bucket
extends Comparable<Bucket>

Amazon S3 bucket.

You get an instance of this interface from Region, for example:

 Region region = new Region.Simple(key, secret);
 Bucket bucket = region.bucket("my.example.com");
 for (String key : bucket.list("")) {
   System.out.println(
     "key: " + key + ", last modified: "
     + bucket.get(key).meta().getLastModified()
   );
 }

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Bucket.Prefixed Prefixed.

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<String>	list(String pfx) List object names with a given prefix.
String	name() Get bucket name.
Ocket	ocket(String key) Get object.
Region	region() Get region we're in.
void	remove(String key) Delete object from bucket.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

region

@NotNull(message="region is never NULL")
Region region()

Get region we're in.

Returns:

Region

name

@NotNull(message="bucket name is never NULL")
String name()

Get bucket name.

Returns:

Bucket name

ocket

@NotNull(message="ocket is never NULL")
Ocket ocket(@NotNull(message="S3 key can\'t be NULL")
                         String key)

Get object.

Parameters:

key - Name of it in the bucket

Returns:

Ocket

remove

void remove(@NotNull(message="S3 key can\'t be NULL")
          String key)
            throws IOException

Delete object from bucket.

Parameters:

key - Name of it in the bucket

Throws:

IOException - If not found or any other failure

list

Iterable<String> list(@NotNull(message="prefix can\'t be NULL")
                    String pfx)
                      throws IOException

List object names with a given prefix.

Parameters:

pfx - Prefix to use

Returns:

Iterable of names

Throws:

IOException - If fails

Since:

0.3