com.xpn.xwiki.web

Class DeleteAction

java.lang.Object

com.xpn.xwiki.web.XWikiAction

com.xpn.xwiki.web.DeleteAction

All Implemented Interfaces:

com.xpn.xwiki.internal.web.LegacyAction

Direct Known Subclasses:

DeleteSpaceAction

@Component
 @Named(value="delete")
 @Singleton
public class DeleteAction
extends XWikiAction

Action for delete document to recycle bin and for delete documents from recycle bin.

Version:

$Id: ffacc8ad27b3c14db729bbd664ef9c31e9397df5 $

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ACTION_NAME
protected static String	ASYNC_PARAM
protected static String	CONFIRM_PARAM confirm parameter name.
protected static String	EMPTY_RECYCLE_BIN
protected static String	RECYCLED_DOCUMENT_ID_PARAM

Fields inherited from class com.xpn.xwiki.web.XWikiAction

ACTION_PROGRESS, componentDescriptor, container, execution, handleRedirectObject, observation, waitForXWikiInitialization

Constructor Summary

Constructors

Constructor and Description
DeleteAction()

Method Summary

Modifier and Type	Method and Description
boolean	action(XWikiContext context)
protected boolean	delete(XWikiContext context)
protected boolean	deleteDocument(EntityReference entityReference, XWikiContext context, boolean shouldSkipRecycleBin) Create a job to delete an entity.
String	render(XWikiContext context)

Methods inherited from class com.xpn.xwiki.web.XWikiAction

answerJSON, cleanupComponents, csrfTokenCheck, csrfTokenCheck, execute, execute, getContextualAuthorizationManager, getCurrentMixedDocumentReferenceResolver, getCurrentScriptContext, getEntityNameValidationConfiguration, getEntityNameValidationManager, getFormClass, getLocalization, getLocalSerializer, getName, getProgress, getRealPath, getTranslatedDocument, handleRedirectObject, handleRevision, initializeContainerComponent, initializeXWikiContext, initializeXWikiContext, isEntityReferenceNameValid, localizePlainOrKey, readFromTemplate, resolveTemplate, sendGlobalRedirect, sendRedirect, setContentLength, writeAjaxErrorResponse

Methods inherited from class java.lang.Object

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

Field Detail

CONFIRM_PARAM

protected static final String CONFIRM_PARAM

confirm parameter name.

See Also:

Constant Field Values

ACTION_NAME

protected static final String ACTION_NAME

See Also:

Constant Field Values

ASYNC_PARAM

protected static final String ASYNC_PARAM

See Also:

Constant Field Values

RECYCLED_DOCUMENT_ID_PARAM

protected static final String RECYCLED_DOCUMENT_ID_PARAM

See Also:

Constant Field Values

EMPTY_RECYCLE_BIN

protected static final String EMPTY_RECYCLE_BIN

See Also:

Constant Field Values

Constructor Detail

DeleteAction

public DeleteAction()

Method Detail

action

public boolean action(XWikiContext context)
               throws XWikiException

Overrides:

action in class XWikiAction

Throws:

XWikiException

render

public String render(XWikiContext context)
              throws XWikiException

Overrides:

render in class XWikiAction

Throws:

XWikiException

delete

protected boolean delete(XWikiContext context)
                  throws XWikiException

Throws:

XWikiException

deleteDocument

@Unstable
protected boolean deleteDocument(EntityReference entityReference,
                                           XWikiContext context,
                                           boolean shouldSkipRecycleBin)
                                    throws XWikiException

Create a job to delete an entity. An entity can either be deleted permanently or moved to the recycle bin. The preference of the user deleting the entity is stored in the shouldSkipRecycleBin parameter. When shouldSkipRecycleBin is true the entity is preferably permanently deleted. Otherwise, the entity is preferably moved to the recycle bin. Note that it only express a choice made by the user. If the user does not have the right to remove an entity permanently, the entity might still be saved in the recycle bin. If the wiki does not have access to a recycle bin, the entity might be permanently removed, regardless of the user's preferences.

Parameters:

entityReference - the entity to delete

context - the current context, used to access the user's request

shouldSkipRecycleBin - if false the entity is preferably sent to the recycle bin, if true, the entity is preferably deleted permanently

Returns:

true if the user is redirected, false otherwise

Throws:

XWikiException - if anything goes wrong during the document deletion

Since:

12.8RC1