CreateActionRequestHandler (XWiki Platform

java.lang.Object
- com.xpn.xwiki.web.CreateActionRequestHandler

```
public class CreateActionRequestHandler
extends Object
```
Helper class used to handle one individual create action request.

Version:

$Id: e341fe71a06f58f1cabdf534f41fde56f238c4e4 $

Constructor Summary

Constructors
Constructor and Description

CreateActionRequestHandler(XWikiContext context)

Constructors
Constructor and Description
`CreateActionRequestHandler(XWikiContext context)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected ContextualAuthorizationManager`	`getAuthManager()`
`List<Document>`	`getAvailableTemplateProviders()`
`protected ScriptContext`	`getCurrentScriptContext()`
`String`	`getName()`
`DocumentReference`	`getNewDocumentReference()`
`List<Document>`	`getRecommendedTemplateProviders()`
`SpaceReference`	`getSpaceReference()`
`BaseObject`	`getTemplateProvider()`
`String`	`getType()`
`org.apache.velocity.VelocityContext`	`getVelocityContext()` Deprecated. since 8.3M1, use `getCurrentScriptContext()` instead
`boolean`	`hasTemplate()`
`boolean`	`isDocumentAlreadyExisting(XWikiDocument newDocument)`
`boolean`	`isDocumentPathTooLong(DocumentReference reference)`
`boolean`	`isSpace()`
`boolean`	`isTemplateProviderAllowedToCreateInCurrentSpace()` Verifies if the creation inside the specified spaceReference is allowed by the current template provider.
`void`	`processRequest()` Process the request and extract from the given parameters the data needed to create the new document.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CreateActionRequestHandler
```
public CreateActionRequestHandler(XWikiContext context)
```
    Parameters:
    
    context - the XWikiContext for which to handle the request.
- Method Detail
  - processRequest
```
public void processRequest()
                    throws XWikiException
```
    Process the request and extract from the given parameters the data needed to create the new document.
    
    Throws:
    
    XWikiException - if problems occur
  - getNewDocumentReference
```
public DocumentReference getNewDocumentReference()
```
    Returns:
    
    the document reference of the new document to be created, null if a no document can be created (because the conditions are not met)
  - hasTemplate
```
public boolean hasTemplate()
```
    Returns:
    
    if a template or a template provider have been set (it can be empty however)
  - isTemplateProviderAllowedToCreateInCurrentSpace
```
public boolean isTemplateProviderAllowedToCreateInCurrentSpace()
```
    Verifies if the creation inside the specified spaceReference is allowed by the current template provider. If the creation is not allowed, an exception will be set on the context.
    
    Returns:
    
    true if the creation is allowed, false otherwise
  - isDocumentAlreadyExisting
```
public boolean isDocumentAlreadyExisting(XWikiDocument newDocument)
```
    Parameters:
    
    newDocument - the new document to check if it already exists
    
    Returns:
    
    true if the document already exists (i.e. is not usable) and set an exception in the velocity context; false otherwise.
  - isDocumentPathTooLong
```
@Unstable
public boolean isDocumentPathTooLong(DocumentReference reference)
```
    Parameters:
    
    reference - the new document reference to check
    
    Returns:
    
    true if the serialized document path is too long according to the limitation provided by XWikiDocument.getLocalReferenceMaxLength().
    
    Since:
    
    11.4RC1
  - getVelocityContext
```
@Deprecated
public org.apache.velocity.VelocityContext getVelocityContext()
```
    Deprecated. since 8.3M1, use getCurrentScriptContext() instead
    
    Returns:
    
    the VelocityContext for the context we are handling
  - getAuthManager
```
protected ContextualAuthorizationManager getAuthManager()
```
    Returns:
    
    the authorization manager
    
    Since:
    
    9.11
  - getCurrentScriptContext
```
protected ScriptContext getCurrentScriptContext()
```
    Returns:
    
    the current script context
    
    Since:
    
    8.3M1
  - getSpaceReference
```
public SpaceReference getSpaceReference()
```
    Returns:
    
    the space reference where the new document will be created
  - getName
```
public String getName()
```
    Returns:
    
    the name of the new document. See isSpace()
  - isSpace
```
public boolean isSpace()
```
    Returns:
    
    true if the new document is a space (i.e. Nested Document and the name means space name) or false if it's a terminal regular document (i.e. Nested Spaces document and the name means document name)
  - getAvailableTemplateProviders
```
public List<Document> getAvailableTemplateProviders()
```
    Returns:
    
    the available template providers for the space from where we are creating the new document
  - getRecommendedTemplateProviders
```
public List<Document> getRecommendedTemplateProviders()
```
    Returns:
    
    the recommended template providers, from the list of available ones
  - getTemplateProvider
```
public BaseObject getTemplateProvider()
```
    Returns:
    
    the currently used template provider read from the request, or null if none was set
  - getType
```
public String getType()
```
    Returns:
    
    the type of document to create, read from the request, or null if none was set
    
    Since:
    
    7.2

Class CreateActionRequestHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateActionRequestHandler

Method Detail

processRequest

getNewDocumentReference

hasTemplate

isTemplateProviderAllowedToCreateInCurrentSpace

isDocumentAlreadyExisting

isDocumentPathTooLong

getVelocityContext

getAuthManager

getCurrentScriptContext

getSpaceReference

getName

isSpace

getAvailableTemplateProviders

getRecommendedTemplateProviders

getTemplateProvider

getType