com.jp.protection.pub
Class FileSecretStorage.Provider

java.lang.Object
  extended by com.jp.protection.pub.FileSecretStorage.Provider
All Implemented Interfaces:
SecretStorage.Provider, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
JarFileSecretStorage.Provider
Enclosing class:
FileSecretStorage

public static class FileSecretStorage.Provider
extends java.lang.Object
implements SecretStorage.Provider

See Also:
Serialized Form

Field Summary
protected  java.lang.String fFileName
           
protected  java.lang.String fFolder
           
protected  boolean fUseLockFile
           
protected  boolean fUserHomeRelative
           
protected  boolean fUseStrongEncryption
           
static long serialVersionUID
           
static java.lang.String TYPE
           
 
Constructor Summary
FileSecretStorage.Provider()
          Creates a new instance of Provider
FileSecretStorage.Provider(java.lang.String aFolder, java.lang.String aFileName)
          Creates a new instance of Provider and initializes it
FileSecretStorage.Provider(java.lang.String aFolder, java.lang.String aFileName, boolean aUserHomeRelative)
          Creates a new instance of Provider and initializes it
FileSecretStorage.Provider(java.lang.String aFolder, java.lang.String aFileName, boolean aUserHomeRelative, boolean aUseStrongEncryption)
          Creates a new instance of Provider and initializes it
FileSecretStorage.Provider(java.lang.String aFolder, java.lang.String aFileName, boolean aUserHomeRelative, boolean aUseStrongEncryption, boolean aUseLockFile)
          Creates a new instance of Provider and initializes it
 
Method Summary
 java.lang.Object clone()
           
 SecretStorage create()
          Creates a new instance of FileSecretStorage and initializes it using properties of Provider
 boolean equals(java.lang.Object obj)
           
 java.lang.String getFileName()
          Returns the name of the storage file
 java.lang.String getFolder()
          Returns the folder of the storage file
 java.lang.String getInstantiationStr()
           
 java.lang.String getType()
           
 boolean isUseLockFile()
           
 boolean isUserHomeRelative()
          Checks whether folder to find storage file is relative to the user home.
 boolean isUseStrongEncryption()
           
 void setFileName(java.lang.String aFileName)
          Specifies the name of the storage file
 void setFolder(java.lang.String aFolder)
          Specifies the folder of the storage file
 void setUseLockFile(boolean useLockFile)
           
 void setUserHomeRelative(boolean aUserHomeRelative)
          Specifies that folder to find storage file is relative to the user home.
 void setUseStrongEncryption(boolean aUseStrongEncryption)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values

fFileName

protected java.lang.String fFileName

fFolder

protected java.lang.String fFolder

fUserHomeRelative

protected boolean fUserHomeRelative

fUseLockFile

protected boolean fUseLockFile

fUseStrongEncryption

protected boolean fUseStrongEncryption

TYPE

public static final java.lang.String TYPE
See Also:
Constant Field Values
Constructor Detail

FileSecretStorage.Provider

public FileSecretStorage.Provider()
Creates a new instance of Provider


FileSecretStorage.Provider

public FileSecretStorage.Provider(java.lang.String aFolder,
                                  java.lang.String aFileName)
Creates a new instance of Provider and initializes it

Parameters:
aFolder - folder to locate secret storage file
aFileName - a name of secret storage file

FileSecretStorage.Provider

public FileSecretStorage.Provider(java.lang.String aFolder,
                                  java.lang.String aFileName,
                                  boolean aUserHomeRelative)
Creates a new instance of Provider and initializes it

Parameters:
aFolder - folder to locate secret storage file
aFileName - a name of secret storage file
aUserHomeRelative - specifies whether a folder is user HOME folder relative

FileSecretStorage.Provider

public FileSecretStorage.Provider(java.lang.String aFolder,
                                  java.lang.String aFileName,
                                  boolean aUserHomeRelative,
                                  boolean aUseStrongEncryption)
Creates a new instance of Provider and initializes it

Parameters:
aFolder - folder to locate secret storage file
aFileName - a name of secret storage file
aUserHomeRelative - specifies whether a folder is user HOME folder relative
aUseStrongEncryption - specifies whether strong encryption should be used

FileSecretStorage.Provider

public FileSecretStorage.Provider(java.lang.String aFolder,
                                  java.lang.String aFileName,
                                  boolean aUserHomeRelative,
                                  boolean aUseStrongEncryption,
                                  boolean aUseLockFile)
Creates a new instance of Provider and initializes it

Parameters:
aFolder - folder to locate secret storage file
aFileName - a name of secret storage file
aUserHomeRelative - specifies whether a folder is user HOME folder relative
aUseStrongEncryption - specifies whether strong encryption should be used
aUseLockFile - specifies whether lock file (.lck) should be used to prevent concurrent modifications of the Secret Storage
Method Detail

getInstantiationStr

public java.lang.String getInstantiationStr()
Specified by:
getInstantiationStr in interface SecretStorage.Provider

create

public SecretStorage create()
Creates a new instance of FileSecretStorage and initializes it using properties of Provider

Specified by:
create in interface SecretStorage.Provider
Returns:
a new instance of FileSecretStorage

isUserHomeRelative

public boolean isUserHomeRelative()
Checks whether folder to find storage file is relative to the user home.

Returns:
true if folder to find storage file is relative to the user home; false otherwise.

setUserHomeRelative

public void setUserHomeRelative(boolean aUserHomeRelative)
Specifies that folder to find storage file is relative to the user home.

Parameters:
aUserHomeRelative - true if folder to find storage file is relative to the user home; false otherwise.

getFileName

public java.lang.String getFileName()
Returns the name of the storage file

Returns:
the name of the storage file

setFileName

public void setFileName(java.lang.String aFileName)
Specifies the name of the storage file

Parameters:
aFileName - a name of the storage file to assign

getFolder

public java.lang.String getFolder()
Returns the folder of the storage file

Returns:
the folder of the storage file

setFolder

public void setFolder(java.lang.String aFolder)
Specifies the folder of the storage file

Parameters:
aFolder - a folder of the storage file to assign

clone

public java.lang.Object clone()
Specified by:
clone in interface SecretStorage.Provider
Overrides:
clone in class java.lang.Object

isUseStrongEncryption

public boolean isUseStrongEncryption()

setUseStrongEncryption

public void setUseStrongEncryption(boolean aUseStrongEncryption)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getType

public java.lang.String getType()
Specified by:
getType in interface SecretStorage.Provider

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

isUseLockFile

public boolean isUseLockFile()

setUseLockFile

public void setUseLockFile(boolean useLockFile)