org.bedework.calsvci

Interface RestoreIntf

public interface RestoreIntf

Interface which defines the database functions needed to restore the calendar database. The methods need to be called in the order defined below.

Version:

1.0

Author:

Mike Douglass douglm rpi.edu

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RestoreIntf.FixAliasResult

Method Summary

Modifier and Type	Method and Description
void	addAdminGroupMember(BwAdminGroup o, BwPrincipal pr)
void	addCalendar(BwCalendar val) Restore a single calendar - parent is set in the entity
void	checkEmptySystem() Check for an empty system first
void	endTransaction() Call to end a transaction - may be ignored if batching
void	endTransactionNow() Call to end a transaction - even if batched
RestoreIntf.FixAliasResult	fixSharee(BwCalendar col, String shareeHref, org.bedework.caldav.util.sharing.AccessType a) Restore sharing for the given principal href
BwAdminGroup	getAdminGroup(String name) Get an admin group given it's name.
BwCalendar	getCalendar(String path)
BwCategory	getCategory(String uid)
BwContact	getContact(String uid)
BwEvent	getEvent(BwPrincipal owner, String colPath, String recurrenceId, String uid) Get an event
BwLocation	getLocation(String uid)
BwPrincipal	getPrincipal(String href)
void	restoreAdminGroup(BwAdminGroup o) Restore an admin group - though not the user entries nor the authuser entries.
void	restoreAuthUser(BwAuthUser o) Restore an auth user and preferences
void	restoreCalSuite(BwCalSuite o) Restore calendar suite
void	restoreCategory(BwCategory o) Restore category
void	restoreContact(BwContact o) Restore contact
void	restoreEvent(EventInfo ei) Restore an event and associated entries
void	restoreFilter(BwFilterDef o) Restore filter
void	restoreLocation(BwLocation o) Restore location
void	restorePrincipal(BwPrincipal o) Restore principal
void	restoreResource(BwResource o) Restore resource
void	restoreSyspars(BwSystem o) Restore system pars
void	restoreUserPrefs(BwPreferences o) Restore user prefs
void	saveRootCalendar(BwCalendar val) Save a single root calendar - no parent is set in the entity
void	setBatchSize(int val) Allow transactions to span many updates.
void	setLogger(org.bedework.util.logging.Logged val)

Method Detail

setLogger

void setLogger(org.bedework.util.logging.Logged val)

Parameters:

val -

setBatchSize

void setBatchSize(int val)

Allow transactions to span many updates. May not work well.

Parameters:

val -

endTransactionNow

void endTransactionNow()
                throws Throwable

Call to end a transaction - even if batched

Throws:

Throwable

endTransaction

void endTransaction()
             throws Throwable

Call to end a transaction - may be ignored if batching

Throws:

Throwable

checkEmptySystem

void checkEmptySystem()
               throws Throwable

Check for an empty system first

Throws:

Throwable

restoreSyspars

void restoreSyspars(BwSystem o)
             throws Throwable

Restore system pars

Parameters:

o -

Throws:

Throwable

restorePrincipal

void restorePrincipal(BwPrincipal o)
               throws Throwable

Restore principal

Parameters:

o -

Throws:

Throwable

restoreAdminGroup

void restoreAdminGroup(BwAdminGroup o)
                throws Throwable

Restore an admin group - though not the user entries nor the authuser entries.

Parameters:

o - Object to restore

Throws:

Throwable

addAdminGroupMember

void addAdminGroupMember(BwAdminGroup o,
                         BwPrincipal pr)
                  throws Throwable

Parameters:

o -

pr -

Throws:

Throwable

getAdminGroup

BwAdminGroup getAdminGroup(String name)
                    throws Throwable

Get an admin group given it's name.

Parameters:

name - String name of the group

Returns:

BwAdminGroup

Throws:

Throwable

restoreAuthUser

void restoreAuthUser(BwAuthUser o)
              throws Throwable

Restore an auth user and preferences

Parameters:

o - Object to restore with id set

Throws:

Throwable

restoreEvent

void restoreEvent(EventInfo ei)
           throws Throwable

Restore an event and associated entries

Parameters:

ei - Object to restore with id set

Throws:

Throwable

getEvent

BwEvent getEvent(BwPrincipal owner,
                 String colPath,
                 String recurrenceId,
                 String uid)
          throws Throwable

Get an event

Parameters:

owner - - the current user we are acting as - eg, for an annotation and fetching the master event this will be the annotation owner.

colPath -

recurrenceId -

uid -

Returns:

BwEvent

Throws:

Throwable

restoreCategory

void restoreCategory(BwCategory o)
              throws Throwable

Restore category

Parameters:

o - Object to restore with id set

Throws:

Throwable

restoreCalSuite

void restoreCalSuite(BwCalSuite o)
              throws Throwable

Restore calendar suite

Parameters:

o - Object to restore

Throws:

Throwable

restoreLocation

void restoreLocation(BwLocation o)
              throws Throwable

Restore location

Parameters:

o - Object to restore with id set

Throws:

Throwable

restoreContact

void restoreContact(BwContact o)
             throws Throwable

Restore contact

Parameters:

o - Object to restore with id set

Throws:

Throwable

restoreFilter

void restoreFilter(BwFilterDef o)
            throws Throwable

Restore filter

Parameters:

o - Object to restore with id set

Throws:

Throwable

restoreResource

void restoreResource(BwResource o)
              throws Throwable

Restore resource

Parameters:

o - Object to restore with id set

Throws:

Throwable

restoreUserPrefs

void restoreUserPrefs(BwPreferences o)
               throws Throwable

Restore user prefs

Parameters:

o - Object to restore with id set

Throws:

Throwable

getCalendar

BwCalendar getCalendar(String path)
                throws Throwable

Parameters:

path -

Returns:

BwCalendar

Throws:

Throwable

getCategory

BwCategory getCategory(String uid)
                throws Throwable

Parameters:

uid -

Returns:

BwCategory

Throws:

Throwable

getContact

BwContact getContact(String uid)
              throws Throwable

Parameters:

uid -

Returns:

BwContact

Throws:

Throwable

getLocation

BwLocation getLocation(String uid)
                throws Throwable

Parameters:

uid -

Returns:

BwLocation

Throws:

Throwable

getPrincipal

BwPrincipal getPrincipal(String href)
                  throws CalFacadeException

Parameters:

href -

Returns:

BwPrincipal

Throws:

CalFacadeException

saveRootCalendar

void saveRootCalendar(BwCalendar val)
               throws Throwable

Save a single root calendar - no parent is set in the entity

Parameters:

val -

Throws:

Throwable

addCalendar

void addCalendar(BwCalendar val)
          throws Throwable

Restore a single calendar - parent is set in the entity

Parameters:

val -

Throws:

Throwable

fixSharee

RestoreIntf.FixAliasResult fixSharee(BwCalendar col,
                                     String shareeHref,
                                     org.bedework.caldav.util.sharing.AccessType a)
                              throws CalFacadeException

Restore sharing for the given principal href

Parameters:

col - - the target collection

shareeHref - - the sharee

a - - access

Returns:

indication of how it went

Throws:

CalFacadeException