Package com.sun.identity.install.tools.util

Class FileUtils

  • public class FileUtils
extends Object

    • Constructor Detail

      • FileUtils

        public FileUtils()

    • Method Detail

      • copyFile

        public static boolean copyFile​(String source,
                               String destination)
                        throws Exception
        Copies a file
        Parameters:
        source - file
        destination - file
        Returns:
        true if copy operation succeed
        Throws:
        Exception

      • copyJarFile

        public static void copyJarFile​(String srcDir,
                               String destDir,
                               String filename)
                        throws Exception
        Method copyJarFile to destination directory
        Parameters:
        srcDir - the source directory containing the jar file
        destDir - the destination directory to copy the jar file to
        filename - the name of the jar file to copy
        Throws:
        Exception

      • copyDirContents

        public static void copyDirContents​(File srcDir,
                                   File destDir)
                            throws Exception
        Method copyDirContents
        Parameters:
        srcDir - the source directory whose contents are copied
        destDir - the destination directory to copy contents into
        Throws:
        Exception

      • removeDir

        public static boolean removeDir​(File dir)
        Method removeDir. All the files in the directory will be removed
        Parameters:
        dir - to be removed. @ return true if the directory is deleted. False other wise

      • removeJarFiles

        public static void removeJarFiles​(String srcDir,
                                  String fileName)
        Method removeJarFiles. jar files will be removed from source directory
        Parameters:
        srcDir - - Source directory
        fileName - - file to be deleted

      • removeFiles

        public static void removeFiles​(String srcDir,
                               String desDir)
        Method removeFiles. All the files existing in source directory will be removed from Destination Directory
        Parameters:
        srcDir - - Source directory to compare files
        desDir - - Destination directory to remove files

      • isFileValid

        public static boolean isFileValid​(String filename)

      • replaceBackWithForward

        public static String replaceBackWithForward​(String str)
        Method replaceBackWithForward
        Parameters:
        str - the string in which back slashes are replaced
        Returns:
        the string with all back slashes replaced by forward slashes

      • isDirValid

        public static boolean isDirValid​(String directory)

      • getLineByNumber

        public static String getLineByNumber​(String filePath,
                                     int lineNum)
        Method getLineByNumber
        Parameters:
        filePath - the path of the file to read
        lineNum - the 1-based line number to retrieve
        Returns:
        the contents of the specified line, or null if it cannot be read

      • matchPattern

        public static boolean matchPattern​(String line,
                                   String pattern,
                                   boolean matchBegin,
                                   boolean matchEnd,
                                   boolean ignoreCase)
        Method matchPattern
        Parameters:
        line - the line of text to test
        pattern - the pattern to match within the line
        matchBegin - whether the pattern must match at the beginning of the line
        matchEnd - whether the pattern must match at the end of the line
        ignoreCase - whether the match should be case-insensitive
        Returns:
        true if the line matches the pattern according to the given options

      • getLineWithPattern

        public static String getLineWithPattern​(String filePath,
                                        String pattern,
                                        boolean matchBegin,
                                        boolean matchEnd,
                                        boolean ignoreCase,
                                        int beginAtLine)
        Method getLineWithPattern
        Parameters:
        filePath - the path of the file to search
        pattern - the pattern to search for
        matchBegin - whether the pattern must match at the beginning of a line
        matchEnd - whether the pattern must match at the end of a line
        ignoreCase - whether the match should be case-insensitive
        beginAtLine - the line number at which to start searching
        Returns:
        the first line that matches the pattern, or null if none is found

      • getFirstOccurence

        public static int getFirstOccurence​(String filePath,
                                    String pattern,
                                    boolean matchBegin,
                                    boolean matchEnd,
                                    boolean ignoreCase,
                                    int beginAtLine)
        Method getFirstOccurence
        Parameters:
        filePath - the path of the file to search
        pattern - the pattern to search for
        matchBegin - whether the pattern must match at the beginning of a line
        matchEnd - whether the pattern must match at the end of a line
        ignoreCase - whether the match should be case-insensitive
        beginAtLine - the line number at which to start searching
        Returns:
        the line number of the first match, or -1 if none is found

      • getFirstOccurence

        public static int getFirstOccurence​(String filePath,
                                    String pattern,
                                    boolean matchBegin,
                                    boolean matchEnd,
                                    boolean ignoreCase)
        Method getFirstOccurence
        Parameters:
        filePath - the path of the file to search
        pattern - the pattern to search for
        matchBegin - whether the pattern must match at the beginning of a line
        matchEnd - whether the pattern must match at the end of a line
        ignoreCase - whether the match should be case-insensitive
        Returns:
        the line number of the first match, or -1 if none is found

      • getLastOccurence

        public static int getLastOccurence​(String filePath,
                                   String pattern,
                                   boolean matchBegin,
                                   boolean matchEnd,
                                   boolean ignoreCase)
        Method getLastOccurence
        Parameters:
        filePath - the path of the file to search
        pattern - the pattern to search for
        matchBegin - whether the pattern must match at the beginning of a line
        matchEnd - whether the pattern must match at the end of a line
        ignoreCase - whether the match should be case-insensitive
        Returns:
        the line number of the last match, or -1 if none is found

      • addMapProperty

        public static boolean addMapProperty​(String configPath,
                                     String key,
                                     String name,
                                     String value)
        Method addMapProperty Adds a map property like key[name]=value in PRODUCT Config.properties
        Parameters:
        key - key name of the property
        name - name of the property
        value - value of the property

      • addListProperty

        public static boolean addListProperty​(String fileName,
                                      String property,
                                      String value)
        Adds an entry to a list property in Product Config properties
        Parameters:
        fileName - name of the config file
        property - property name of the property for the list
        value - name of the list property to be added Ex: Adds a property like property[index] = value in Product Config properties
        Returns:
        boolean true or false

      • getTotalLineNums

        public static int getTotalLineNums​(String fileName)
        Method declaration
        Parameters:
        fileName - the path of the file whose lines are counted
        Returns:
        the total number of lines in the file

      • insertLineByNumber

        public static boolean insertLineByNumber​(String filePath,
                                         int lineNum,
                                         String line)
        Method insertLineByNumber
        Parameters:
        filePath - the path of the file to modify
        lineNum - the 1-based line number at which to insert
        line - the line of text to insert
        Returns:
        true if the line was inserted successfully

      • removeLinesByNum

        public static boolean removeLinesByNum​(String filePath,
                                       int lineNum,
                                       int numLines)
        Method removeLinesByNum
        Parameters:
        filePath - the path of the file to modify
        lineNum - begining line number
        numLines - total number of lines to remove
        Returns:
        true if removal is successful

      • removeLinesByNumber

        public static String removeLinesByNumber​(String filePath,
                                         int lineNum,
                                         int numLines)
        Method removeLinesByNumber
        Parameters:
        filePath - the path of the file to modify
        lineNum - the beginning line number (1-based)
        numLines - the number of lines to remove
        Returns:
        the last removed line, or null if the removal failed

      • appendLinesToFile

        public static boolean appendLinesToFile​(String filePath,
                                        String[] linesToAppend)
        Appends the given set of lines to the specified file.
        Parameters:
        filePath - the path of the file to append to
        linesToAppend - the lines to append to the file
        Returns:
        true for success, false otherwise

      • appendLinesToFile

        public static boolean appendLinesToFile​(String filePath,
                                        String[] linesToAppend,
                                        boolean create)
        Appends the given set of lines to the specified file.
        Parameters:
        filePath - the path of the file to append to
        linesToAppend - the lines to append to the file
        create - should the file be created if it does not exist
        Returns:
        true for success, false otherwise

      • getProperties

        public static Properties getProperties​(String configPath)
        Method getProperties Loads a properties file into memory and creates a java.util.Properties object
        Parameters:
        configPath - path to the properties file
        Returns:
        prop a java.util.Properties object from the specified file or null in case of an error in processing

      • getParentDirPath

        public static String getParentDirPath​(String path,
                                      int level)
        Returns the parent folder upper level count to the current path
        Parameters:
        path - path to a file/folder
        level - how much should we go upper in the path
        Returns:
        path to the parent upper the given level, for example: (/a/b/c/d, 3) will result in /a

      • getParentDirPath

        public static String getParentDirPath​(String path)
        Returns the parent folder of the given file/folder
        Parameters:
        path - path to a file/folder
        Returns:
        path to the parent, it may be null, if there is no parent.