org.alfresco.repo.replication

Interface ReplicationDefinitionPersister

All Known Subinterfaces:

ReplicationService

All Known Implementing Classes:

ReplicationDefinitionPersisterImpl, ReplicationServiceImpl

public interface ReplicationDefinitionPersister

This class provides the implementation of ReplicationDefinition persistence.

Since:

3.4

Author:

Nick Burch

Method Summary

Modifier and Type	Method and Description
void	deleteReplicationDefinition(ReplicationDefinition replicationDefinition) This method removes the previously serializes ReplicationDefinition from the repository.
ReplicationDefinition	loadReplicationDefinition(String replicationName) This method retrieves a ReplicationDefinition that has been stored in the repository using the save() method.
List<ReplicationDefinition>	loadReplicationDefinitions() This method retrieves the ReplicationDefinitions that have been stored in the repository using the save() method.
List<ReplicationDefinition>	loadReplicationDefinitions(String targetName) This method retrieves the stored ReplicationDefinitions that have been registered for the specified transfer target name.
void	renameReplicationDefinition(String oldReplicationName, String newReplicationName) This method renames a ReplicationDefinition that has been stored in the repository using the save() method.
void	saveReplicationDefinition(ReplicationDefinition replicationDefinition) This method serializes the ReplicationDefinition and stores it in the repository.

Method Detail

saveReplicationDefinition

void saveReplicationDefinition(ReplicationDefinition replicationDefinition)

This method serializes the ReplicationDefinition and stores it in the repository. ReplicationDefinitions saved in this way may be retrieved using the load() method.

Parameters:

replicationDefinition - The ReplicationDefinition to be persisted.

deleteReplicationDefinition

void deleteReplicationDefinition(ReplicationDefinition replicationDefinition)

This method removes the previously serializes ReplicationDefinition from the repository. The ReplicationDefinition will then no longer be available using the load methods.

Parameters:

replicationDefinition - The ReplicationDefinition to be deleted.

renameReplicationDefinition

void renameReplicationDefinition(String oldReplicationName,
                                 String newReplicationName)

This method renames a ReplicationDefinition that has been stored in the repository using the save() method. If no ReplicationDefinition exists in the repository with the specified replication name, then nothing happens.

Parameters:

oldReplicationName - The unique identifier used to specify the ReplicationDefinition to rename.

newReplicationName - The unique identifier used to specify the new ReplicationDefinition name.

loadReplicationDefinition

ReplicationDefinition loadReplicationDefinition(String replicationName)

This method retrieves a ReplicationDefinition that has been stored in the repository using the save() method. If no ReplicationDefinition exists in the repository with the specified replication name then this method returns null.

Parameters:

replicationName - The unique identifier used to specify the ReplicationDefinition to retrieve.

Returns:

The specified ReplicationDefinition or null.

loadReplicationDefinitions

List<ReplicationDefinition> loadReplicationDefinitions()

This method retrieves the ReplicationDefinitions that have been stored in the repository using the save() method.

If there are no such ReplicationDefinitions, an empty list is returned.

Returns:

The ReplicationDefinitions.

loadReplicationDefinitions

List<ReplicationDefinition> loadReplicationDefinitions(String targetName)

This method retrieves the stored ReplicationDefinitions that have been registered for the specified transfer target name.

If there are no such rendering ReplicationDefinitions, an empty list is returned.

Parameters:

targetName - the name of a target.

Returns:

The ReplicationDefinitions.

Throws:

NullPointerException - if the target is null.

See Also:

saveReplicationDefinition(ReplicationDefinition)