com.adobe.cq.social.ugcbase.dispatcher.api

Interface FlushService

public interface FlushService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FlushService.FlushType
static class	FlushService.RefetchType

Method Summary

Modifier and Type	Method and Description
boolean	sendFlushUrl(java.lang.String userId, FlushService.FlushType flushType, java.lang.String urlToFlush, FlushService.RefetchType refetchType, java.lang.String... refetchUrls) Sends a flush request to the 'flush' replication-agent using the given session and using the given refetchType.

Method Detail

sendFlushUrl

boolean sendFlushUrl(java.lang.String userId,
                     FlushService.FlushType flushType,
                     java.lang.String urlToFlush,
                     FlushService.RefetchType refetchType,
                     java.lang.String... refetchUrls)

Sends a flush request to the 'flush' replication-agent using the given session and using the given refetchType.

Parameters:

userId - the userId on which behalf this url is being flushed - will propagate to the replication agent

flushType - whether to send this flush request directly or to delay it to reduce flush-load on high-frequency resources

urlToFlush - the file matching this path plus all matching urlToFlush.* will be flushed with the dispatcher (as a result of using DEACTIVATE).

refetchType - whether to refetch any urls, immediately or delayed

refetchUrls - optional refetch urls

Returns:

whether or not the flush command was sent to the agent