Package com.xwiki.admintools

Interface ServerInfo

  • @Unstable
@Role
public interface ServerInfo
    Exposes methods for accessing server specific information, like configurations, logs or other XWiki and server files.
    Since:
    1.1
    Version:
    $Id$

    • Method Detail

      • foundServerPath

        boolean foundServerPath()
        Verify if the path to a specific server is found. If a server path is provided in the XWiki configurations, it verifies if the path corresponds to a server. Otherwise, it searches the server location in system properties and system environment.
        Returns:
        true if the server is used, false otherwise.

      • getComponentHint

        String getComponentHint()
        Extract the hint of a component.
        Returns:
        component hint.

      • getServerCfgPath

        String getServerCfgPath()
        Access the path to the server configuration file.
        Returns:
        the path to the server configuration file.

      • getXwikiCfgFolderPath

        String getXwikiCfgFolderPath()
        Access the path to the XWiki configuration folder.
        Returns:
        the path to the XWiki configuration folder.

      • getXWikiInstallFolderPath

        String getXWikiInstallFolderPath()
        Access the path to the XWiki installation folder.
        Returns:
        the path to the XWiki installation folder.

      • updatePossiblePaths

        void updatePossiblePaths()
        Update the possible paths to the configuration files.

      • getServerPath

        String getServerPath()
        Get path to server.
        Returns:
        String with server path.

      • getLogsFolderPath

        String getLogsFolderPath()
        Get path to server logs folder.
        Returns:
        String with server logs folder path.

      • getLastLogFilePath

        String getLastLogFilePath()
        Get path to server last updated main log file.
        Returns:
        String path to server log file.

      • getLogsPattern

        Pattern getLogsPattern()
        Get server pattern for identifying log files date.
        Returns:
        Pattern representing the date format in server log files names.

      • getLogsHint

        String getLogsHint()
        Get server logs common identifier.
        Returns:
        a String with the server logs common identifier.