com.xpn.xwiki.doc

Class DeletedAttachment

java.lang.Object

com.xpn.xwiki.util.AbstractSimpleClass

com.xpn.xwiki.doc.DeletedAttachment

public class DeletedAttachment
extends AbstractSimpleClass

Archive of deleted attachment, stored in AttachmentRecycleBinStore. Immutable, because deleted attachments should not be modified.

Since:

1.4M1

Version:

$Id: c8daacd377284fdd83f5988c7deb293d73c4465a $

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeletedAttachment() Default constructor.
	DeletedAttachment(long docId, String docName, String filename, String storeType, String deleter, Date deleteDate, DeletedAttachmentContent content)
	DeletedAttachment(long docId, String docName, String filename, String storeType, String deleter, Date deleteDate, DeletedAttachmentContent content, long id)
	DeletedAttachment(XWikiAttachment attachment, String deleter, Date deleteDate, XWikiContext context) A constructor with all the information about the deleted attachment.

Method Summary

Modifier and Type	Method and Description
AttachmentReference	getAttachmentReference()
String	getContentStore()
Date	getDate() Getter for date.
String	getDeleter() Getter for deleter.
long	getDocId() Getter for docId.
String	getDocName() Getter for docName.
String	getFilename() Getter for filename.
long	getId() Getter for id.
String	getXml() Getter for content.
XWikiAttachment	restoreAttachment()
XWikiAttachment	restoreAttachment(XWikiAttachment attachment) Restore a XWikiAttachment from a DeletedAttachment.
XWikiAttachment	restoreAttachment(XWikiAttachment attachment, XWikiContext context) Deprecated. since 9.9RC1, use restoreAttachment(XWikiAttachment) instead
protected void	setAttachment(XWikiAttachment attachment, XWikiContext context) Deprecated. since 9.9RC1, use DeletedAttachment(long, String, String, String, String, Date, DeletedAttachmentContent) instead
void	setContentStore(String xmlStore)
protected void	setDate(Date date) Setter for date.
protected void	setDeleter(String deleter) Setter for deleter.
protected void	setDocId(long docId) Setter for docId.
protected void	setDocName(String docName) Setter for docName.
protected void	setFilename(String filename) Setter for filename.
protected void	setId(long id) Setter for id.
protected void	setXml(String xml) Setter for content.

Methods inherited from class com.xpn.xwiki.util.AbstractSimpleClass

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeletedAttachment

protected DeletedAttachment()

Default constructor. Used only by hibernate when restoring objects from the database.

DeletedAttachment

public DeletedAttachment(XWikiAttachment attachment,
                         String deleter,
                         Date deleteDate,
                         XWikiContext context)
                  throws XWikiException

A constructor with all the information about the deleted attachment.

Parameters:

attachment - Deleted attachment.

deleter - User which deleted the attachment.

deleteDate - Date of delete action.

context - The current context. Used for determining the encoding.

Throws:

XWikiException - If the attachment cannot be exported to XML.

DeletedAttachment

public DeletedAttachment(long docId,
                         String docName,
                         String filename,
                         String storeType,
                         String deleter,
                         Date deleteDate,
                         DeletedAttachmentContent content)

Parameters:

docId - the ID of the document this attachment belonged to

docName - the reference of the document this attachment belonged to

filename - the name of the attachment

storeType - the way to store the document

deleter - the user who delete document

deleteDate - date of delete action

content - the stored deleted document

Since:

9.10RC1

DeletedAttachment

public DeletedAttachment(long docId,
                         String docName,
                         String filename,
                         String storeType,
                         String deleter,
                         Date deleteDate,
                         DeletedAttachmentContent content,
                         long id)

Parameters:

docId - the ID of the document this attachment belonged to

docName - the reference of the document this attachment belonged to

filename - the name of the attachment

storeType - the way to store the document

deleter - the user who delete document

deleteDate - date of delete action

content - the stored deleted document

id - the synthetic id of this deleted attachment. Uniquely identifies an entry in the recycle bin.

Since:

9.10RC1

