Package org.xwiki.filter.instance.input

Interface InstanceInputEventGenerator

All Superinterfaces:

org.xwiki.filter.instance.internal.InstanceFilter, org.xwiki.filter.UnknownFilter, WikiDocumentFilter, WikiFarmFilter, WikiFilter, WikiSpaceFilter

All Known Implementing Classes:

AbstractInstanceInputEventGenerator

@Role
public interface InstanceInputEventGenerator
extends org.xwiki.filter.instance.internal.InstanceFilter

Since:

6.2M1

Version:

$Id: 641893bbc1e6fc50f8ade76069da35d0cde51506 $

Field Summary

Fields inherited from interface org.xwiki.filter.UnknownFilter

FILTER_ELEMENT_ID

Fields inherited from interface org.xwiki.filter.event.model.WikiDocumentFilter

LOG_DOCUMENT_CREATED, LOG_DOCUMENT_DELETED, LOG_DOCUMENT_ERROR, LOG_DOCUMENT_SKIPPED, LOG_DOCUMENT_UPDATED, PARAMETER_CONTENT, PARAMETER_CONTENT_AUTHOR, PARAMETER_CONTENT_DATE, PARAMETER_CONTENT_HTML, PARAMETER_CREATION_AUTHOR, PARAMETER_CREATION_DATE, PARAMETER_CUSTOMCLASS, PARAMETER_DEFAULTTEMPLATE, PARAMETER_HIDDEN, PARAMETER_LASTREVISION, PARAMETER_LOCALE, PARAMETER_PARENT, PARAMETER_REVISION_AUTHOR, PARAMETER_REVISION_COMMENT, PARAMETER_REVISION_DATE, PARAMETER_REVISION_EFFECTIVEMETADATA_AUTHOR, PARAMETER_REVISION_MINOR, PARAMETER_REVISION_ORIGINALMETADATA_AUTHOR, PARAMETER_SYNTAX, PARAMETER_TITLE, PARAMETER_VALIDATIONSCRIPT

Method Summary

Modifier and Type	Method	Description
org.xwiki.filter.descriptor.FilterStreamDescriptor	getDescriptor()
Collection<Class<?>>	getFilterInterfaces()
void	setFilter(Object filter)
void	setProperties(Map<String,Object> properties)
void	setWikiDocumentParameters(String name, org.xwiki.filter.FilterEventParameters parameters)	Set custom parameter related to the document.
void	setWikiFarmParameters(org.xwiki.filter.FilterEventParameters parameters)	Set custom parameter related to the farm.
void	setWikiParameters(String name, org.xwiki.filter.FilterEventParameters parameters)	Set custom parameter related to the wiki.
void	setWikiSpaceParameters(String name, org.xwiki.filter.FilterEventParameters parameters)	Set custom parameter related to the space.

Methods inherited from interface org.xwiki.filter.UnknownFilter

beginUnknwon, endUnknwon, onUnknwon

Methods inherited from interface org.xwiki.filter.event.model.WikiDocumentFilter

beginWikiDocument, beginWikiDocumentLocale, beginWikiDocumentRevision, endWikiDocument, endWikiDocumentLocale, endWikiDocumentRevision

Methods inherited from interface org.xwiki.filter.event.model.WikiFarmFilter

beginWikiFarm, endWikiFarm

Methods inherited from interface org.xwiki.filter.event.model.WikiFilter

beginWiki, endWiki

Methods inherited from interface org.xwiki.filter.event.model.WikiSpaceFilter

beginWikiSpace, endWikiSpace

Method Detail

setWikiFarmParameters

void setWikiFarmParameters(org.xwiki.filter.FilterEventParameters parameters)
                    throws org.xwiki.filter.FilterException

Set custom parameter related to the farm.

Parameters:

parameters - the parameters to set

Throws:

org.xwiki.filter.FilterException - when failing to set parameters

Since:

6.2M1

setWikiParameters

void setWikiParameters(String name,
                       org.xwiki.filter.FilterEventParameters parameters)
                throws org.xwiki.filter.FilterException

Set custom parameter related to the wiki.

Parameters:

name - the name of wiki

parameters - the parameters to set

Throws:

org.xwiki.filter.FilterException - when failing to set parameters

Since:

6.2M1

setWikiSpaceParameters

void setWikiSpaceParameters(String name,
                            org.xwiki.filter.FilterEventParameters parameters)
                     throws org.xwiki.filter.FilterException

Set custom parameter related to the space.

Parameters:

name - the name of space

parameters - the parameters to set

Throws:

org.xwiki.filter.FilterException - when failing to set parameters

Since:

6.2M1

setWikiDocumentParameters

void setWikiDocumentParameters(String name,
                               org.xwiki.filter.FilterEventParameters parameters)
                        throws org.xwiki.filter.FilterException

Set custom parameter related to the document.

Parameters:

name - the name of document

parameters - the parameters to set

Throws:

org.xwiki.filter.FilterException - when failing to set parameters

Since:

6.2M1

setFilter

void setFilter(Object filter)

Parameters:

filter - the filter to send events to

setProperties

void setProperties(Map<String,Object> properties)

Parameters:

properties - the event generator properties

getDescriptor

org.xwiki.filter.descriptor.FilterStreamDescriptor getDescriptor()

Returns:

The FilterStreamDescriptor describes a FilterStream and has the list of bean class parameters or properties.

getFilterInterfaces

Collection<Class<?>> getFilterInterfaces()
                                  throws org.xwiki.filter.FilterException

Returns:

the filters supported by this stream factory

Throws:

org.xwiki.filter.FilterException - when failing to get filters interfaces