org.xwiki.wikistream.model.filter

Interface WikiAttachmentFilter

@Unstable
public interface WikiAttachmentFilter

Attachment related events.

Since:

5.2M2

Version:

$Id: 261cc0251a5798a0af506cddc03c065a116a38fb $

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_CONTENT_TYPE
static String	PARAMETER_CREATION_AUTHOR
static String	PARAMETER_CREATION_DATE
static String	PARAMETER_NAME
static String	PARAMETER_REVISION
static String	PARAMETER_REVISION_AUTHOR
static String	PARAMETER_REVISION_COMMENT
static String	PARAMETER_REVISION_DATE

Method Summary

Methods

Modifier and Type	Method and Description
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

PARAMETER_CONTENT_TYPE

static final String PARAMETER_CONTENT_TYPE

See Also:

Constant Field Values

PARAMETER_CREATION_AUTHOR

static final String PARAMETER_CREATION_AUTHOR

See Also:

Constant Field Values

PARAMETER_CREATION_DATE

static final String PARAMETER_CREATION_DATE

See Also:

Constant Field Values

PARAMETER_REVISION

static final String PARAMETER_REVISION

See Also:

Constant Field Values

PARAMETER_REVISION_AUTHOR

static final String PARAMETER_REVISION_AUTHOR

See Also:

Constant Field Values

PARAMETER_REVISION_DATE

static final String PARAMETER_REVISION_DATE

See Also:

Constant Field Values

PARAMETER_REVISION_COMMENT

static final String PARAMETER_REVISION_COMMENT

See Also:

Constant Field Values

Method Detail

onWikiAttachment

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

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:

WikiStreamException - when failing to send event