Method Detail

getId

public long getId()

Getter for id.

Returns:

The synthetic id of this deleted attachment. Uniquely identifies an entry in the recycle bin.

setId

protected void setId(long id)

Setter for id.

Parameters:

id - The synthetic id to set. Used only by hibernate.

getDocId

public long getDocId()

Getter for docId.

Returns:

The id of the document this attachment belonged to.

setDocId

protected void setDocId(long docId)

Setter for docId.

Parameters:

docId - The id of the document to set. Used only by hibernate.

getDocName

public String getDocName()

Getter for docName.

Returns:

The name of the document this attachment belonged to.

setDocName

protected void setDocName(String docName)

Setter for docName.

Parameters:

docName - The document name to set. Used only by hibernate.

getFilename

public String getFilename()

Getter for filename.

Returns:

The name of the attachment.

setFilename

protected void setFilename(String filename)

Setter for filename.

Parameters:

filename - The attachment filename to set. Used only by hibernate.

getAttachmentReference

public AttachmentReference getAttachmentReference()

Returns:

the attachment reference for the deleted attachment

Since:

9.9RCA

getDate

public Date getDate()

Getter for date.

Returns:

The date of the delete action.

setDate

protected void setDate(Date date)

Setter for date.

Parameters:

date - The date of the delete action to set. Used only by Hibernate.

getDeleter

public String getDeleter()

Getter for deleter.

Returns:

the user who deleted the attachment, as its document name (e.g. XWiki.Admin)

setDeleter

protected void setDeleter(String deleter)

Setter for deleter.

Parameters:

deleter - The user which has removed the document to set. Used only by Hibernate.

getContentStore

public String getContentStore()

Returns:

the type of the store used for the content

Since:

9.10RC1

setContentStore

public void setContentStore(String xmlStore)

Parameters:

xmlStore - the type of store (supported values are null/"hibernate" and "file")

Since:

9.10RC1

getXml

public String getXml()

Getter for content.

Returns:

XML serialization of XWikiAttachment

setXml

protected void setXml(String xml)

Setter for content.

Parameters:

xml - XML serialization of XWikiAttachment. Used only by Hibernate.

setAttachment

@Deprecated
protected void setAttachment(XWikiAttachment attachment,
                                         XWikiContext context)
                                  throws XWikiException

Deprecated. since 9.9RC1, use DeletedAttachment(long, String, String, String, String, Date, DeletedAttachmentContent) instead

Export XWikiAttachment to DeletedAttachment.

Parameters:

attachment - the deleted attachment

context - the current context, used in the XML export

Throws:

XWikiException - if an exception occurs during the XML export

restoreAttachment

@Deprecated
public XWikiAttachment restoreAttachment(XWikiAttachment attachment,
                                                     XWikiContext context)
                                              throws XWikiException

Deprecated. since 9.9RC1, use restoreAttachment(XWikiAttachment) instead

Restore a XWikiAttachment from a DeletedAttachment. Note that this method does not actually restore the attachment to its owner document, it simply re-composes an XWikiAttachment object from the saved data.

Parameters:

attachment - optional object where to put the attachment data, if not null

context - the current context

Returns:

restored attachment

Throws:

XWikiException - If an exception occurs while the Attachment is restored from the XML. See XWikiAttachment.fromXML(String).

restoreAttachment

public XWikiAttachment restoreAttachment(XWikiAttachment attachment)
                                  throws XWikiException

Restore a XWikiAttachment from a DeletedAttachment. Note that this method does not actually restore the attachment to its owner document, it simply re-composes an XWikiAttachment object from the saved data.

Parameters:

attachment - optional object where to put the attachment data, if not null

Returns:

restored attachment

Throws:

XWikiException - If an exception occurs while the Attachment is restored from the XML. See XWikiAttachment.fromXML(String).

restoreAttachment

public XWikiAttachment restoreAttachment()
                                  throws XWikiException

Returns:

restored attachment

Throws:

XWikiException - if error in XWikiDocument.fromXML(String)

Since:

9.10RC1