public class

SoapServiceHelperImpl

extends Object
implements SoapServiceHelper
java.lang.Object
   ↳ com.atlassian.confluence.rpc.soap.services.SoapServiceHelperImpl

Summary

Fields
protected ContentEntityManager contentEntityManager
protected LinkManager linkManager
protected PageManager pageManager
protected PermissionManager permissionManager
protected SpaceManager spaceManager
protected UserAccessor userAccessor
Public Constructors
SoapServiceHelperImpl()
Public Methods
void assertCanAdminister()
void assertCanAdminister(Space space)
void assertCanCreateBlogPost(Space space)
void assertCanCreatePage(Space space)
void assertCanExport(Space space)
void assertCanModify(AbstractPage page)
void assertCanModifyObject(Object obj, String typeDescription)
Determines if the current user can modify/edit the given object If the current user is a super-user, they will automatically pass this test
void assertCanRemove(AbstractPage page)
Throw an exception if the user can't remove the given page.
void assertCanView(AbstractPage page)
void assertCanView(Space space)
AbstractPage retrieveAbstractPage(long abstractPageId)
Retrieves a given page, and throws RemoteException if the page is not found or the user has no view perm.
ContentEntityObject retrieveContent(long contentId)
Retrieves the content with the given ID, throwing an exception if the content can not be found, or the current user has not permission to view it.
Page retrievePage(String spaceKey, String pageTitle)
Retrieves a given page by space key and page title, and throws RemoteException if the page is not found or the user has no view perm.
Space retrieveSpace(String spaceKey)
Retrieves a given space, and throws RemoteException if the space is not found or the user has no view perm.
User retrieveUser(String username)
Retrieves the user with the given username
void setContentEntityManager(ContentEntityManager contentEntityManager)
void setLinkManager(LinkManager linkManager)
void setPageManager(PageManager pageManager)
void setPermissionManager(PermissionManager permissionManager)
void setSpaceManager(SpaceManager spaceManager)
void setUserAccessor(UserAccessor userAccessor)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.rpc.soap.services.SoapServiceHelper

Fields

protected ContentEntityManager contentEntityManager

protected LinkManager linkManager

protected PageManager pageManager

protected PermissionManager permissionManager

protected SpaceManager spaceManager

protected UserAccessor userAccessor

Public Constructors

public SoapServiceHelperImpl ()

Public Methods

public void assertCanAdminister ()

Throws
RemoteException

public void assertCanAdminister (Space space)

Throws
RemoteException

public void assertCanCreateBlogPost (Space space)

Throws
RemoteException

public void assertCanCreatePage (Space space)

Throws
RemoteException

public void assertCanExport (Space space)

Throws
RemoteException

public void assertCanModify (AbstractPage page)

Throws
RemoteException

public void assertCanModifyObject (Object obj, String typeDescription)

Determines if the current user can modify/edit the given object If the current user is a super-user, they will automatically pass this test

Parameters
obj the target object
typeDescription the type of object (e.g. "labels")
Throws
NotPermittedException

public void assertCanRemove (AbstractPage page)

Throw an exception if the user can't remove the given page.

Throws
RemoteException

public void assertCanView (AbstractPage page)

Throws
RemoteException

public void assertCanView (Space space)

Throws
RemoteException

public AbstractPage retrieveAbstractPage (long abstractPageId)

Retrieves a given page, and throws RemoteException if the page is not found or the user has no view perm.

Throws
RemoteException

public ContentEntityObject retrieveContent (long contentId)

Retrieves the content with the given ID, throwing an exception if the content can not be found, or the current user has not permission to view it.

Parameters
contentId the ID of the content to retrieve
Returns
  • the associated content object
Throws
RemoteException

public Page retrievePage (String spaceKey, String pageTitle)

Retrieves a given page by space key and page title, and throws RemoteException if the page is not found or the user has no view perm.

Throws
RemoteException

public Space retrieveSpace (String spaceKey)

Retrieves a given space, and throws RemoteException if the space is not found or the user has no view perm.

Throws
RemoteException

public User retrieveUser (String username)

Retrieves the user with the given username

Parameters
username the username of the user
Returns
  • The User instance corresponding to the user
Throws
RemoteException

public void setContentEntityManager (ContentEntityManager contentEntityManager)

public void setLinkManager (LinkManager linkManager)

public void setPageManager (PageManager pageManager)

public void setPermissionManager (PermissionManager permissionManager)

public void setSpaceManager (SpaceManager spaceManager)

public void setUserAccessor (UserAccessor userAccessor)