org.xwiki.filter.event.model

Interface WikiAttachmentFilter

public interface WikiAttachmentFilter

Attachment related events.

Since:

6.2M1

Version:

$Id: 4a95884769b914e3299e175b3daef84d5bc88c5d $

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_CHARSET
static String	PARAMETER_CONTENT_TYPE
static String	PARAMETER_CREATION_AUTHOR
static String	PARAMETER_CREATION_DATE
static String	PARAMETER_MIMETYPE
static String	PARAMETER_NAME
static String	PARAMETER_REVISION
static String	PARAMETER_REVISION_AUTHOR
static String	PARAMETER_REVISION_COMMENT
static String	PARAMETER_REVISION_CONTENT_ALIAS
static String	PARAMETER_REVISION_DATE
static String	VALUE_REVISION_CONTENT_ALIAS_CURRENT

Method Summary

Modifier and Type	Method and Description
default void	beginWikiAttachmentRevision(String version, org.xwiki.filter.input.InputSource content, Long size, org.xwiki.filter.FilterEventParameters parameters)
default void	beginWikiAttachmentRevisions(org.xwiki.filter.FilterEventParameters parameters)
default void	beginWikiDocumentAttachment(String name, org.xwiki.filter.input.InputSource content, Long size, org.xwiki.filter.FilterEventParameters parameters)
default void	endWikiAttachmentRevision(String version, org.xwiki.filter.input.InputSource content, Long size, org.xwiki.filter.FilterEventParameters parameters)
default void	endWikiAttachmentRevisions(org.xwiki.filter.FilterEventParameters parameters)
default void	endWikiDocumentAttachment(String name, org.xwiki.filter.input.InputSource content, Long size, org.xwiki.filter.FilterEventParameters parameters)
void	onWikiAttachment(String name, InputStream content, Long size, org.xwiki.filter.FilterEventParameters parameters)

Field Detail

PARAMETER_NAME

static final String PARAMETER_NAME

See Also:

Constant Field Values

Type:

String

PARAMETER_MIMETYPE

static final String PARAMETER_MIMETYPE

Since:

7.1M1

See Also:

Constant Field Values

Type:

String

PARAMETER_CHARSET

static final String PARAMETER_CHARSET

Since:

10.11RC1

See Also:

Constant Field Values

Type:

String

PARAMETER_CONTENT_TYPE

static final String PARAMETER_CONTENT_TYPE

See Also:

Constant Field Values

Type:

String

PARAMETER_CREATION_AUTHOR

static final String PARAMETER_CREATION_AUTHOR

See Also:

Constant Field Values

Type:

String

PARAMETER_CREATION_DATE

static final String PARAMETER_CREATION_DATE

See Also:

Constant Field Values

Type:

Date

PARAMETER_REVISION

static final String PARAMETER_REVISION

See Also:

Constant Field Values

Type:

String

PARAMETER_REVISION_AUTHOR

static final String PARAMETER_REVISION_AUTHOR

See Also:

Constant Field Values

Type:

String

PARAMETER_REVISION_DATE

static final String PARAMETER_REVISION_DATE

See Also:

Constant Field Values

Type:

Date

PARAMETER_REVISION_COMMENT

static final String PARAMETER_REVISION_COMMENT

See Also:

Constant Field Values

Type:

String

PARAMETER_REVISION_CONTENT_ALIAS

@Unstable
static final String PARAMETER_REVISION_CONTENT_ALIAS

Since:

12.0RC1

See Also:

Constant Field Values

Type:

String

VALUE_REVISION_CONTENT_ALIAS_CURRENT

@Unstable
static final String VALUE_REVISION_CONTENT_ALIAS_CURRENT

Since:

12.0RC1

See Also:

Constant Field Values

Method Detail

onWikiAttachment

void onWikiAttachment(String name,
                      InputStream content,
                      Long size,
                      @Default(value="")
                      org.xwiki.filter.FilterEventParameters parameters)
               throws org.xwiki.filter.FilterException

Parameters:

name - the name of the attachment

content - the binary content of the attachment

size - the size of the attachment

parameters - the properties of the attachment

Throws:

org.xwiki.filter.FilterException - when failing to send event

beginWikiDocumentAttachment

@Unstable
default void beginWikiDocumentAttachment(String name,
                                                   org.xwiki.filter.input.InputSource content,
                                                   Long size,
                                                   @Default(value="")
                                                   org.xwiki.filter.FilterEventParameters parameters)
                                            throws org.xwiki.filter.FilterException

Parameters:

name - the name of the attachment

content - the binary content of the attachment

size - the size of the attachment

parameters - the properties of the attachment

Throws:

org.xwiki.filter.FilterException - when failing to send event

Since:

12.0RC1

endWikiDocumentAttachment

@Unstable
default void endWikiDocumentAttachment(String name,
                                                 org.xwiki.filter.input.InputSource content,
                                                 Long size,
                                                 @Default(value="")
                                                 org.xwiki.filter.FilterEventParameters parameters)
                                          throws org.xwiki.filter.FilterException

Parameters:

name - the name of the attachment

content - the binary content of the attachment

size - the size of the attachment

parameters - the properties of the attachment

Throws:

org.xwiki.filter.FilterException - when failing to send event

Since:

12.0RC1

beginWikiAttachmentRevisions

@Unstable
default void beginWikiAttachmentRevisions(@Default(value="")
                                                    org.xwiki.filter.FilterEventParameters parameters)
                                             throws org.xwiki.filter.FilterException

Parameters:

parameters - the properties of the attachment

Throws:

org.xwiki.filter.FilterException - when failing to send event

Since:

12.0RC1

endWikiAttachmentRevisions

@Unstable
default void endWikiAttachmentRevisions(@Default(value="")
                                                  org.xwiki.filter.FilterEventParameters parameters)
                                           throws org.xwiki.filter.FilterException

Parameters:

parameters - the properties of the attachment

Throws:

org.xwiki.filter.FilterException - when failing to send event

Since:

12.0RC1

beginWikiAttachmentRevision

@Unstable
default void beginWikiAttachmentRevision(String version,
                                                   org.xwiki.filter.input.InputSource content,
                                                   Long size,
                                                   @Default(value="")
                                                   org.xwiki.filter.FilterEventParameters parameters)
                                            throws org.xwiki.filter.FilterException

Parameters:

version - the revision of the attachment

content - the binary content of the attachment

size - the size of the attachment

parameters - the properties of the attachment

Throws:

org.xwiki.filter.FilterException - when failing to send event

Since:

12.0RC1

endWikiAttachmentRevision

@Unstable
default void endWikiAttachmentRevision(String version,
                                                 org.xwiki.filter.input.InputSource content,
                                                 Long size,
                                                 @Default(value="")
                                                 org.xwiki.filter.FilterEventParameters parameters)
                                          throws org.xwiki.filter.FilterException

Parameters:

version - the revision of the attachment

content - the binary content of the attachment

size - the size of the attachment

parameters - the properties of the attachment

Throws:

org.xwiki.filter.FilterException - when failing to send event

Since:

12.0RC1