A B C D E G I J L N O P R S T U

A

addBackupListener(IBackupListener) - Method in class com.siviam.bobup.collate.Collater

addBackupLocation(File, List) - Method in class com.siviam.bobup.location.LocalDirectoryBackupLocation

addBackupPart(IBackupPart) - Method in class com.siviam.bobup.businessobjects.BusinessObject

addBackupPartDescription(Properties) - Method in interface com.siviam.bobup.businessobjects.IBusinessObjectDescriptor

Adds the description of the backup part in the form of name/value properties.

addBackupPartDescription(Properties) - Method in class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

addBackupProvider(IBackupProvider) - Method in class com.siviam.bobup.collate.Collater

Adds the backup provider.

addBackupRecoveryHandler(IBackupRecoveryHandler) - Method in class com.siviam.bobup.handler.BackupRecoveryRegistry

addBusinessObjectBackup(File, List) - Method in class com.siviam.bobup.location.LocalDirectoryBackupLocation

B

BACKUP_CANCELLED - Static variable in class com.siviam.bobup.event.BackupEvent

BACKUP_COMPLETE - Static variable in class com.siviam.bobup.event.BackupEvent

BACKUP_FAILED - Static variable in class com.siviam.bobup.event.BackupEvent

BACKUP_SCHEDULED_REALTIME - Static variable in class com.siviam.bobup.event.BackupEvent

BUSINESS_OBJECT_DESCRIPTION - Static variable in interface com.siviam.bobup.businessobjects.IBusinessObjectDescriptor

BUSINESS_OBJECT_ID - Static variable in interface com.siviam.bobup.businessobjects.IBusinessObjectDescriptor

BUSINESS_OBJECT_NAME - Static variable in interface com.siviam.bobup.businessobjects.IBusinessObjectDescriptor

BackupEvent - class com.siviam.bobup.event.BackupEvent.

BackupEvent(IBackup) - Constructor for class com.siviam.bobup.event.BackupEvent

BackupEvent(IBackup, String) - Constructor for class com.siviam.bobup.event.BackupEvent

BackupRecoveryRegistry - class com.siviam.bobup.handler.BackupRecoveryRegistry.

Registry of handlers for backup and recovery.

Browser - class com.siviam.bobup.recovery.Browser.

Contains utility functions that allow a user to browse for available backups.

Browser(IRecoverConfiguration) - Constructor for class com.siviam.bobup.recovery.Browser

BusinessObject - class com.siviam.bobup.businessobjects.BusinessObject.

This class is the encapsulation of a business object.

BusinessObject(String) - Constructor for class com.siviam.bobup.businessobjects.BusinessObject

backup(IBackupPart, OutputStream) - Method in interface com.siviam.bobup.handler.IBackupRecoveryHandler

Backup the part.

browse() - Method in class com.siviam.bobup.recovery.Browser

Obtains an iterator of objects - either of IBackupLocation or IBusinessObjectDescriptor.

browse(IBackupLocation) - Method in class com.siviam.bobup.recovery.Browser

Obtains an iterator of objects - either of IBackupLocation or IBusinessObjectDescriptor given a particular IBackupLocation location.

C

Collater - class com.siviam.bobup.collate.Collater.

Collates or groups together all business objects and their parts into a single backup on a local filesystem.

Collater(IBackupConfiguration) - Constructor for class com.siviam.bobup.collate.Collater

Constants - class com.siviam.bobup.Constants.

clearAllHandlers() - Method in class com.siviam.bobup.handler.BackupRecoveryRegistry

Removes all the handlers that are currently registered.

com.siviam.bobup - package com.siviam.bobup

com.siviam.bobup.businessobjects - package com.siviam.bobup.businessobjects

com.siviam.bobup.collate - package com.siviam.bobup.collate

com.siviam.bobup.config - package com.siviam.bobup.config

com.siviam.bobup.event - package com.siviam.bobup.event

com.siviam.bobup.general - package com.siviam.bobup.general

com.siviam.bobup.handler - package com.siviam.bobup.handler

com.siviam.bobup.location - package com.siviam.bobup.location

com.siviam.bobup.recovery - package com.siviam.bobup.recovery

com.siviam.bobup.strategy - package com.siviam.bobup.strategy

