Package com.day.cq.replication

Interface ContentBuilder

@ConsumerType
public interface ContentBuilder

A ContentBuilder assembles the data for the replication. A content handler needs to be registered with a PROPERTY_NAME service registration property.

Field Summary

Fields

Modifier and Type	Field	Description
static String	PARAMETER_CONTENT_FILER_CHAIN	This parameter is set when the content builder is invoked by a replication agent.
static String	PROPERTY_NAME

Method Summary

Modifier and Type	Method	Description
ReplicationContent	create(Session session, ReplicationAction action, ReplicationContentFactory contentFactory)	Create the replication content.
ReplicationContent	create(Session session, ReplicationAction action, ReplicationContentFactory contentFactory, Map<String,Object> parameters)	Create the replication content.
String	getName()	Returns the name of this content builder.
String	getTitle()	Returns the title of this content builder.

Field Detail

PROPERTY_NAME

static final String PROPERTY_NAME

See Also:

Constant Field Values

PARAMETER_CONTENT_FILER_CHAIN

static final String PARAMETER_CONTENT_FILER_CHAIN

This parameter is set when the content builder is invoked by a replication agent. It contains a ReplicationContentFilterChain to be used by ContentBuilders to filter content for exclusion from the replication content being built. This parameter is optional and might be null.

Since:

5.14

Method Detail

create

ReplicationContent create(Session session,
                          ReplicationAction action,
                          ReplicationContentFactory contentFactory)
                   throws ReplicationException

Create the replication content. If this content builder does not create content for the actual replication (e.g. for a delete replication), the content builder should return ReplicationContent.VOID.

Parameters:

session - session to use to access the repository

action - The replication action.

contentFactory - the factory for creating binary content objects.

Returns:

A newly created replication content or ReplicationContent.VOID.

Throws:

ReplicationException - if an error during assembly of the content occurs.

create

ReplicationContent create(Session session,
                          ReplicationAction action,
                          ReplicationContentFactory contentFactory,
                          Map<String,Object> parameters)
                   throws ReplicationException

Create the replication content. If this content builder does not create content for the actual replication (e.g. for a delete replication), the content builder should return ReplicationContent.VOID.

Parameters:

session - session to use to access the repository

action - The replication action.

contentFactory - the factory for creating binary content objects.

parameters - additional parameters needed for implementation specific purposes

Returns:

A newly created replication content or ReplicationContent.VOID.

Throws:

ReplicationException - if an error during assembly of the content occurs.

getName

String getName()

Returns the name of this content builder.

Returns:

the name of this content builder.

Since:

5.3

getTitle

String getTitle()

Returns the title of this content builder.

Returns:

the title.

Since:

5.3