org.xwiki.extension.script

Class ExtensionHistoryScriptService

java.lang.Object

org.xwiki.extension.script.AbstractExtensionScriptService

org.xwiki.extension.script.ExtensionHistoryScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
 @Named(value="extension.history")
 @Singleton
public class ExtensionHistoryScriptService
extends AbstractExtensionScriptService

Various script APIs related to extension job history.

Since:

7.1M2

Version:

$Id: c5cb7c283e8a60c5866cb3bf688016dd48479d0a $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ExtensionHistoryScriptService.ExtensionHistoryFilter Utility class to build filters for the extension job history.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID The identifier of the sub extension ScriptService.

Fields inherited from class org.xwiki.extension.script.AbstractExtensionScriptService

authorization, documentAccessBridge, execution, EXTENSIONERROR_KEY, jobExecutor, PROPERTY_CALLERREFERENCE, PROPERTY_CHECKRIGHTS, PROPERTY_CONTEXT_ACTION, PROPERTY_CONTEXT_WIKI, PROPERTY_USERREFERENCE, scriptProvider, WIKI_NAMESPACE_PREFIX, xcontextProvider

Constructor Summary

Constructors

Constructor and Description
ExtensionHistoryScriptService()

Method Summary

Modifier and Type	Method and Description
List<org.xwiki.extension.job.history.ExtensionJobHistoryRecord>	createReplayPlan(List<org.xwiki.extension.job.history.ExtensionJobHistoryRecord> records, boolean preserveUsers, Collection<String> namespaces) Prepares a list of history records for replay.
List<org.xwiki.extension.job.history.ExtensionJobHistoryRecord>	deserialize(String serializedHistoryRecords) Deserializes a list of history records.
ExtensionHistoryScriptService.ExtensionHistoryFilter	getRecords()
org.xwiki.extension.job.history.ReplayJobStatus	getReplayJobStatus(String id)
List<org.xwiki.extension.job.history.ExtensionJobHistoryRecord>	read(InputStream inputStream) Reads a list of history records from a given input stream (e.g.
org.xwiki.job.Job	replay(List<org.xwiki.extension.job.history.ExtensionJobHistoryRecord> records) Replay the given list of extension history records.
String	serialize(org.xwiki.extension.job.history.ExtensionJobHistoryRecord record) Serializes a history record.

Methods inherited from class org.xwiki.extension.script.AbstractExtensionScriptService

contextualize, fromWikitoNamespace, getCallerDocument, getJobStatus, getLastError, safe, safeWrapError, setError, setRightsProperties, toWikiId, wrapError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID

public static final String ID

The identifier of the sub extension ScriptService.

See Also:

Constant Field Values

Constructor Detail

ExtensionHistoryScriptService

public ExtensionHistoryScriptService()

Method Detail

getRecords

public ExtensionHistoryScriptService.ExtensionHistoryFilter getRecords()

Returns:

a new history filter

serialize

public String serialize(org.xwiki.extension.job.history.ExtensionJobHistoryRecord record)

Serializes a history record.

Parameters:

record - the history record to serialize

Returns:

the string serialization of the given history record

deserialize

public List<org.xwiki.extension.job.history.ExtensionJobHistoryRecord> deserialize(String serializedHistoryRecords)

Deserializes a list of history records.

Parameters:

serializedHistoryRecords - the serialized list of history records

Returns:

the list of history records

read

public List<org.xwiki.extension.job.history.ExtensionJobHistoryRecord> read(InputStream inputStream)

Reads a list of history records from a given input stream (e.g. the attachment content input stream).

Parameters:

inputStream - an input stream that provides a list of serialized history records

Returns:

the list of history records

replay

public org.xwiki.job.Job replay(List<org.xwiki.extension.job.history.ExtensionJobHistoryRecord> records)

Replay the given list of extension history records.

Parameters:

records - the history records to replay

Returns:

the Job object that can be used to monitor the progress of the replay process, or null in case of failure

createReplayPlan

public List<org.xwiki.extension.job.history.ExtensionJobHistoryRecord> createReplayPlan(List<org.xwiki.extension.job.history.ExtensionJobHistoryRecord> records,
                                                                                        boolean preserveUsers,
                                                                                        Collection<String> namespaces)

Prepares a list of history records for replay.

Parameters:

records - the history records to prepare for replay

preserveUsers - true if the given history records should be replayed using their original users, false if the current user should be used instead

namespaces - the namespaces where to replay the given history records; pass null or an empty collection if you want to preserve the original namespaces

Returns:

the modified history records, prepared to be replayed

getReplayJobStatus

public org.xwiki.extension.job.history.ReplayJobStatus getReplayJobStatus(String id)

Parameters:

id - identifies the replay job

Returns:

the status of the specified replay job