Class OpenStegoConfig


  • public class OpenStegoConfig
    extends java.lang.Object
    Class to store configuration data for OpenStego
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ENCRYPTION_ALGORITHM
      Key string for configuration item - encryptionAlgorithm
      static java.lang.String PASSWORD
      Key string for configuration item - password
      static java.lang.String USE_COMPRESSION
      Key string for configuration item - useCompression
      static java.lang.String USE_ENCRYPTION
      Key string for configuration item - useEncryption
    • Constructor Summary

      Constructors 
      Constructor Description
      OpenStegoConfig()
      Default Constructor (with default values for configuration items)
      OpenStegoConfig​(CmdLineOptions options)
      Constructor which reads configuration data from the command line options.
      OpenStegoConfig​(java.util.Map<java.lang.String,​java.lang.String> propMap)
      Constructor with map of configuration data.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addProperties​(java.util.Map<java.lang.String,​java.lang.String> propMap)
      Method to add properties from the map to this configuration data
      java.lang.String getEncryptionAlgorithm()
      Get Method for encryptionAlgorithm
      java.lang.String getPassword()
      Get Method for password
      boolean isUseCompression()
      Get method for configuration item - useCompression
      boolean isUseEncryption()
      Get Method for useEncryption
      void setEncryptionAlgorithm​(java.lang.String encryptionAlgorithm)
      Set Method for encryptionAlgorithm
      void setPassword​(java.lang.String password)
      Set Method for password
      void setUseCompression​(boolean useCompression)
      Set method for configuration item - useCompression
      void setUseEncryption​(boolean useEncryption)
      Set Method for useEncryption
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • USE_COMPRESSION

        public static final java.lang.String USE_COMPRESSION
        Key string for configuration item - useCompression

        Flag to indicate whether compression should be used or not

        See Also:
        Constant Field Values
      • USE_ENCRYPTION

        public static final java.lang.String USE_ENCRYPTION
        Key string for configuration item - useEncryption

        Flag to indicate whether encryption should be used or not

        See Also:
        Constant Field Values
      • PASSWORD

        public static final java.lang.String PASSWORD
        Key string for configuration item - password

        Password for encryption in case "useEncryption" is set to true

        See Also:
        Constant Field Values
      • ENCRYPTION_ALGORITHM

        public static final java.lang.String ENCRYPTION_ALGORITHM
        Key string for configuration item - encryptionAlgorithm

        Algorithm to be used for encryption

        See Also:
        Constant Field Values
    • Constructor Detail

      • OpenStegoConfig

        public OpenStegoConfig()
        Default Constructor (with default values for configuration items)
      • OpenStegoConfig

        public OpenStegoConfig​(java.util.Map<java.lang.String,​java.lang.String> propMap)
                        throws OpenStegoException
        Constructor with map of configuration data. Please make sure that only valid keys for configuration items are provided, and the values for those items are also valid.
        Parameters:
        propMap - Map containing the configuration data
        Throws:
        OpenStegoException
    • Method Detail

      • addProperties

        protected void addProperties​(java.util.Map<java.lang.String,​java.lang.String> propMap)
                              throws OpenStegoException
        Method to add properties from the map to this configuration data
        Parameters:
        propMap - Map containing the configuration data
        Throws:
        OpenStegoException
      • isUseCompression

        public boolean isUseCompression()
        Get method for configuration item - useCompression
        Returns:
        useCompression
      • setUseCompression

        public void setUseCompression​(boolean useCompression)
        Set method for configuration item - useCompression
        Parameters:
        useCompression -
      • isUseEncryption

        public boolean isUseEncryption()
        Get Method for useEncryption
        Returns:
        useEncryption
      • setUseEncryption

        public void setUseEncryption​(boolean useEncryption)
        Set Method for useEncryption
        Parameters:
        useEncryption -
      • getPassword

        public java.lang.String getPassword()
        Get Method for password
        Returns:
        password
      • setPassword

        public void setPassword​(java.lang.String password)
        Set Method for password
        Parameters:
        password -
      • getEncryptionAlgorithm

        public java.lang.String getEncryptionAlgorithm()
        Get Method for encryptionAlgorithm
        Returns:
        encryptionAlgorithm
      • setEncryptionAlgorithm

        public void setEncryptionAlgorithm​(java.lang.String encryptionAlgorithm)
        Set Method for encryptionAlgorithm
        Parameters:
        encryptionAlgorithm -