com.atlassian.confluence.rpc.soap.services
Class SpacesSoapService

java.lang.Object
  extended by com.atlassian.confluence.rpc.soap.services.SpacesSoapService

public class SpacesSoapService
extends Object

This is the soap service that handles all of the 'space' type methods.

Usually delegated from the ConfluenceSoapServiceImpl.


Constructor Summary
SpacesSoapService()
           
 
Method Summary
 boolean addAnonymousUsePermission()
           
 boolean addAnonymousViewUserProfilePermission()
           
 boolean addGlobalPermission(String permission, String remoteEntityName)
           
 boolean addGlobalPermissions(String[] permissions, String remoteEntityName)
           
 boolean addPermissionsToSpace(String[] permissions, String remoteEntityName, String spaceKey)
           
 boolean addPermissionToSpace(String permission, String remoteEntityName, String spaceKey)
          Add a given permission for a particular group/user to the given space.
 RemoteSpace addPersonalSpace(RemoteSpace space, String username)
           
 RemoteSpace addPersonalSpaceWithDefaultPermissions(RemoteSpace space, String username)
           
 RemoteSpace addSpace(RemoteSpace space)
           
 RemoteSpaceGroup addSpaceGroup(RemoteSpaceGroup spaceGroup)
           
 RemoteSpace addSpaceWithDefaultPermissions(RemoteSpace space)
           
 String exportSpace(String spaceKey, String exportType)
           
 String exportSpace(String spaceKey, String exportType, boolean exportAll)
           
 String[] getPermissions(String spaceKey)
          Returns permissions that the logged in user has on the space with the given key.
 String[] getPermissions(String spaceKey, String userName)
          Returns the permissions that the nominated user has on the space with the given key.
 RemoteSpace getSpace(String spaceKey)
           
 RemoteSpaceGroup getSpaceGroup(String spaceGroupKey)
           
 RemoteSpaceGroup[] getSpaceGroups()
           
 String[] getSpaceLevelPermissions()
          Get all fine grained Space Level Permissions so that they can be added remotely.
 RemoteSpacePermissionSet getSpacePermissionSet(String spaceKey, String type)
           
 RemoteSpacePermissionSet[] getSpacePermissionSets(String spaceKey)
           
 RemoteSpaceSummary[] getSpaces()
           
 RemoteSpaceSummary[] getSpacesInGroup(String groupKey)
           
 String getSpaceStatus(String spaceKey)
           
 boolean removeAnonymousUserPermission()
           
 boolean removeAnonymousViewUserProfilePermission()
           
 boolean removeGlobalPermission(String permission, String remoteEntityName)
          Removes a global permission from the user.
 boolean removePermissionFromSpace(String permission, String remoteEntityName, String spaceKey)
           
 Boolean removeSpace(String spaceKey)
           
 boolean removeSpaceGroup(String spaceGroupKey)
           
 void setAnonymousUserPermissionsService(AnonymousUserPermissionsService anonymousUserPermissionsService)
           
 void setGateKeeper(GateKeeper gateKeeper)
           
 void setImportExportManager(ImportExportManager importExportManager)
           
 void setPageManager(PageManager pageManager)
           
 void setPermissionManager(PermissionManager permissionManager)
           
 void setPersonalInformationManager(PersonalInformationManager personalInformationManager)
           
 void setSetSpacePermissionChecker(SetSpacePermissionChecker setSpacePermissionChecker)
           
 void setSettingsManager(SettingsManager settingsManager)
           
 void setSoapServiceHelper(SoapServiceHelper soapServiceHelper)
           
 void setSpaceGroupManager(SpaceGroupManager spaceGroupManager)
           
 void setSpaceManager(SpaceManager spaceManager)
           
 void setSpacePermissionManager(SpacePermissionManager spacePermissionManager)
           
 void setSpaceStatus(String spaceKey, String statusValue)
           
 void setUserAccessor(UserAccessor userAccessor)
           
 void setWikiStyleRenderer(com.atlassian.renderer.WikiStyleRenderer wikiStyleRenderer)
           
 RemoteSpace storeSpace(RemoteSpace remoteSpace)
           
