org.waarp.openr66.s3

Class WaarpR66S3Client

java.lang.Object

org.waarp.openr66.s3.WaarpR66S3Client

public class WaarpR66S3Client
extends Object

Waarp R66 S3 Client

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUCKET_OR_SOURCE_CANNOT_BE_NULL_OR_EMPTY
static String	BUCKET_OR_TARGET_CANNOT_BE_NULL_OR_EMPTY
static String	S_3_ISSUE

Constructor Summary

Constructors

Constructor and Description
WaarpR66S3Client(String accessKey, String secretKey, URL endPointS3) Initialize context for S3 Client

Method Summary

Modifier and Type	Method and Description
void	bypassObjectRetention(String bucketName, String targetName, ZonedDateTime retentionUntil) Bypass the governance retention and set a specific validity time in the future
String	createFile(String bucketName, String targetName, File file, Map<String,String> tags) Create one file into S3 with optional Tags (null if none)
void	deleteFile(String bucketName, String sourceName) Delete S3 source
Map<String,String>	getFile(String bucketName, String sourceName, File file, boolean getTags) Get a File from S3
ZonedDateTime	getObjectRetention(String bucketName, String sourceName) Get the ZoneDateTime when this Object will be deleted
Map<String,String>	getTags(String bucketName, String sourceName) Get a Tags from S3
Iterator<String>	listObjectsFromBucket(String bucketName, String optionalNameStartWith, boolean recursively, int limit) Get sourceNames from S3 from the bucketName specified, names optionally starting with a String, recursively or not, and possibly unlimited (if limit is <= 0)
void	setTags(String bucketName, String targetName, Map<String,String> tags) Set a Tags to S3

Methods inherited from class java.lang.Object

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

Field Detail

BUCKET_OR_TARGET_CANNOT_BE_NULL_OR_EMPTY

public static final String BUCKET_OR_TARGET_CANNOT_BE_NULL_OR_EMPTY

See Also:

Constant Field Values

S_3_ISSUE

public static final String S_3_ISSUE

See Also:

Constant Field Values

BUCKET_OR_SOURCE_CANNOT_BE_NULL_OR_EMPTY

public static final String BUCKET_OR_SOURCE_CANNOT_BE_NULL_OR_EMPTY

See Also:

Constant Field Values

Constructor Detail

WaarpR66S3Client

public WaarpR66S3Client(String accessKey,
                        String secretKey,
                        URL endPointS3)

Initialize context for S3 Client

Parameters:

accessKey -

secretKey -

endPointS3 -

Method Detail

createFile

public final String createFile(String bucketName,
                               String targetName,
                               File file,
                               Map<String,String> tags)
                        throws OpenR66ProtocolNetworkException

Create one file into S3 with optional Tags (null if none)

Parameters:

bucketName -

targetName -

file -

tags -

Returns:

versionId

Throws:

OpenR66ProtocolNetworkException

setTags

public final void setTags(String bucketName,
                          String targetName,
                          Map<String,String> tags)
                   throws OpenR66ProtocolNetworkException

Set a Tags to S3

Parameters:

bucketName -

targetName -

tags -

Throws:

OpenR66ProtocolNetworkException

getObjectRetention

public final ZonedDateTime getObjectRetention(String bucketName,
                                              String sourceName)
                                       throws OpenR66ProtocolNetworkException

Get the ZoneDateTime when this Object will be deleted

Parameters:

bucketName -

sourceName -

Returns:

the ZoneDateTime

Throws:

OpenR66ProtocolNetworkException

bypassObjectRetention

public final void bypassObjectRetention(String bucketName,
                                        String targetName,
                                        ZonedDateTime retentionUntil)
                                 throws OpenR66ProtocolNetworkException

Bypass the governance retention and set a specific validity time in the future

Parameters:

bucketName -

targetName -

retentionUntil -

Throws:

OpenR66ProtocolNetworkException

getFile

public final Map<String,String> getFile(String bucketName,
                                        String sourceName,
                                        File file,
                                        boolean getTags)
                                 throws OpenR66ProtocolNetworkException

Get a File from S3

Parameters:

bucketName -

sourceName -

file -

getTags - if False, will return an empty Map

Returns:

the Tag as Map of Strings

Throws:

OpenR66ProtocolNetworkException

getTags

public final Map<String,String> getTags(String bucketName,
                                        String sourceName)
                                 throws OpenR66ProtocolNetworkException

Get a Tags from S3

Parameters:

bucketName -

sourceName -

Returns:

the Tag as Map of Strings

Throws:

OpenR66ProtocolNetworkException

deleteFile

public final void deleteFile(String bucketName,
                             String sourceName)
                      throws OpenR66ProtocolNetworkException

Delete S3 source

Parameters:

bucketName -

sourceName -

Throws:

OpenR66ProtocolNetworkException

listObjectsFromBucket

public final Iterator<String> listObjectsFromBucket(String bucketName,
                                                    String optionalNameStartWith,
                                                    boolean recursively,
                                                    int limit)
                                             throws OpenR66ProtocolNetworkException

Get sourceNames from S3 from the bucketName specified, names optionally starting with a String, recursively or not, and possibly unlimited (if limit is <= 0)

Parameters:

bucketName -

optionalNameStartWith - could be null or empty

recursively - False only from main directory, True scanning also subdirectories

limit - if <= 0, unlimited

Returns:

the Iterator on found sourceNames

Throws:

OpenR66ProtocolNetworkException