org.xwiki.wiki.script

Class WikiManagerScriptService

java.lang.Object

org.xwiki.wiki.script.WikiManagerScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
@Named(value="wiki")
@Singleton
public class WikiManagerScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Script service to manage wikis.

Since:

5.3M2

Version:

$Id: 79d5e0f11631a8b316a78ed509a32008fa567aea $

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_LASTEXCEPTION Deprecated.
static String	ROLEHINT Hint of the component.

Constructor Summary

Constructors

Constructor and Description
WikiManagerScriptService()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDeleteWiki(String userId, String wikiId) Test if a given user can delete a given wiki.
WikiDescriptor	createWiki(String wikiId, String wikiAlias, String ownerId, boolean failOnExist) Create a new wiki.
boolean	deleteWiki(String wikiId) Delete the specified wiki.
Boolean	exists(String wikiId) Test if a wiki exists.
org.xwiki.script.service.ScriptService	get(String serviceName) Get a sub script service related to wiki.
String	getAliasSuffix()
Collection<WikiDescriptor>	getAll() Get all the wiki descriptors.
Collection<String>	getAllIds() Get all the wiki identifiers.
WikiDescriptor	getByAlias(String wikiAlias) Get a wiki descriptor from one of its alias.
WikiDescriptor	getById(String wikiId) Get a wiki descriptor from its unique identifier.
String	getCurrentWikiId()
Exception	getLastError() Get the error generated while performing the previously called action.
Exception	getLastException() Deprecated. since 5.4RC1 use getLastError() ()} instead
WikiDescriptor	getMainWikiDescriptor()
String	getMainWikiId()
Boolean	idAvailable(String wikiId) Check if the wikiId is valid and available (the name is not already taken for technical reasons).
boolean	isPathMode() Tell if the path mode is used for subwikis.
boolean	saveDescriptor(WikiDescriptor descriptor) Save the specified descriptor (if you have the right).

Methods inherited from class java.lang.Object

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

Field Detail

ROLEHINT

public static final String ROLEHINT

Hint of the component.

See Also:

Constant Field Values

CONTEXT_LASTEXCEPTION

@Deprecated
public static final String CONTEXT_LASTEXCEPTION

Deprecated.

Field name of the last API exception inserted in context.

See Also:

Constant Field Values

Constructor Detail

WikiManagerScriptService

public WikiManagerScriptService()

Method Detail

get

public org.xwiki.script.service.ScriptService get(String serviceName)

Get a sub script service related to wiki. (Note that we're voluntarily using an API name of "get" to make it extra easy to access Script Services from Velocity (since in Velocity writing $services.wiki.name is equivalent to writing $services.wiki.get("name")). It also makes it a short and easy API name for other scripting languages.

Parameters:

serviceName - id of the script service

Returns:

the service asked or null if none could be found

getLastError

public Exception getLastError()

Get the error generated while performing the previously called action.

Returns:

an eventual exception or null if no exception was thrown

createWiki

public WikiDescriptor createWiki(String wikiId,
                        String wikiAlias,
                        String ownerId,
                        boolean failOnExist)

Create a new wiki.

Parameters:

wikiId - unique identifier of the new wiki

wikiAlias - default alias of the new wiki

ownerId - Id of the user that will own the wiki

failOnExist - Fail the operation if the wiki id already exists

Returns:

the wiki descriptor of the new wiki, or null if problems occur

deleteWiki

public boolean deleteWiki(String wikiId)

Delete the specified wiki.

Parameters:

wikiId - unique identifier of the wiki to delete

Returns:

true if the wiki has been successfully deleted

canDeleteWiki

public boolean canDeleteWiki(String userId,
                    String wikiId)

Test if a given user can delete a given wiki.

Parameters:

userId - the id of the user to test

wikiId - the id of the wiki

Returns:

whether or not the user can delete the specified wiki

getByAlias

public WikiDescriptor getByAlias(String wikiAlias)

Get a wiki descriptor from one of its alias.

Parameters:

wikiAlias - alias to search

Returns:

the wiki descriptor corresponding to the alias, or null if no descriptors match the alias

getById

public WikiDescriptor getById(String wikiId)

Get a wiki descriptor from its unique identifier.

Parameters:

wikiId - unique identifier of the wiki to search

Returns:

the wiki descriptor corresponding to the Id, or null if no descriptors match the id

getAll

public Collection<WikiDescriptor> getAll()

Get all the wiki descriptors.

Returns:

the list of all wiki descriptors

getAllIds

public Collection<String> getAllIds()

Get all the wiki identifiers.

Returns:

the list of all wiki identifiers

Since:

6.2M1

exists

public Boolean exists(String wikiId)

Test if a wiki exists.

Parameters:

wikiId - unique identifier to test

Returns:

true if a wiki with this Id exists on the system or null if some error occurs.

idAvailable

public Boolean idAvailable(String wikiId)

Check if the wikiId is valid and available (the name is not already taken for technical reasons).

Parameters:

wikiId - the Id to test

Returns:

true if the Id is valid and available or null if some error occurs

getMainWikiDescriptor

public WikiDescriptor getMainWikiDescriptor()

Returns:

the descriptor of the main wiki or null if problems occur

getMainWikiId

public String getMainWikiId()

Returns:

the Id of the main wiki

getCurrentWikiId

public String getCurrentWikiId()

Returns:

the id of the current wiki

saveDescriptor

public boolean saveDescriptor(WikiDescriptor descriptor)

Save the specified descriptor (if you have the right).

Parameters:

descriptor - descriptor to save

Returns:

true if it succeed

isPathMode

public boolean isPathMode()

Tell if the path mode is used for subwikis. Example:

 wiki alias: subwiki
 URL if path mode is enabled:
   /xwiki/wiki/subwiki/
 URL if path mode is disabled:
   http://subwiki/
 
 

Returns:

either or not the path mode is enabled

getAliasSuffix

public String getAliasSuffix()

Returns:

the default suffix to append to new wiki aliases.

getLastException

@Deprecated
public Exception getLastException()

Deprecated. since 5.4RC1 use getLastError() ()} instead

Returns:

the last exception, or null if there is not