protected  void verifyPersonalSpaceCreation(ConfluenceUser user)
          Deprecated. since 4.2.7 will be removed in a future release
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpacesSoapService

public SpacesSoapService()
Method Detail

setUserAccessor

public void setUserAccessor(UserAccessor userAccessor)

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

setPermissionManager

public void setPermissionManager(PermissionManager permissionManager)

setWikiStyleRenderer

public void setWikiStyleRenderer(com.atlassian.renderer.WikiStyleRenderer wikiStyleRenderer)

setSoapServiceHelper

public void setSoapServiceHelper(SoapServiceHelper soapServiceHelper)

setSpacePermissionManager

public void setSpacePermissionManager(SpacePermissionManager spacePermissionManager)

setPersonalInformationManager

public void setPersonalInformationManager(PersonalInformationManager personalInformationManager)

setPageManager

public void setPageManager(PageManager pageManager)

getSpaces

public RemoteSpaceSummary[] getSpaces()
                               throws RemoteException
Throws:
RemoteException

getSpacesInGroup

public RemoteSpaceSummary[] getSpacesInGroup(String groupKey)
                                      throws RemoteException
Throws:
RemoteException

getSpace

public RemoteSpace getSpace(String spaceKey)
                     throws RemoteException
Throws:
RemoteException

getPermissions

public String[] getPermissions(String spaceKey)
                        throws RemoteException
Returns permissions that the logged in user has on the space with the given key.

Throws:
RemoteException

getSpacePermissionSets

public RemoteSpacePermissionSet[] getSpacePermissionSets(String spaceKey)
                                                  throws RemoteException
Throws:
RemoteException

getSpacePermissionSet

public RemoteSpacePermissionSet getSpacePermissionSet(String spaceKey,
                                                      String type)
                                               throws RemoteException
Throws:
RemoteException

getPermissions

public String[] getPermissions(String spaceKey,
                               String userName)
                        throws RemoteException
Returns the permissions that the nominated user has on the space with the given key.

Throws:
RemoteException

addSpaceWithDefaultPermissions

public RemoteSpace addSpaceWithDefaultPermissions(RemoteSpace space)
                                           throws RemoteException
Throws:
RemoteException

addSpace

public RemoteSpace addSpace(RemoteSpace space)
                     throws RemoteException
Throws:
RemoteException

storeSpace

public RemoteSpace storeSpace(RemoteSpace remoteSpace)
                       throws RemoteException
Throws:
RemoteException

addSpaceGroup

public RemoteSpaceGroup addSpaceGroup(RemoteSpaceGroup spaceGroup)
                               throws RemoteException
Throws:
RemoteException

getSpaceGroup

public RemoteSpaceGroup getSpaceGroup(String spaceGroupKey)
                               throws RemoteException
Throws:
RemoteException

getSpaceGroups

public RemoteSpaceGroup[] getSpaceGroups()
                                  throws RemoteException
Throws:
RemoteException

removeSpaceGroup

public boolean removeSpaceGroup(String spaceGroupKey)
                         throws RemoteException
Throws:
RemoteException

verifyPersonalSpaceCreation

protected void verifyPersonalSpaceCreation(ConfluenceUser user)
                                    throws NotPermittedException,
                                           AlreadyExistsException
Deprecated. since 4.2.7 will be removed in a future release

Perform checking that a personal space for a user may be created

Parameters:
user - The owner of the personal space
Throws:
NotPermittedException - The current principal may not create a personal space for the user
AlreadyExistsException - A personal space already exists for the user

addPersonalSpaceWithDefaultPermissions

public RemoteSpace addPersonalSpaceWithDefaultPermissions(RemoteSpace space,
                                                          String username)
                                                   throws RemoteException
Throws:
RemoteException

addPersonalSpace

public RemoteSpace addPersonalSpace(RemoteSpace space,
                                    String username)
                             throws RemoteException
Throws:
RemoteException

getSpaceLevelPermissions

public String[] getSpaceLevelPermissions()
                                  throws RemoteException
