Package 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
All Methods Instance Methods Abstract Methods Modifier and Type Method 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 thanReplicationActionType.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 beReplicationActionType.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 thanReplicationActionType.ACTIVATE
.- Parameters:
action
- replication action, must not beReplicationActionType.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 notnull
, all items older than this date are automatically purged from the outbox before returning the outbox's contentout
- output stream where to store a virtual durbo package namedoutbox
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.
-
-