com.siviam.bobup.util - package com.siviam.bobup.util

create() - Method in class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

create() - Method in class com.siviam.bobup.businessobjects.LocalJarBusinessObjectDescriptor

create() - Method in interface com.siviam.bobup.location.IBackupLocation

Creates the backup location.

create() - Method in class com.siviam.bobup.location.LocalDirectoryBackupLocation

D

describePart(IBackupPart) - Method in interface com.siviam.bobup.handler.IBackupRecoveryHandler

Describes the part, typically in the form of property names and values.

E

exists() - Method in class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

exists() - Method in class com.siviam.bobup.businessobjects.LocalJarBusinessObjectDescriptor

exists() - Method in interface com.siviam.bobup.location.IBackupLocation

exists() - Method in class com.siviam.bobup.location.LocalDirectoryBackupLocation

G

getBackupBaseLocation(Object) - Method in interface com.siviam.bobup.config.IGeneralConfiguration

getBackupPartDescription(String, Attributes) - Static method in class com.siviam.bobup.util.Utils

Adds the attributes named via this key in the form of a Properties object to the business object descriptor.

getBackupPartDescriptions() - Method in interface com.siviam.bobup.businessobjects.IBusinessObjectDescriptor

Obtains an array of backup part descriptions.

getBackupPartDescriptions() - Method in class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

getBackupPartDescriptions(Manifest) - Static method in class com.siviam.bobup.util.Utils

Obtains the backup part descriptions properties lists from a given fully populated manifest.

getBackupParts() - Method in class com.siviam.bobup.businessobjects.BusinessObject

getBackupStrategy(Object) - Method in interface com.siviam.bobup.config.IGeneralConfiguration

getBackupWindow() - Method in class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

getBackupWindow() - Method in interface com.siviam.bobup.location.IBackupLocation

Obtains the time window within which objects were backed up.

getBackupWindow() - Method in class com.siviam.bobup.location.LocalDirectoryBackupLocation

getBusinessObjectId() - Method in interface com.siviam.bobup.general.IBackup

Obtains the unique identifier of the business object associated with this IBackup instance.

getBusinessObjectId() - Method in interface com.siviam.bobup.general.IBackupPart

* Obtains the unique identifier of the business object associated with this IBackupPart instance.

getCreateDate() - Method in interface com.siviam.bobup.config.IBackupConfiguration

getCurrentMediumNumberIndex() - Method in class com.siviam.bobup.strategy.TowerOfHanoiBackupStrategy

Obtains the currently set medium number index.

getDescription() - Method in class com.siviam.bobup.businessobjects.BusinessObject

getHandler(String) - Method in class com.siviam.bobup.handler.BackupRecoveryRegistry

getHandlerTypes() - Method in class com.siviam.bobup.handler.BackupRecoveryRegistry

Obtains a set view of the handler types registered with this registry.

getId() - Method in class com.siviam.bobup.businessobjects.BusinessObject

getId() - Method in interface com.siviam.bobup.general.IBackup

Obtains the unique identifier of this object.

getId() - Method in interface com.siviam.bobup.general.IBackupPart

Obtains the unique identifier of this part.

getInputStream() - Method in class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

getInputStream() - Method in class com.siviam.bobup.businessobjects.LocalJarBusinessObjectDescriptor

getInputStream() - Method in interface com.siviam.bobup.location.IBackupLocation

Obtains an input stream to this backup location.

getInputStream() - Method in class com.siviam.bobup.location.LocalDirectoryBackupLocation

getInstance() - Static method in class com.siviam.bobup.handler.BackupRecoveryRegistry

Obtains the singleton instance.

getInstance() - Static method in class com.siviam.bobup.recovery.Recoverer

getLastModified() - Method in class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

getLastModified() - Method in class com.siviam.bobup.businessobjects.LocalJarBusinessObjectDescriptor

getLastModified() - Method in interface com.siviam.bobup.location.IBackupLocation

Obtains the date that the backup location was last modified.

getLastModified() - Method in class com.siviam.bobup.location.LocalDirectoryBackupLocation

getLocation(Object) - Method in class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

getLocation() - Method in class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

The location pointing to the specific file that needs to be backed up or recovered.

getLocation() - Method in class com.siviam.bobup.businessobjects.LocalJarBusinessObjectDescriptor

getLocation(Object) - Method in interface com.siviam.bobup.location.IBackupLocation

Obtains a backup location relative to this location.

getLocation(Object) - Method in class com.siviam.bobup.location.LocalDirectoryBackupLocation

getMaxNumberOfMedia() - Method in interface com.siviam.bobup.strategy.IBackupStrategy

Provides the number of media that are used for the backup.

getMaxNumberOfMedia() - Method in class com.siviam.bobup.strategy.TowerOfHanoiBackupStrategy

getMediumNumber(boolean) - Method in interface com.siviam.bobup.strategy.IBackupStrategy

Obtains media/disk/folder number to be used for the backup according to this strategy.

getMediumNumber(Date, Date) - Method in interface com.siviam.bobup.strategy.IBackupStrategy

Obtains a medium number at the provided reference date given an "epoch" date i.e.

getMediumNumber(boolean) - Method in class com.siviam.bobup.strategy.TowerOfHanoiBackupStrategy

getMediumNumber(Date, Date) - Method in class com.siviam.bobup.strategy.TowerOfHanoiBackupStrategy

getName() - Method in class com.siviam.bobup.businessobjects.BusinessObject

getName() - Method in interface com.siviam.bobup.general.IBackupPart

The name of this part.

getOutputStream() - Method in class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

getOutputStream() - Method in class com.siviam.bobup.businessobjects.LocalJarBusinessObjectDescriptor

getOutputStream() - Method in interface com.siviam.bobup.location.IBackupLocation

Obtains an outputstream to the backup location.

getOutputStream() - Method in class com.siviam.bobup.location.LocalDirectoryBackupLocation

getParts(Object) - Method in interface com.siviam.bobup.general.IBackup

Obtains the constituent parts of this backup object.

getPeriodicity() - Method in interface com.siviam.bobup.strategy.IBackupStrategy

The medium for the backup will be switched after the current period has expired.

getPeriodicity() - Method in class com.siviam.bobup.strategy.TowerOfHanoiBackupStrategy

getProperties() - Method in interface com.siviam.bobup.config.IBackupConfiguration

Gets any other additional properties that need to be set for this configuration.

getResource() - Method in class com.siviam.bobup.event.BackupEvent

getSleep() - Method in interface com.siviam.bobup.config.IBackupConfiguration

getType() - Method in class com.siviam.bobup.event.BackupEvent

getType() - Method in interface com.siviam.bobup.general.IBackupPart

A backup part must have a type, and the type is used to select the handler that can handle this type of backup part.

getType() - Method in interface com.siviam.bobup.handler.IBackupRecoveryHandler

The type that this handler is able to handle.

I

IBackup - interface com.siviam.bobup.general.IBackup.

Objects that implement this interface indicate that they are business objects that can be backed up.

IBackupConfiguration - interface com.siviam.bobup.config.IBackupConfiguration.

Basic collater configuration interface.

IBackupListener - interface com.siviam.bobup.event.IBackupListener.

IBackupLocation - interface com.siviam.bobup.location.IBackupLocation.

Encapsulates the notion of a backup location.

IBackupPart - interface com.siviam.bobup.general.IBackupPart.

Backup parts are constituents of a business object IBackup.

IBackupProvider - interface com.siviam.bobup.event.IBackupProvider.

IBackupRecoveryHandler - interface com.siviam.bobup.handler.IBackupRecoveryHandler.

A handler specification that backups and recovers business object parts.

IBackupStrategy - interface com.siviam.bobup.strategy.IBackupStrategy.

The backup strategy specifies the number of media available for backup and the strategy for those media.

IBusinessObjectDescriptor - interface com.siviam.bobup.businessobjects.IBusinessObjectDescriptor.

The business object descriptor is an object describing the business object.

IGeneralConfiguration - interface com.siviam.bobup.config.IGeneralConfiguration.

A general configuration interface.

IRecoverConfiguration - interface com.siviam.bobup.config.IRecoverConfiguration.

Basic collater configuration interface.

J

JAR_FILE_EXTENSION - Static variable in class com.siviam.bobup.Constants

JarBusinessObjectDescriptor - class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor.

JarBusinessObjectDescriptor() - Constructor for class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

L

LocalDirectoryBackupLocation - class com.siviam.bobup.location.LocalDirectoryBackupLocation.

