net.bluemind.dataprotect.api

Interface IDataProtect

All Known Implementing Classes:

DPService

@Path(value="/dataprotect")
public interface IDataProtect

Method Summary

Modifier and Type	Method and Description
TaskRef	forget(int generationId) Removes protected data
java.util.List<DataProtectGeneration>	getAvailableGenerations() Returns all protected generations, ordered from oldest to most recent
TaskRef	getContent(java.lang.String partGenerationId) Loads an index of protected datas with possible restore actions.
java.util.List<RestoreOperation>	getRestoreCapabilities() Returns infos about the restore operations that the core provides
java.util.List<RestoreOperation>	getRestoreCapabilitiesByTags(java.util.List<java.lang.String> tags) * Returns infos about the restore operations that the core provides (filtered by tags)
RetentionPolicy	getRetentionPolicy() Returns the RetentionPolicy used for backup automatic removals.
TaskRef	installFromGeneration(int generationId) Populates a blue mind database using protected data from a given generation.
TaskRef	run(RestoreDefinition restoreDefinition) Executes a restore operation on the given Restorable item using data from a DataProtectGeneration
TaskRef	saveAll() Run the incremental dataprotect backup process
void	syncWithFilesystem() Re-creates the in-database metadata using the generations.xml index from the data protect spool on the filesystem.
void	updatePolicy(RetentionPolicy rp) creates or updates the RetentionPolicy.

Method Detail

getAvailableGenerations

@GET
 @Path(value="generations")
java.util.List<DataProtectGeneration> getAvailableGenerations()
                                                                                        throws ServerFault

Returns all protected generations, ordered from oldest to most recent

Returns:

Throws:

ServerFault

getContent

@POST
 @Path(value="_content/{partGen}")
TaskRef getContent(@PathParam(value="partGen")
                                                            java.lang.String partGenerationId)
                                                     throws ServerFault

Loads an index of protected datas with possible restore actions.

Parameters:

dpg -

Returns:

GenerationContent XML from TaskStatus result

Throws:

ServerFault

getRestoreCapabilities

@GET
 @Path(value="restore/_capabilities")
java.util.List<RestoreOperation> getRestoreCapabilities()
                                                                                            throws ServerFault

Returns infos about the restore operations that the core provides

Parameters:

token -

Returns:

Throws:

ServerFault

getRestoreCapabilitiesByTags

@GET
 @Path(value="restore/_capabilities_by_tags")
java.util.List<RestoreOperation> getRestoreCapabilitiesByTags(java.util.List<java.lang.String> tags)
                                                                                                          throws ServerFault

* Returns infos about the restore operations that the core provides (filtered by tags)

Parameters:

tags -

Returns:

Throws:

ServerFault

run

@POST
 @Path(value="restore")
TaskRef run(RestoreDefinition restoreDefinition)
                                   throws ServerFault

Executes a restore operation on the given Restorable item using data from a DataProtectGeneration

Parameters:

restoreDefinition -

Returns:

Throws:

ServerFault

forget

@DELETE
 @Path(value="generations")
TaskRef forget(@QueryParam(value="generationId")
                                                   int generationId)
                                            throws ServerFault

Removes protected data

Parameters:

dpg -

Returns:

Throws:

ServerFault

getRetentionPolicy

@GET
 @Path(value="policy")
RetentionPolicy getRetentionPolicy()
                                                        throws ServerFault

Returns the RetentionPolicy used for backup automatic removals. Never returns null.

Returns:

Throws:

ServerFault

updatePolicy

@POST
 @Path(value="policy")
void updatePolicy(RetentionPolicy rp)
                                        throws ServerFault

creates or updates the RetentionPolicy.

Parameters:

rp -

Throws:

ServerFault

syncWithFilesystem

@POST
 @Path(value="_syncfs")
void syncWithFilesystem()
                                               throws ServerFault

Re-creates the in-database metadata using the generations.xml index from the data protect spool on the filesystem. This is used for re-creating a blue mind server using backups. This must be used when /var/backups/bluemind becomes inconsistent with the database content (eg. after a TINA restore of /var/backups/bluemind)

Throws:

ServerFault

installFromGeneration

@POST
 @Path(value="_install")
TaskRef installFromGeneration(@QueryParam(value="generationId")
                                                             int generationId)
                                                      throws ServerFault

Populates a blue mind database using protected data from a given generation.

Parameters:

at -

generationId -

Throws:

ServerFault

saveAll

@POST
 @Path(value="_backup")
TaskRef saveAll()
                                       throws ServerFault

Run the incremental dataprotect backup process

Returns:

Throws:

ServerFault