Class AdminSoapService


  • public class AdminSoapService
    extends Object
    A Soap service holding functionality for Confluence Administrators.
    • 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).
      • flushIndexQueue

        public boolean flushIndexQueue()
                                throws RemoteException
        Support remote interface for flushing the index queue.
        Returns:
        true if the flush actually occurred.
        Throws:
        RemoteException
      • refreshIndex

        public boolean refreshIndex()
      • clearIndexQueue

        public boolean clearIndexQueue()
                                throws RemoteException
        Support remote interface for clearing out the index queue.
        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
      • setSpaceManager

        public void setSpaceManager​(SpaceManager spaceManager)
      • 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)
      • setPluginAccessor

        public void setPluginAccessor​(com.atlassian.plugin.PluginAccessor pluginAccessor)
      • setPluginController

        public void setPluginController​(com.atlassian.plugin.PluginController pluginController)
      • setAdminUiProperties

        public void setAdminUiProperties​(AdminUiProperties adminUiProperties)