Package com.xwiki.confluencepro

Interface ConfluenceMigrationPrerequisites

  • @Role
public interface ConfluenceMigrationPrerequisites
    Since:
    1.0
    Version:
    $Id$

    • Method Detail

      • checkMemory

        String checkMemory()
        Check if the maximum memory and the initial memory are at least half of the machine memory.
        Returns:
        the status of the memory check

      • checkCache

        String checkCache()
        Check the value of the xwiki.store.cache.capacity property from xwiki.cfg.
        Returns:
        the status of the cache check

      • checkWikiNotifications

        String checkWikiNotifications()
        Check the notifications.enabled and notifications.emails.enabled values from xwiki.properties.
        Returns:
        the status of the notifications check

      • checkCurrentUserNotification

        String checkCurrentUserNotification()
        Check the notification preferences in the current user's profile.
        Returns:
        the status of the current user's notification preferences check

      • checkListener

        String checkListener​(String listenerClassName,
                     boolean isMandatory)
        Check if a given listener is enabled or not.
        Parameters:
        listenerClassName - the class name of the listener
        isMandatory - the flag to know the need (mandatory or optional)
        Returns:
        the status of the listener state check

      • getMemory

        long getMemory()
        Get the machine memory.
        Returns:
        the formatted machine memory size

      • getXms

        long getXms()
        Get the initial memory allocation pool.
        Returns:
        the formatted initial memory size

      • getXmx

        long getXmx()
        Get the maximum memory allocation pool.
        Returns:
        formatted maximum memory size

      • getCache

        int getCache()
        Get the xwiki.store.cache.capacity value from xwiki.cfg.
        Returns:
        the formatted cache size

      • readableSize

        String readableSize​(long size)
        Get the memory and cache values in a readable form.
        Parameters:
        size - the value to be formatted
        Returns:
        the formatted value

      • checkCurrentUserNotificationCleanup

        String checkCurrentUserNotificationCleanup()
        Check if the current user's notifications are cleaned.
        Returns:
        the status of the clean check