com.day.cq.replication

Interface Outbox

public interface Outbox

Represents an outbox that will return new items on this instance, automatically removing items older than the timestamp given.

Method Summary

Modifier and Type	Method and Description
void	fetch(java.util.Calendar time, java.io.OutputStream out) Fetch items from the outbox, having a last modified time greater than the given optional time, automatically removing items that are older.
java.lang.String	getPath() Returns the outbox path.
void	put(ReplicationAction action) Put an empty item in the outbox with a replication action other than ReplicationActionType.ACTIVATE.
void	put(ReplicationAction action, java.io.InputStream in) Put item in the outbox.

Method Detail

put

void put(ReplicationAction action,
         java.io.InputStream in)
  throws ReplicationException

Put item in the outbox.

Parameters:

action - replication action, must not be ReplicationActionType.ACTIVATE

in - item data

Throws:

ReplicationException - if an error occurs

put

void put(ReplicationAction action)
  throws ReplicationException

Put an empty item in the outbox with a replication action other than ReplicationActionType.ACTIVATE.

Parameters:

action - replication action, must not be ReplicationActionType.ACTIVATE

Throws:

ReplicationException - if an error occurs

fetch

void fetch(java.util.Calendar time,
           java.io.OutputStream out)
    throws ReplicationException

Fetch items from the outbox, having a last modified time greater than the given optional time, automatically removing items that are older.

Parameters:

time - if not null, all items older than this date are automatically purged from the outbox before returning the outbox's content

out - output stream where to store a virtual durbo package named outbox with the items in the outbox as children

Throws:

ReplicationException - if an error occurs

getPath

java.lang.String getPath()

Returns the outbox path.

Returns:

the outbox path.