public interface IFileReplicator
The life cycle of the file replicator is:
setWebFileReplication(WebFileReplication)
is called
providing informations about the replication to be done.
initialize()
method is called.
write(IFile)
or delete(IFile)
methods may occur.
dispose()
is called. This method will be called even
if a write(IFile)
or delete(IFile)
operation
resulted in a exception.
Consider using AbstractFileReplicator
as a base class when
implementing a IFileReplicator, for easiness and better future compatibility.
Modifier and Type | Method and Description |
---|---|
void |
delete(IFile file)
Removes a file or directory from the replication destination.
|
void |
dispose()
Allows the replicator to complete pending operation and free any
used resources.
|
void |
initialize()
Initializes this file replicator.
|
void |
setWebFileReplication(WebFileReplication replication)
Provides replication information.
|
void |
write(IFile file)
Writes a file or directory on the replication destination.
|
void setWebFileReplication(WebFileReplication replication)
replication
- the WebFileReplication that contains information about the
next replication to be processed.void initialize() throws FileReplicationException
FileReplicationException
- if a problem prevents the file
replication to be done.void write(IFile file) throws FileReplicationException
If the given file is a directory
,
this operation must create the corresponding directory in the
destination if it does not already exist.
If the given file is a normal file
,
this operation must create the corresponding file in the destination,
with the same contents, overwriting the file if it already exists.
This operation must create any non-existant parent directories necessary for creating the corresponding directory/file in the destination.
This write operation need not to be completed when this method returns,
but it must be completed before the next call to dispose()
returns.
file
- the corresponding file in the portal file system.FileReplicationException
- if a problem prevents the file
replication to be done.void delete(IFile file) throws FileReplicationException
If the given file is a directory and it is not empty at the destination, this operation should fail throwing FileReplicationException.
If the corresponding file in the destination does not exist, this operation must be a no-op and complete gracefully.
This delete operation does not need to be completed when this method returns,
but it must be completed before the next call to dispose()
returns.
file
- the corresponding file in the portal file system.FileReplicationException
- if a problem prevents the file
replication to be done.void dispose() throws FileReplicationException
After this method is called, the replicator will not be used anymore, unless it is reinitialized.
FileReplicationException
- if a problem prevents pending file
replications to be done. Even if this exception is thrown, the replicator
must free any allocated resource.LumisXP 12.3.0.200408 - Copyright © 2006–2020 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.