com.adobe.cq.screens.offlinecontent

Interface OfflineContentService

public interface OfflineContentService

Manages the offline content in the repository.

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<Resource>	getCopiedOfflineConfig(Resource assignment) Returns the list of configs copied for the provided assignment.
java.util.Iterator<Resource>	getOfflineConfigs(Resource channel) Retrieves the offline configuration node for that channel.
long	getOfflineTimestamp(Resource channel) Get the offline timestamp value for the channel
long	prepareOfflineContentForAssignment(Resource assignment) Update the offline content in the context of the specified assignment.
long	prepareOfflineContentForChannel(Resource channel, Resource offlineConfig) Update the offline content in the context of the specified channel.
void	updateOfflineTimestamp(Resource channel, long timestamp) Update the offline timestamp property for the channel

Method Detail

getOfflineConfigs

java.util.Iterator<Resource> getOfflineConfigs(Resource channel)

Retrieves the offline configuration node for that channel.

Parameters:

channel - The channel for which we want to get the offline config

Returns:

the offline config resources

getOfflineTimestamp

long getOfflineTimestamp(Resource channel)

Get the offline timestamp value for the channel

Parameters:

channel - The channel

Returns:

The offline timestamp value, or -1L if not set

updateOfflineTimestamp

void updateOfflineTimestamp(Resource channel,
                            long timestamp)
                     throws RepositoryException

Update the offline timestamp property for the channel

Parameters:

channel - The channel to update

timestamp - The new timestamp

Throws:

RepositoryException - if there is a repository exception

prepareOfflineContentForChannel

long prepareOfflineContentForChannel(Resource channel,
                                     Resource offlineConfig)

Update the offline content in the context of the specified channel.

Parameters:

channel - The channel for which we want to recreate the offline content

offlineConfig - The offline config resource

Returns:

the last modification timestamp for the offline config cache

prepareOfflineContentForAssignment

long prepareOfflineContentForAssignment(Resource assignment)
                                 throws PersistenceException

Update the offline content in the context of the specified assignment.

Parameters:

assignment - The assignment for which we want to recreate the offline content

Returns:

the last modification timestamp for the offline config cache

Throws:

PersistenceException - if there was a error preparing the offline content

getCopiedOfflineConfig

java.util.Iterator<Resource> getCopiedOfflineConfig(Resource assignment)

Returns the list of configs copied for the provided assignment.

Parameters:

assignment - The channel assignment

Returns:

A list of configs (might be empty)