Package org.xwiki.filter.script

Class FilterScriptService

java.lang.Object

org.xwiki.filter.script.AbstractFilterScriptService

org.xwiki.filter.script.FilterScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
@Named("filter")
@Singleton
public class FilterScriptService
extends AbstractFilterScriptService

Expose various FilterStream related APIs to scripts.

Since:

6.2M1

Version:

$Id: bedccd645354ebf3bfb534c20adbac9ede917532 $

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLEHINT

Fields inherited from class org.xwiki.filter.script.AbstractFilterScriptService

execution, EXTENSIONERROR_KEY, scriptProvider

Constructor Summary

Constructors

Constructor	Description
FilterScriptService()

Method Summary

Modifier and Type	Method	Description
org.xwiki.job.Job	convert(org.xwiki.filter.type.FilterStreamType inputType, Map<String,Object> inputProperties, org.xwiki.filter.type.FilterStreamType outputType, boolean folded, Map<String,Object> outputProperties)
org.xwiki.job.Job	convert(org.xwiki.filter.type.FilterStreamType inputType, Map<String,Object> inputProperties, org.xwiki.filter.type.FilterStreamType outputType, Map<String,Object> outputProperties)
org.xwiki.filter.output.OutputStreamOutputTarget	createOutputStreamOutputTarget(OutputStream stream, boolean autoclose)
org.xwiki.script.service.ScriptService	get(String id)
Collection<org.xwiki.filter.type.FilterStreamType>	getAvailableInputStreams()
Collection<org.xwiki.filter.type.FilterStreamType>	getAvailableOutputStreams()
org.xwiki.job.Job	getCurrentJob()
org.xwiki.filter.descriptor.FilterStreamDescriptor	getInputFilterStreamDescriptor(org.xwiki.filter.type.FilterStreamType inputType)
org.xwiki.filter.input.InputFilterStreamFactory	getInputFilterStreamFactory(org.xwiki.filter.type.FilterStreamType inputType)
org.xwiki.filter.descriptor.FilterStreamDescriptor	getOutputFilterStreamDescriptor(org.xwiki.filter.type.FilterStreamType inputType)
org.xwiki.filter.output.OutputFilterStreamFactory	getOutputFilterStreamFactory(org.xwiki.filter.type.FilterStreamType outputType)
org.xwiki.job.Job	startConvert(org.xwiki.filter.type.FilterStreamType inputType, Map<String,Object> inputProperties, org.xwiki.filter.type.FilterStreamType outputType, boolean folded, Map<String,Object> outputProperties)
org.xwiki.job.Job	startConvert(org.xwiki.filter.type.FilterStreamType inputType, Map<String,Object> inputProperties, org.xwiki.filter.type.FilterStreamType outputType, Map<String,Object> outputProperties)

Methods inherited from class org.xwiki.filter.script.AbstractFilterScriptService

getLastError, resetError, safe, setError

Methods inherited from class java.lang.Object

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

Field Detail

ROLEHINT

public static final String ROLEHINT

See Also:

Constant Field Values

Constructor Detail

FilterScriptService

public FilterScriptService()

Method Detail

get

public org.xwiki.script.service.ScriptService get(String id)

startConvert

public org.xwiki.job.Job startConvert(org.xwiki.filter.type.FilterStreamType inputType,
                                      Map<String,Object> inputProperties,
                                      org.xwiki.filter.type.FilterStreamType outputType,
                                      Map<String,Object> outputProperties)

Since:

6.2M1

startConvert

public org.xwiki.job.Job startConvert(org.xwiki.filter.type.FilterStreamType inputType,
                                      Map<String,Object> inputProperties,
                                      org.xwiki.filter.type.FilterStreamType outputType,
                                      boolean folded,
                                      Map<String,Object> outputProperties)

Since:

8.2RC1

convert

public org.xwiki.job.Job convert(org.xwiki.filter.type.FilterStreamType inputType,
                                 Map<String,Object> inputProperties,
                                 org.xwiki.filter.type.FilterStreamType outputType,
                                 Map<String,Object> outputProperties)

Since:

6.2M1

convert

public org.xwiki.job.Job convert(org.xwiki.filter.type.FilterStreamType inputType,
                                 Map<String,Object> inputProperties,
                                 org.xwiki.filter.type.FilterStreamType outputType,
                                 boolean folded,
                                 Map<String,Object> outputProperties)

Since:

8.2RC1

getCurrentJob

public org.xwiki.job.Job getCurrentJob()

Since:

6.2M1

getAvailableInputStreams

public Collection<org.xwiki.filter.type.FilterStreamType> getAvailableInputStreams()

Since:

6.2M1

getAvailableOutputStreams

public Collection<org.xwiki.filter.type.FilterStreamType> getAvailableOutputStreams()

Since:

6.2M1

getInputFilterStreamDescriptor

public org.xwiki.filter.descriptor.FilterStreamDescriptor getInputFilterStreamDescriptor(org.xwiki.filter.type.FilterStreamType inputType)

Since:

6.2M1

getOutputFilterStreamDescriptor

public org.xwiki.filter.descriptor.FilterStreamDescriptor getOutputFilterStreamDescriptor(org.xwiki.filter.type.FilterStreamType inputType)

Since:

6.2M1

getInputFilterStreamFactory

public org.xwiki.filter.input.InputFilterStreamFactory getInputFilterStreamFactory(org.xwiki.filter.type.FilterStreamType inputType)

Since:

6.2M1

getOutputFilterStreamFactory

public org.xwiki.filter.output.OutputFilterStreamFactory getOutputFilterStreamFactory(org.xwiki.filter.type.FilterStreamType outputType)

Since:

6.2M1

createOutputStreamOutputTarget

public org.xwiki.filter.output.OutputStreamOutputTarget createOutputStreamOutputTarget(OutputStream stream,
                                                                                       boolean autoclose)

Since:

6.2M1