Represents a directory of files and jars in a local backup.

LocalDirectoryBackupLocation(File) - Constructor for class com.siviam.bobup.location.LocalDirectoryBackupLocation

LocalJarBusinessObjectDescriptor - class com.siviam.bobup.businessobjects.LocalJarBusinessObjectDescriptor.

This jar business object descriptor is specifically implemented for local file systems.

LocalJarBusinessObjectDescriptor(File) - Constructor for class com.siviam.bobup.businessobjects.LocalJarBusinessObjectDescriptor

listContents() - Method in class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

listContents() - Method in interface com.siviam.bobup.location.IBackupLocation

listContents() - Method in class com.siviam.bobup.location.LocalDirectoryBackupLocation

listenerAdded(IBackupListener) - Method in class com.siviam.bobup.collate.Collater

Determines if a backup listener has been added to this collater.

N

NAME_PROPERTY - Static variable in interface com.siviam.bobup.handler.IBackupRecoveryHandler

notify(BackupEvent) - Method in interface com.siviam.bobup.event.IBackupListener

A backup process notifies this listener of some event has been generated around the backup resource.

O

ONE_DAY - Static variable in class com.siviam.bobup.strategy.TowerOfHanoiBackupStrategy

ONE_MINUTE - Static variable in class com.siviam.bobup.strategy.TowerOfHanoiBackupStrategy

P

provide(Object) - Method in interface com.siviam.bobup.event.IBackupProvider

Obtain an array of resources to be backed up.

providerAdded(IBackupProvider) - Method in class com.siviam.bobup.collate.Collater

Determines if a backup provider has been added to this collater.

R

RUN_ONCE - Static variable in interface com.siviam.bobup.config.IBackupConfiguration

Recoverer - class com.siviam.bobup.recovery.Recoverer.

Recovers the business object.

recover(InputStream) - Method in interface com.siviam.bobup.handler.IBackupRecoveryHandler

Recovers the data that is sourced from the provided InputStream.

recover(IBusinessObjectDescriptor) - Method in class com.siviam.bobup.recovery.Recoverer

Recovers the specified business object with the given descriptor.

removeAllBackupListeners() - Method in class com.siviam.bobup.collate.Collater

removeAllBackupProviders() - Method in class com.siviam.bobup.collate.Collater

removeBackupListener(IBackupListener) - Method in class com.siviam.bobup.collate.Collater

Removes the backup listener.

removeBackupPartDescription(Properties) - Method in interface com.siviam.bobup.businessobjects.IBusinessObjectDescriptor

Removes the description of the backup part given a properties instance.

removeBackupPartDescription(Properties) - Method in class com.siviam.bobup.businessobjects.JarBusinessObjectDescriptor

removeBackupProvider(IBackupProvider) - Method in class com.siviam.bobup.collate.Collater

Removes the backup provider.

removeBackupRecoveryHandler(String) - Method in class com.siviam.bobup.handler.BackupRecoveryRegistry

S

setCreateDate(String) - Method in interface com.siviam.bobup.config.IBackupConfiguration

setDescription(String) - Method in class com.siviam.bobup.businessobjects.BusinessObject

setName(String) - Method in class com.siviam.bobup.businessobjects.BusinessObject

startBackup() - Method in class com.siviam.bobup.collate.Collater

stopBackup() - Method in class com.siviam.bobup.collate.Collater

T

TYPE_PROPERTY - Static variable in interface com.siviam.bobup.handler.IBackupRecoveryHandler

TowerOfHanoiBackupStrategy - class com.siviam.bobup.strategy.TowerOfHanoiBackupStrategy.

Backup strategy using the Tower of Hanoi strategy.

TowerOfHanoiBackupStrategy() - Constructor for class com.siviam.bobup.strategy.TowerOfHanoiBackupStrategy

TowerOfHanoiBackupStrategy(long) - Constructor for class com.siviam.bobup.strategy.TowerOfHanoiBackupStrategy

constructor.

U

Utils - class com.siviam.bobup.util.Utils.

Convenience methods.

useNewBackupLocation() - Method in interface com.siviam.bobup.config.IBackupConfiguration

Indicates whether a new backup location should be used for the backup.

A B C D E G I J L N O P R S T U