com.tplan.robot.util

Class SafeBox

java.lang.Object

com.tplan.robot.util.SafeBox

public class SafeBox
extends Object

Safe box (vault) to store sensitive data in encrypted form.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener l)
void	changePassword(String oldPass, String newPass)
void	checkPassword()
void	checkPassword(String password)
static boolean	exists()
Document	getDocument(String name)
List<String>	getDocumentNames()
static File	getFile() Get the safe box file.
static SafeBox	getInstance()
static SafeBox	getInstance(File f) Load the safe box from the specified file.
String	getParameter(String name)
List<String>	getParameterNames()
static boolean	hasVariable(String variableName)
boolean	isEmpty()
boolean	isLocked()
boolean	isPasswordSet()
void	lock()
void	purge()
void	removeChangeListener(ChangeListener l)
boolean	removeDocument(String name)
boolean	removeParameter(String name)
void	save()
void	saveTo(File file) Save the safe box to a custom file.
void	setDocument(String name, Document document)
void	setParameter(String name, String value)
void	setPassword(String aPassword) Set the safebox password.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static SafeBox getInstance()
                           throws IOException

Throws:

IOException

getInstance

public static SafeBox getInstance(File f)
                           throws IOException

Load the safe box from the specified file.

Parameters:

f - an XML file containing safe box data.

Returns:

the safe box instance.

Throws:

IOException - on an I/O error.

Since:

7.0

setPassword

public void setPassword(String aPassword)

Set the safebox password.

Parameters:

aPassword - the password to set.

addChangeListener

public void addChangeListener(ChangeListener l)

removeChangeListener

public void removeChangeListener(ChangeListener l)

isPasswordSet

public boolean isPasswordSet()

exists

public static boolean exists()

hasVariable

public static boolean hasVariable(String variableName)

isEmpty

public boolean isEmpty()

purge

public void purge()

lock

public void lock()

checkPassword

public void checkPassword(String password)
                   throws IllegalArgumentException

Throws:

IllegalArgumentException

isLocked

public boolean isLocked()

checkPassword

public void checkPassword()
                   throws IllegalArgumentException

Throws:

IllegalArgumentException

setParameter

public void setParameter(String name,
                         String value)
                  throws IllegalStateException

Throws:

IllegalStateException

getParameter

public String getParameter(String name)
                    throws IllegalStateException

Throws:

IllegalStateException

getParameterNames

public List<String> getParameterNames()

removeParameter

public boolean removeParameter(String name)

setDocument

public void setDocument(String name,
                        Document document)

getDocument

public Document getDocument(String name)

getDocumentNames

public List<String> getDocumentNames()

removeDocument

public boolean removeDocument(String name)

save

public void save()
          throws IOException,
                 ParserConfigurationException,
                 GeneralSecurityException

Throws:

IOException

ParserConfigurationException

GeneralSecurityException

saveTo

public void saveTo(File file)
            throws ParserConfigurationException,
                   GeneralSecurityException,
                   IOException

Save the safe box to a custom file. The box must be unlocked.

Parameters:

file - a file to save the safe box to.

Throws:

ParserConfigurationException - on an XML streaming error.

GeneralSecurityException - on a security error.

IOException - on an I/O error when writing to the target file.

Since:

7.0

changePassword

public void changePassword(String oldPass,
                           String newPass)
                    throws IllegalArgumentException,
                           GeneralSecurityException,
                           IOException

Throws:

IllegalArgumentException

GeneralSecurityException

IOException

getFile

public static File getFile()

Get the safe box file.

Returns:

the safe box file.

Since:

7.0