Get all fine grained Space Level Permissions so that they can be added remotely. RETURNS a string array containing the following elements. VIEWSPACE_PERMISSION COMMENT_PERMISSION EDITSPACE SETSPACEPERMISSIONS REMOVEPAGE REMOVECOMMENT REMOVEBLOG CREATEATTACHMENT REMOVEATTACHMENT EDITBLOG EXPORTSPACE REMOVEMAIL

Throws:
RemoteException

addPermissionToSpace

public boolean addPermissionToSpace(String permission,
                                    String remoteEntityName,
                                    String spaceKey)
                             throws RemoteException
Add a given permission for a particular group/user to the given space. Assumption : Users and groups cannot have the same name.

Parameters:
permission - is the Permission that is to be added to the space
remoteEntityName - is either a group or a user name or null for anonymous permissions
spaceKey - is the key of the space for which the given permission is to be added to the given given group/user
Throws:
RemoteException - if space is null or authenticated user does not not have A ADMINISTRATE SPACE permission or if null entity is specified or if no valid entity i.e group/user exist with the given name

addGlobalPermissions

public boolean addGlobalPermissions(String[] permissions,
                                    String remoteEntityName)
                             throws RemoteException
Throws:
RemoteException

addGlobalPermission

public boolean addGlobalPermission(String permission,
                                   String remoteEntityName)
                            throws RemoteException
Throws:
RemoteException

addAnonymousUsePermission

public boolean addAnonymousUsePermission()
                                  throws RemoteException
Throws:
RemoteException

removeAnonymousUserPermission

public boolean removeAnonymousUserPermission()
                                      throws RemoteException
Throws:
RemoteException

addAnonymousViewUserProfilePermission

public boolean addAnonymousViewUserProfilePermission()
                                              throws RemoteException
Throws:
RemoteException

removeAnonymousViewUserProfilePermission

public boolean removeAnonymousViewUserProfilePermission()
                                                 throws RemoteException
Throws:
RemoteException

removeGlobalPermission

public boolean removeGlobalPermission(String permission,
                                      String remoteEntityName)
                               throws NotPermittedException,
                                      RemoteException
Removes a global permission from the user.

Throws:
NotPermittedException - if you are not permitted to remove this permission from the user with remoteEntityName
RemoteException

addPermissionsToSpace

public boolean addPermissionsToSpace(String[] permissions,
                                     String remoteEntityName,
                                     String spaceKey)
                              throws RemoteException,
                                     NotPermittedException
Parameters:
permissions -
remoteEntityName - is either a group or a user name or null for anonymous permissions
spaceKey -
Returns:
Throws:
RemoteException
NotPermittedException

removePermissionFromSpace

public boolean removePermissionFromSpace(String permission,
                                         String remoteEntityName,
                                         String spaceKey)
                                  throws NotPermittedException,
                                         RemoteException
Throws:
NotPermittedException
RemoteException

removeSpace

public Boolean removeSpace(String spaceKey)
                    throws RemoteException
Throws:
RemoteException

getSpaceStatus

public String getSpaceStatus(String spaceKey)
                      throws RemoteException
Throws:
RemoteException

setSpaceStatus

public void setSpaceStatus(String spaceKey,
                           String statusValue)
                    throws RemoteException
Throws:
RemoteException

exportSpace

public String exportSpace(String spaceKey,
                          String exportType)
                   throws RemoteException
Throws:
RemoteException

exportSpace

public String exportSpace(String spaceKey,
                          String exportType,
                          boolean exportAll)
                   throws RemoteException
Throws:
RemoteException

setImportExportManager

public void setImportExportManager(ImportExportManager importExportManager)

setGateKeeper

public void setGateKeeper(GateKeeper gateKeeper)

setSettingsManager

public void setSettingsManager(SettingsManager settingsManager)

setSpaceGroupManager

public void setSpaceGroupManager(SpaceGroupManager spaceGroupManager)

setSetSpacePermissionChecker

public void setSetSpacePermissionChecker(SetSpacePermissionChecker setSpacePermissionChecker)

setAnonymousUserPermissionsService

public void setAnonymousUserPermissionsService(AnonymousUserPermissionsService anonymousUserPermissionsService)


Copyright © 2003–2015 Atlassian. All rights reserved.