Package com.atlassian.confluence.rpc.soap.services

Class AdminSoapService

java.lang.Object

com.atlassian.confluence.rpc.soap.services.AdminSoapService

public class AdminSoapService
extends Object

A Soap service holding functionality for Confluence Administrators.

Constructor Summary

Constructors

Constructor	Description
AdminSoapService()

Method Summary

Modifier and Type	Method	Description
boolean	clearIndexQueue()	Support remote interface for clearing out the index queue.
String	exportSite(boolean exportAttachments)	Performs a site export and return the download url.
boolean	flushIndexQueue()	Support remote interface for flushing the index queue.
RemoteClusterInformation	getClusterInformation()
RemoteNodeStatus[]	getClusterNodeStatuses()
RemoteServerInfo	getServerInfo()
boolean	importSpace(byte[] importData)
boolean	installPlugin(String pluginFileName, byte[] pluginData)
boolean	isDarkFeatureEnabled(String key)
boolean	isPluginEnabled(String pluginKey)
boolean	isPluginInstalled(String pluginKey)
String	performBackup(boolean exportAttachments)	Performs a backup, and return the file path on the server.
boolean	recoverIndex()
void	setAdminUiProperties(AdminUiProperties adminUiProperties)
void	setAnonymousUserPermissionsService(AnonymousUserPermissionsService anonymousUserPermissionsService)
void	setClusterManager(ClusterManager clusterManager)
boolean	setEnableAnonymousAccess(boolean value)
void	setGateKeeper(GateKeeper gateKeeper)
void	setHeartbeatManager(HeartbeatManager heartbeatManager)
void	setImportExportManager(ImportExportManager importExportManager)	Deprecated. since 7.17.0 because of ImportExportManager deprecation.
void	setIndexManager(IndexManager indexManager)
void	setIndexRecoveryService(IndexRecoveryService indexRecoveryService)
void	setPermissionManager(PermissionManager permissionManager)
void	setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)
void	setPluginController(com.atlassian.plugin.PluginController pluginController)
void	setSettingsManager(GlobalSettingsManager settingsManager)
void	setSoapServiceHelper(SoapServiceHelper soapServiceHelper)
void	setSpaceManager(SpaceManager spaceManager)
boolean	startActivity(String key, String username)	Adds a user as an active participant to the specified activity
boolean	stopActivity(String key, String username)	Removes a user as an active participant to the specified activity

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminSoapService

public AdminSoapService()

Method Detail

exportSite

public String exportSite(boolean exportAttachments)
                  throws RemoteException

Performs a site export and return the download url. This method respects permissions, and thus only a user with administrator privilages will be able to successfully invoke this method.

If manual backup zip download is not enabled (by setting ConfluenceAdminUiProperties.ALLOW_MANUAL_BACKUP_DOWNLOAD_KEY to true in confluence.cfg.xml), this method will throw an exception.

Parameters:

exportAttachments - if true, export attachments as well.

Returns:

the download url for the export

Throws:

RemoteException - if there are any errors performing the export (including authorization errors).

performBackup

public String performBackup(boolean exportAttachments)
                     throws RemoteException

Performs a backup, and return the file path on the server.

Parameters:

exportAttachments - set to true to export attachments

Returns:

a path to the export zip.

Throws:

RemoteException - if there are any errors performing the export (including authentication errors).

getServerInfo

public RemoteServerInfo getServerInfo()
                               throws RemoteException

Throws:

RemoteException

flushIndexQueue

public boolean flushIndexQueue()
                        throws RemoteException

Support remote interface for flushing the index queue.

Returns:

true if the flush actually occurred.

Throws:

RemoteException

clearIndexQueue

public boolean clearIndexQueue()
                        throws RemoteException

Support remote interface for clearing out the index queue.

Throws:

RemoteException

recoverIndex

public boolean recoverIndex()
                     throws RemoteException

Throws:

RemoteException

getClusterInformation

public RemoteClusterInformation getClusterInformation()

getClusterNodeStatuses

public RemoteNodeStatus[] getClusterNodeStatuses()
                                          throws RemoteException

Throws:

RemoteException

importSpace

public boolean importSpace(byte[] importData)
                    throws RemoteException

Throws:

RemoteException

isDarkFeatureEnabled

public boolean isDarkFeatureEnabled(String key)

startActivity

public boolean startActivity(String key,
                             String username)
                      throws RemoteException

Adds a user as an active participant to the specified activity

Parameters:

key - The key used to identify the activity

username - The username of the user who is participating in the activity

Throws:

RemoteException

stopActivity

public boolean stopActivity(String key,
                            String username)
                     throws RemoteException

Removes a user as an active participant to the specified activity

Parameters:

key - The key used to identify the activity

username - The username of the user who is no longer participating in the activity

Throws:

RemoteException

isPluginInstalled

public boolean isPluginInstalled(String pluginKey)
                          throws RemoteException

Throws:

RemoteException

isPluginEnabled

public boolean isPluginEnabled(String pluginKey)
                        throws RemoteException

Throws:

RemoteException

installPlugin

public boolean installPlugin(String pluginFileName,
                             byte[] pluginData)
                      throws RemoteException

Throws:

RemoteException

setEnableAnonymousAccess

public boolean setEnableAnonymousAccess(boolean value)
                                 throws RemoteException

Throws:

RemoteException

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

setImportExportManager

@Deprecated
public void setImportExportManager(ImportExportManager importExportManager)

Deprecated.

since 7.17.0 because of ImportExportManager deprecation.

setGateKeeper

public void setGateKeeper(GateKeeper gateKeeper)

setHeartbeatManager

public void setHeartbeatManager(HeartbeatManager heartbeatManager)

setSoapServiceHelper

public void setSoapServiceHelper(SoapServiceHelper soapServiceHelper)

setIndexManager

public void setIndexManager(IndexManager indexManager)

setClusterManager

public void setClusterManager(ClusterManager clusterManager)

setPermissionManager

public void setPermissionManager(PermissionManager permissionManager)

setIndexRecoveryService

public void setIndexRecoveryService(IndexRecoveryService indexRecoveryService)

setSettingsManager

public void setSettingsManager(GlobalSettingsManager settingsManager)

setPluginAccessor

public void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)

setPluginController

public void setPluginController(com.atlassian.plugin.PluginController pluginController)

setAnonymousUserPermissionsService

public void setAnonymousUserPermissionsService(AnonymousUserPermissionsService anonymousUserPermissionsService)

setAdminUiProperties

public void setAdminUiProperties(AdminUiProperties adminUiProperties)