Package org.jenkinsci.plugins.periodicbackup

Class S3

java.lang.Object

hudson.model.AbstractModelObject

org.jenkinsci.plugins.periodicbackup.Location

org.jenkinsci.plugins.periodicbackup.S3

All Implemented Interfaces:

hudson.model.Describable<Location>, hudson.model.ModelObject, hudson.search.SearchableModelObject, hudson.search.SearchItem

public class S3
extends Location

S3 defines Amazon S3 (Simple Storage Service) to store the backup files

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	S3.DescriptorImpl

Field Summary

Fields inherited from class org.jenkinsci.plugins.periodicbackup.Location

enabled

Constructor Summary

Constructors

Constructor	Description
S3(String bucket, boolean enabled, String tmpDir, String region, String credentialsId)

Method Summary

Modifier and Type	Method	Description
void	deleteBackupFiles(BackupObject backupObject)	This method deletes all files related to given BackupObject
boolean	equals(Object o)
Iterable<BackupObject>	getAvailableBackups()	This method returns Iterable of BackupObject(s) in this location
String	getBucket()
String	getCredentialsId()
String	getDisplayName()
String	getPrefix()
String	getRegion()
String	getTmpDir()
int	hashCode()
Iterable<File>	retrieveBackupFromLocation(BackupObject backup, File tempDir)	Retrieves backup archive files from this location
void	setBucket(String bucket)
void	setCredentialsId(String credentialsId)
void	setPrefix(String prefix)
void	setRegion(String region)
void	setTmpDir(String tmpDir)
void	storeBackupInLocation(Iterable<File> archives, File backupObjectFile)	This method puts archived backup file(s) in location

Methods inherited from class org.jenkinsci.plugins.periodicbackup.Location

all, getDescriptor, getSearchUrl

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Constructor Detail

S3

@DataBoundConstructor
public S3(String bucket,
          boolean enabled,
          String tmpDir,
          String region,
          String credentialsId)

Method Detail

getAvailableBackups

public Iterable<BackupObject> getAvailableBackups()

Description copied from class: Location

This method returns Iterable of BackupObject(s) in this location

Specified by:

getAvailableBackups in class Location

Returns:

BackupObject(s) in location

storeBackupInLocation

public void storeBackupInLocation(Iterable<File> archives,
                                  File backupObjectFile)
                           throws IOException

Description copied from class: Location

This method puts archived backup file(s) in location

Specified by:

storeBackupInLocation in class Location

Parameters:

archives - archive file(s)

backupObjectFile - File with serialized backupObject

Throws:

IOException - IO error

retrieveBackupFromLocation

public Iterable<File> retrieveBackupFromLocation(BackupObject backup,
                                                 File tempDir)
                                          throws IOException,
                                                 org.jenkinsci.plugins.periodicbackup.PeriodicBackupException

Description copied from class: Location

Retrieves backup archive files from this location

Specified by:

retrieveBackupFromLocation in class Location

Parameters:

backup - BackupObject related to the backup

tempDir - temporary directory to store archived backup file(s)

Returns:

Iterable of backup archive(s) in temporary location

Throws:

IOException - if anything goes wrong with IO

org.jenkinsci.plugins.periodicbackup.PeriodicBackupException - if anything else goes wrong

deleteBackupFiles

public void deleteBackupFiles(BackupObject backupObject)

Description copied from class: Location

This method deletes all files related to given BackupObject

Specified by:

deleteBackupFiles in class Location

Parameters:

backupObject - the backupObject of the backup we want to delete

getDisplayName

public String getDisplayName()

getBucket

public String getBucket()

setBucket

public void setBucket(String bucket)

getTmpDir

public String getTmpDir()

setTmpDir

public void setTmpDir(String tmpDir)

getPrefix

public String getPrefix()

setPrefix

@DataBoundSetter
public void setPrefix(String prefix)

getRegion

public String getRegion()

setRegion

public void setRegion(String region)

getCredentialsId

public String getCredentialsId()

setCredentialsId

public void setCredentialsId(String credentialsId)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object