Package org.infinispan.server.core.backup.resources

Class CacheResource

java.lang.Object

org.infinispan.server.core.backup.resources.CacheResource

All Implemented Interfaces:

ContainerResource

public class CacheResource
extends Object

ContainerResource implementation for BackupManager.Resources.Type.CACHES.

Since:

12.0

Author:

Ryan Emerson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CacheResource.CacheBackupEntry	ProtoStream entity used to represent individual cache entries.

Field Summary

Fields

Modifier and Type	Field	Description
protected final BlockingManager	blockingManager
protected static final Log	log
protected final BackupManager.Resources	params
protected final Set<String>	resources
protected final Path	root
protected final BackupManager.Resources.Type	type
protected final boolean	wildcard

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	backup()	Writes the backup files for the BackupManager.Resources.Type to the local filesystem, where it can then be packaged for distribution.
protected void	mkdirs(Path path)
void	prepareAndValidateBackup()	A method to ensure that the resources requested in the BackupManager.Resources are valid and can be included in a backup.
void	prepareAndValidateRestore(Properties properties)	A method to ensure that the resources requested in the BackupManager.Resources are contained in the backup to be restored.
protected static <T> T	readMessageStream(org.infinispan.protostream.ImmutableSerializationContext ctx, Class<T> clazz, DataInputStream is)
CompletionStage<Void>	restore(ZipFile zip)	Restores the BackupManager.Resources.Type content from the provided ZipFile to the target container.
protected static void	writeMessageStream(Object o, org.infinispan.protostream.ImmutableSerializationContext serCtx, DataOutputStream output)
void	writeToManifest(Properties properties)	Writes the name of the individual resources that have been included in this backup.

Methods inherited from class java.lang.Object

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

Field Details

log

protected static final Log log

type

protected final BackupManager.Resources.Type type

params

protected final BackupManager.Resources params

root

protected final Path root

blockingManager

protected final BlockingManager blockingManager

wildcard

protected final boolean wildcard

resources

protected final Set<String> resources

Method Details

prepareAndValidateBackup

public void prepareAndValidateBackup()

Description copied from interface: ContainerResource

A method to ensure that the resources requested in the BackupManager.Resources are valid and can be included in a backup. This method is called for all ContainerResource implementations before the backup process begins in order to allow a backup to fail-fast before any data is processed.

backup

public CompletionStage<Void> backup()

Description copied from interface: ContainerResource

Writes the backup files for the BackupManager.Resources.Type to the local filesystem, where it can then be packaged for distribution.

Implementations of this method depend on content created by ContainerResource.prepareAndValidateBackup().

Returns:

a CompletionStage that completes once the backup of this BackupManager.Resources.Type has finished.

restore

public CompletionStage<Void> restore(ZipFile zip)

Description copied from interface: ContainerResource

Restores the BackupManager.Resources.Type content from the provided ZipFile to the target container.

Parameters:

zip - the ZipFile to restore content from.

Returns:

a CompletionStage that completes once the restoration of this BackupManager.Resources.Type has finished.

writeToManifest

public void writeToManifest(Properties properties)

Description copied from interface: ContainerResource

Writes the name of the individual resources that have been included in this backup. The BackupManager.Resources.Type associated with an implementation is the key, whilst the value is a csv of resource names.

Implementations of this method depend on state created by ContainerResource.backup().

Specified by:

writeToManifest in interface ContainerResource

Parameters:

properties - the Properties instance to add the key/value property.

prepareAndValidateRestore

public void prepareAndValidateRestore(Properties properties)

Description copied from interface: ContainerResource

A method to ensure that the resources requested in the BackupManager.Resources are contained in the backup to be restored. This method is called for all ContainerResource implementations before the restore process begins in order to allow a restore to fail-fast before any state is restored to a container.

Specified by:

prepareAndValidateRestore in interface ContainerResource

mkdirs

protected void mkdirs(Path path)

writeMessageStream

protected static void writeMessageStream(Object o,
 org.infinispan.protostream.ImmutableSerializationContext serCtx,
 DataOutputStream output)
                                  throws IOException

Throws:

IOException

readMessageStream

protected static <T> T readMessageStream(org.infinispan.protostream.ImmutableSerializationContext ctx,
 Class<T> clazz,
 DataInputStream is)
                                  throws IOException

Throws:

IOException