|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.plugin.XWikiDefaultPlugin
com.xpn.xwiki.plugin.spacemanager.impl.SpaceManagerImpl
com.xpn.xwiki.plugin.workspacesmanager.WorkspacesManager
public class WorkspacesManager
Workspaces manager plugin implementation.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.xpn.xwiki.plugin.spacemanager.api.SpaceManager |
---|
com.xpn.xwiki.plugin.spacemanager.api.SpaceManager.SpaceAction |
Field Summary | |
---|---|
static java.lang.String |
WORKSPACESMANAGER_PLUGIN_NAME
Plugin name |
Fields inherited from class com.xpn.xwiki.plugin.spacemanager.impl.SpaceManagerImpl |
---|
mailNotification, SPACEMANAGER_DEFAULT_EXTENSION, SPACEMANAGER_DEFAULT_MAIL_NOTIFICATION, SPACEMANAGER_DEFAULT_PROTECTED_SUBSPACES, SPACEMANAGER_EXTENSION_CFG_PROP, SPACEMANAGER_PROTECTED_SUBSPACES_PROP, spaceManagerExtension |
Fields inherited from interface com.xpn.xwiki.plugin.spacemanager.api.SpaceManager |
---|
DEFAULT_RESOURCE_SPACE, SPACE_CLASS_NAME, SPACE_DEFAULT_TYPE |
Constructor Summary | |
---|---|
WorkspacesManager(java.lang.String name,
java.lang.String className,
com.xpn.xwiki.XWikiContext context)
|
Method Summary | |
---|---|
void |
addAdmin(java.lang.String spaceName,
java.lang.String username,
com.xpn.xwiki.XWikiContext context)
Since "admin" is considered as a role within XWS, overrides the space manager addAdmin method, to : Remove the user from possible other roles (readers, writers) Add the user to the member group if he is not a space member |
void |
addReader(java.lang.String spaceName,
java.lang.String userName,
boolean allowDowngrade,
com.xpn.xwiki.XWikiContext context)
|
void |
addWriter(java.lang.String spaceName,
java.lang.String userName,
boolean allowDowngrade,
com.xpn.xwiki.XWikiContext context)
|
int |
countMembers(java.lang.String spaceName,
com.xpn.xwiki.XWikiContext context)
|
com.xpn.xwiki.plugin.spacemanager.api.Space |
createSpaceFromRequest(java.lang.String templateSpaceName,
com.xpn.xwiki.XWikiContext context)
First, checks if the workspace creation is allowed, by looking over the request data to ensure that : Users can only have one own workspace (a.k.a the "User space") There can only be one "organization" workspace |
java.lang.String |
getApplicationName(java.lang.String docFullname,
com.xpn.xwiki.XWikiContext context)
|
java.util.Map |
getApplicationsForSpace(java.lang.String spaceName,
com.xpn.xwiki.XWikiContext context)
|
java.lang.String |
getApplicationURL(java.lang.String spaceName,
java.lang.String appName,
java.lang.String docName,
java.lang.String queryString,
com.xpn.xwiki.XWikiContext context)
|
java.util.List |
getDeletedSpaces(com.xpn.xwiki.XWikiContext context)
|
java.util.List |
getLastSpaces(int howMany,
int startAt,
com.xpn.xwiki.XWikiContext context)
|
java.util.Collection |
getMembers(java.lang.String spaceName,
int howMany,
int startAt,
com.xpn.xwiki.XWikiContext context)
|
java.lang.String |
getName()
|
com.xpn.xwiki.plugin.spacemanager.api.Space |
getOrganizationSpace(com.xpn.xwiki.XWikiContext context)
|
com.xpn.xwiki.api.Api |
getPluginApi(com.xpn.xwiki.plugin.XWikiPluginInterface plugin,
com.xpn.xwiki.XWikiContext context)
|
java.util.Collection |
getPotentialMembersForSpace(java.lang.String spaceName,
int howMany,
int startAt,
com.xpn.xwiki.XWikiContext context)
|
java.util.Collection |
getPotentialMembersForSpace(java.lang.String spaceName,
java.lang.String matching,
int howMany,
int startAt,
com.xpn.xwiki.XWikiContext context)
|
java.util.List |
getPublicSpaces(com.xpn.xwiki.XWikiContext context)
|
java.util.Collection |
getReaders(java.lang.String spaceName,
com.xpn.xwiki.XWikiContext context)
|
com.xpn.xwiki.plugin.spacemanager.api.Space |
getRootSpace(java.lang.String web,
com.xpn.xwiki.XWikiContext context)
|
com.xpn.xwiki.plugin.spacemanager.api.Space |
getSpaceForUser(java.lang.String userName,
com.xpn.xwiki.XWikiContext context)
|
com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerExtension |
getSpaceManagerExtension(com.xpn.xwiki.XWikiContext context)
|
java.util.List |
getStoriesForSpace(java.lang.String spaceName,
int startAt,
int howMany,
com.xpn.xwiki.XWikiContext context)
Returns, for a workspace, the list of stories.Story associated with the last modified
documents. |
java.util.Collection |
getWebsForSpace(java.lang.String spaceName,
com.xpn.xwiki.XWikiContext context)
|
protected java.lang.String |
getWorkspaceSpaceClassName()
|
java.util.Collection |
getWriters(java.lang.String spaceName,
com.xpn.xwiki.XWikiContext context)
|
void |
makeSpacePrivate(java.lang.String spaceName,
com.xpn.xwiki.XWikiContext context)
|
void |
makeSpacePublic(java.lang.String spaceName,
com.xpn.xwiki.XWikiContext context)
|
protected com.xpn.xwiki.plugin.spacemanager.api.Space |
newSpace(java.lang.String spaceName,
java.lang.String spaceTitle,
boolean create,
com.xpn.xwiki.XWikiContext context)
|
void |
removeAdmin(java.lang.String spaceName,
java.lang.String userName,
com.xpn.xwiki.XWikiContext context)
|
void |
removeReader(java.lang.String spaceName,
java.lang.String userName,
com.xpn.xwiki.XWikiContext context)
|
void |
removeWriter(java.lang.String spaceName,
java.lang.String userName,
com.xpn.xwiki.XWikiContext context)
|
java.util.List |
searchDocuments(java.lang.String spaceName,
java.lang.String applicationName,
int howMany,
int startAt,
com.xpn.xwiki.XWikiContext context)
|
void |
setReadersRights(java.lang.String spaceName,
com.xpn.xwiki.XWikiContext context)
Set-up the rights objects for the reader group of a workspace |
void |
setWritersRights(java.lang.String spaceName,
com.xpn.xwiki.XWikiContext context)
Set-up the rights objects for the writer group of a workspace |
void |
virtualInit(com.xpn.xwiki.XWikiContext context)
|
Methods inherited from class com.xpn.xwiki.plugin.spacemanager.impl.SpaceManagerImpl |
---|
addAdmins, addMember, addMembers, addRightToGroup, addUsersToRole, addUsersToRoles, addUserToGroup, addUserToRole, addUserToRoles, countSpaces, createSpace, createSpaceFromApplication, createSpaceFromRequest, createSpaceFromTemplate, deleteSpace, deleteSpace, flushCache, getAdminGroupName, getAdmins, getGroupService, getLastModifiedDocuments, getLastModifiedDocuments, getMemberGroupName, getMembers, getProtectedSubSpaces, getRoleGroupName, getRoles, getRoles, getSpace, getSpaceClass, getSpaceClassName, getSpaceDocumentName, getSpaceManagerExtension, getSpaceNames, getSpaceNames, getSpaceNames, getSpaceObjects, getSpaces, getSpaces, getSpaces, getSpaceTypeName, getSpaceUserProfile, getSpaceUserProfilePageName, getSpaceWikiName, getUsersForRole, hasCustomMapping, init, isAdmin, isMailNotification, isMember, isMemberOfGroup, joinSpace, newUserSpaceProfile, removeMember, removeRightFromGroup, removeUserFromRole, removeUserFromRoles, saveSpace, searchDocuments, searchSpaceNames, searchSpaceNames, searchSpaces, searchSpaces, setMailNotification, setSpaceRights, setSubSpaceRights, undeleteSpace, updateSpaceFromRequest, updateSpaceRights, validateSpaceData |
Methods inherited from class com.xpn.xwiki.plugin.XWikiDefaultPlugin |
---|
beginRendering, commonTagsHandler, downloadAttachment, endRendering, endRenderingHandler, flushCache, getClassName, insidePREHandler, outsidePREHandler, setClassName, setName, startRenderingHandler |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.xpn.xwiki.plugin.XWikiPluginInterface |
---|
beginRendering, commonTagsHandler, downloadAttachment, endRendering, endRenderingHandler, flushCache, getClassName, insidePREHandler, outsidePREHandler, setClassName, setName, startRenderingHandler |
Field Detail |
---|
public static final java.lang.String WORKSPACESMANAGER_PLUGIN_NAME
Constructor Detail |
---|
public WorkspacesManager(java.lang.String name, java.lang.String className, com.xpn.xwiki.XWikiContext context)
Method Detail |
---|
public java.lang.String getName()
getName
in interface com.xpn.xwiki.plugin.XWikiPluginInterface
getName
in class com.xpn.xwiki.plugin.spacemanager.impl.SpaceManagerImpl
public void virtualInit(com.xpn.xwiki.XWikiContext context)
virtualInit
in interface com.xpn.xwiki.plugin.XWikiPluginInterface
virtualInit
in class com.xpn.xwiki.plugin.spacemanager.impl.SpaceManagerImpl
public com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerExtension getSpaceManagerExtension(com.xpn.xwiki.XWikiContext context) throws com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
getSpaceManagerExtension
in interface com.xpn.xwiki.plugin.spacemanager.api.SpaceManager
getSpaceManagerExtension
in class com.xpn.xwiki.plugin.spacemanager.impl.SpaceManagerImpl
com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
public com.xpn.xwiki.plugin.spacemanager.api.Space createSpaceFromRequest(java.lang.String templateSpaceName, com.xpn.xwiki.XWikiContext context) throws com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
createSpaceFromRequest
in interface com.xpn.xwiki.plugin.spacemanager.api.SpaceManager
createSpaceFromRequest
in class com.xpn.xwiki.plugin.spacemanager.impl.SpaceManagerImpl
com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
public void addAdmin(java.lang.String spaceName, java.lang.String username, com.xpn.xwiki.XWikiContext context) throws com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
addAdmin
in interface com.xpn.xwiki.plugin.spacemanager.api.SpaceManager
addAdmin
in class com.xpn.xwiki.plugin.spacemanager.impl.SpaceManagerImpl
com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
org.xwiki.plugin.spacemanager.impl.SpaceManagerImpl#addAdmin(String, String,
XWikiContext)
public void addReader(java.lang.String spaceName, java.lang.String userName, boolean allowDowngrade, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
WorkspacesManagerApi.addReader(String, String, boolean)
public void removeAdmin(java.lang.String spaceName, java.lang.String userName, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
removeAdmin
in interface com.xpn.xwiki.plugin.spacemanager.api.SpaceManager
removeAdmin
in class com.xpn.xwiki.plugin.spacemanager.impl.SpaceManagerImpl
WorkspacesManagerException
WorkspacesManagerApi.removeAdmin(String, String)
public void removeReader(java.lang.String spaceName, java.lang.String userName, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
WorkspacesManagerApi.removeReader(String, String)
public void removeWriter(java.lang.String spaceName, java.lang.String userName, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
WorkspacesManagerApi.removeWriter(String, String)
public void setWritersRights(java.lang.String spaceName, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
spaceName
- the name of the space to set the writer rights of
WorkspacesManagerException
public void setReadersRights(java.lang.String spaceName, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
spaceName
- the name of the space to set the reader rights of
WorkspacesManagerException
public void addWriter(java.lang.String spaceName, java.lang.String userName, boolean allowDowngrade, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
WorkspacesManagerApi.addWriter(String, String, boolean)
public java.util.Collection getReaders(java.lang.String spaceName, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
WorkspacesManagerApi.getReaders(String)
public java.util.Collection getWriters(java.lang.String spaceName, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
WorkspacesManagerApi.getWriters(String)
public java.util.Collection getPotentialMembersForSpace(java.lang.String spaceName, int howMany, int startAt, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
WorkspacesManagerApi.getPotentialMembers(String, int, int)
public java.util.Collection getPotentialMembersForSpace(java.lang.String spaceName, java.lang.String matching, int howMany, int startAt, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
WorkspacesManagerApi.getPotentialMembers(String, String, int, int)
public java.util.List getStoriesForSpace(java.lang.String spaceName, int startAt, int howMany, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
stories.Story
associated with the last modified
documents. Stories are built by a stories.StoryBuilder
chosen for each story
according to the application the modified document belong to.
spaceName
- the XWiki name of the workspace to return the stories forstartAt
- the offset to start retrieving modified documents at in the workspacehowMany
- the number of stories to retrieve
WorkspacesManagerException
public java.util.List getDeletedSpaces(com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
WorkspacesManagerApi.getDeletedSpaces()
public com.xpn.xwiki.plugin.spacemanager.api.Space getOrganizationSpace(com.xpn.xwiki.XWikiContext context) throws com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
WorkspacesManagerException
com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
WorkspacesManagerApi.getOrganizationSpace()
public java.util.List getPublicSpaces(com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
WorkspacesManagerApi.getPublicSpaces()
public void makeSpacePrivate(java.lang.String spaceName, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
WorkspacesManagerApi.makeSpacePrivate(String)
public void makeSpacePublic(java.lang.String spaceName, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
WorkspacesManagerApi.makeSpacePrivate(String)
public com.xpn.xwiki.plugin.spacemanager.api.Space getSpaceForUser(java.lang.String userName, com.xpn.xwiki.XWikiContext context) throws com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
WorkspacesManagerApi.getSpaceForUser(String)
public int countMembers(java.lang.String spaceName, com.xpn.xwiki.XWikiContext context) throws com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
WorkspacesManagerApi.countMembers(String)
public java.util.Collection getMembers(java.lang.String spaceName, int howMany, int startAt, com.xpn.xwiki.XWikiContext context) throws com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
SpaceManagerPluginApi.getMembers(String)
public java.util.List getLastSpaces(int howMany, int startAt, com.xpn.xwiki.XWikiContext context) throws com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
WorkspacesManagerApi.getLastSpaces(int, int)
protected java.lang.String getWorkspaceSpaceClassName()
public com.xpn.xwiki.api.Api getPluginApi(com.xpn.xwiki.plugin.XWikiPluginInterface plugin, com.xpn.xwiki.XWikiContext context)
getPluginApi
in interface com.xpn.xwiki.plugin.XWikiPluginInterface
getPluginApi
in class com.xpn.xwiki.plugin.spacemanager.impl.SpaceManagerImpl
public com.xpn.xwiki.plugin.spacemanager.api.Space getRootSpace(java.lang.String web, com.xpn.xwiki.XWikiContext context) throws com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
public java.util.List searchDocuments(java.lang.String spaceName, java.lang.String applicationName, int howMany, int startAt, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
public java.lang.String getApplicationURL(java.lang.String spaceName, java.lang.String appName, java.lang.String docName, java.lang.String queryString, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
public java.lang.String getApplicationName(java.lang.String docFullname, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
public java.util.Collection getWebsForSpace(java.lang.String spaceName, com.xpn.xwiki.XWikiContext context) throws WorkspacesManagerException
WorkspacesManagerException
public java.util.Map getApplicationsForSpace(java.lang.String spaceName, com.xpn.xwiki.XWikiContext context) throws com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
protected com.xpn.xwiki.plugin.spacemanager.api.Space newSpace(java.lang.String spaceName, java.lang.String spaceTitle, boolean create, com.xpn.xwiki.XWikiContext context) throws com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
newSpace
in class com.xpn.xwiki.plugin.spacemanager.impl.SpaceManagerImpl
com.xpn.xwiki.plugin.spacemanager.api.SpaceManagerException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |