org.apache.commons.vfs2.impl

Class PrivilegedFileReplicator

java.lang.Object

org.apache.commons.vfs2.impl.PrivilegedFileReplicator

All Implemented Interfaces:

FileReplicator, VfsComponent

public class PrivilegedFileReplicator
extends java.lang.Object
implements FileReplicator, VfsComponent

A file replicator that wraps another file replicator, performing the replication as a privileged action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	PrivilegedFileReplicator.CloseAction An action that closes the wrapped replicator.
private class	PrivilegedFileReplicator.InitAction An action that initialises the wrapped replicator.
private class	PrivilegedFileReplicator.ReplicateAction An action that replicates a file using the wrapped replicator.

Field Summary

Fields

Modifier and Type	Field and Description
private FileReplicator	replicator
private VfsComponent	replicatorComponent

Constructor Summary

Constructors

Constructor and Description
PrivilegedFileReplicator(FileReplicator replicator)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the replicator.
void	init() Initializes the component.
java.io.File	replicateFile(FileObject srcFile, FileSelector selector) Creates a local copy of the file, and all its descendants.
void	setContext(VfsComponentContext context) Sets the context for the replicator.
void	setLogger(org.apache.commons.logging.Log logger) Sets the Logger to use for the component.

Methods inherited from class java.lang.Object

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

Field Detail

replicator

private final FileReplicator replicator

replicatorComponent

private final VfsComponent replicatorComponent

Constructor Detail

PrivilegedFileReplicator

public PrivilegedFileReplicator(FileReplicator replicator)

Method Detail

setLogger

public void setLogger(org.apache.commons.logging.Log logger)

Sets the Logger to use for the component.

Specified by:

setLogger in interface VfsComponent

Parameters:

logger - The logger.

setContext

public void setContext(VfsComponentContext context)

Sets the context for the replicator.

Specified by:

setContext in interface VfsComponent

Parameters:

context - The component context.

init

public void init()
          throws FileSystemException

Initializes the component.

Specified by:

init in interface VfsComponent

Throws:

FileSystemException - if an error occurs.

close

public void close()

Closes the replicator.

Specified by:

close in interface VfsComponent

replicateFile

public java.io.File replicateFile(FileObject srcFile,
                                  FileSelector selector)
                           throws FileSystemException

Creates a local copy of the file, and all its descendants.

Specified by:

replicateFile in interface FileReplicator

Parameters:

srcFile - The source FileObject.

selector - The file selector.

Returns:

The replicated file.

Throws:

FileSystemException - if an error occurs.