|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.store.XWikiHibernateBaseStore
com.xpn.xwiki.store.hibernate.HibernateAttachmentRecycleBinStore
@Component @Named(value="hibernate") @Singleton public class HibernateAttachmentRecycleBinStore
Realization of AttachmentRecycleBinStore
for Hibernate-based storage.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.xpn.xwiki.store.XWikiHibernateBaseStore |
---|
XWikiHibernateBaseStore.HibernateCallback<T> |
Field Summary |
---|
Fields inherited from class com.xpn.xwiki.store.XWikiHibernateBaseStore |
---|
loggerManager |
Constructor Summary | |
---|---|
HibernateAttachmentRecycleBinStore()
Empty constructor needed for component manager. |
|
HibernateAttachmentRecycleBinStore(XWikiContext context)
Deprecated. 1.6M1. Use ComponentManager.lookup(AttachmentRecycleBinStore.class) instead. |
Method Summary | |
---|---|
void |
deleteFromRecycleBin(long index,
XWikiContext context,
boolean bTransaction)
Permanently delete attachment from recycle bin. |
List<DeletedAttachment> |
getAllDeletedAttachments(XWikiAttachment attachment,
XWikiContext context,
boolean bTransaction)
Get all the deleted attachments from the database matching an attachment template (document name and filename). |
List<DeletedAttachment> |
getAllDeletedAttachments(XWikiDocument doc,
XWikiContext context,
boolean bTransaction)
Get all the deleted attachments for a given document. |
DeletedAttachment |
getDeletedAttachment(long index,
XWikiContext context,
boolean bTransaction)
Returns a handler for a deleted attachment. |
XWikiAttachment |
restoreFromRecycleBin(XWikiAttachment attachment,
long index,
XWikiContext context,
boolean bTransaction)
Restore an attachment from the recycle bin (with full history). |
void |
saveToRecycleBin(XWikiAttachment attachment,
String deleter,
Date date,
XWikiContext context,
boolean bTransaction)
Save attachment to recycle bin, with full history. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
@Deprecated public HibernateAttachmentRecycleBinStore(XWikiContext context)
XWiki
during storage initialization.
context
- The current context.public HibernateAttachmentRecycleBinStore()
Method Detail |
---|
public void saveToRecycleBin(XWikiAttachment attachment, String deleter, Date date, XWikiContext context, boolean bTransaction) throws XWikiException
AttachmentRecycleBinStore
saveToRecycleBin
in interface AttachmentRecycleBinStore
attachment
- The attachment to save.deleter
- The user which deleted the attachment.date
- Date of delete action.context
- The current context.bTransaction
- Should use old transaction (false) or create new (true).
XWikiException
- If an exception occurs during the attachment export or attachment persistence.public XWikiAttachment restoreFromRecycleBin(XWikiAttachment attachment, long index, XWikiContext context, boolean bTransaction) throws XWikiException
AttachmentRecycleBinStore
restoreFromRecycleBin
in interface AttachmentRecycleBinStore
attachment
- Optional attachment to restore. If a non-null value is passed, then this object will be changed
to reflect the contents/history of the deleted attachment.index
- What deleted attachment to restore. See DeletedAttachment.getId()
.context
- The current context.bTransaction
- Should use old transaction (false) or create new (true).
null
if an entry with the requested ID does not exist.
XWikiException
- If an error occurs while loading or restoring the attachment.AttachmentRecycleBinStore.getDeletedAttachment(long, XWikiContext, boolean)
public DeletedAttachment getDeletedAttachment(long index, XWikiContext context, boolean bTransaction) throws XWikiException
AttachmentRecycleBinStore
handler
for a deleted attachment.
getDeletedAttachment
in interface AttachmentRecycleBinStore
index
- What deleted attachment to restore. See DeletedAttachment.getId()
context
- The current context.bTransaction
- Should use old transaction (false) or create new (true).
null
if not found.
XWikiException
- If an error occurs while loading or restoring the attachment.AttachmentRecycleBinStore.restoreFromRecycleBin(XWikiAttachment, long, XWikiContext, boolean)
public List<DeletedAttachment> getAllDeletedAttachments(XWikiAttachment attachment, XWikiContext context, boolean bTransaction) throws XWikiException
AttachmentRecycleBinStore
getAllDeletedAttachments
in interface AttachmentRecycleBinStore
attachment
- Optional attachment template. If null
, return information about all deleted
attachments from the database. Otherwise, filter by the document and filename provided in the passed
attachment.context
- The current context.bTransaction
- Should use old transaction (false) or create new (true).
XWikiException
- If an error occurs while loading or restoring the attachments.public List<DeletedAttachment> getAllDeletedAttachments(XWikiDocument doc, XWikiContext context, boolean bTransaction) throws XWikiException
AttachmentRecycleBinStore
getAllDeletedAttachments
in interface AttachmentRecycleBinStore
doc
- The document for which to retrieve deleted attachments.context
- The current context.bTransaction
- Should use old transaction (false) or create new (true).
XWikiException
- If an error occurs while loading or restoring the attachments.public void deleteFromRecycleBin(long index, XWikiContext context, boolean bTransaction) throws XWikiException
AttachmentRecycleBinStore
deleteFromRecycleBin
in interface AttachmentRecycleBinStore
index
- Which instance to delete from the recycle bin.context
- The current context.bTransaction
- Should use old transaction (false) or create new (true).
XWikiException
- If an error occurs while executing the query.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |