com.gemalto.idp.mobile.core.util

Interface SecureContainerFactory

public interface SecureContainerFactory

Factory to create various SecureContainer object used by the SDK

Since:

4.0

Method Summary

Modifier and Type	Method and Description
SecureByteArray	createByteArray(byte[] arrayToStore, boolean wipeSource) Creates the secure byte array object.
SecureString	fromByteArray(byte[] arrayToStore, boolean wipeSource) Create a secure string objects from a byte array.
SecureString	fromString(String stringToStore) Create a secure string objects from a String.
SecureString	fromString(String stringToStore, String charsetName) Create a secure string objects from a String using a specific character set.

Method Detail

fromString

SecureString fromString(String stringToStore)

Create a secure string objects from a String.

Parameters:

stringToStore - The string to securely store. The string will be converted to UTF-8 when stored in the secure data object.

Returns:

A secure data object that securely stores the data.

Throws:

IdpRuntimeException - When failed to stringify data.

fromString

SecureString fromString(String stringToStore,
                        String charsetName)

Create a secure string objects from a String using a specific character set.

Warning: This method does not guarantee that the given string and the given character set are compatible.

Parameters:

stringToStore - The string to securely store.

charsetName - The string will be converted to this character when stored in the secure data object. It could be "UTF-8", "ISO-8859-15", "UTF-16", "US-ASCII", etc.

Returns:

A secure data object that securely stores the data.

Throws:

IdpRuntimeException - When failed to stringify data.

fromByteArray

SecureString fromByteArray(byte[] arrayToStore,
                           boolean wipeSource)

Create a secure string objects from a byte array.

Parameters:

arrayToStore - The byte array to securely store.

wipeSource - If true, then the byte[] will be erased if the method returns successfully. Otherwise the input will not be modified.

Returns:

A secure data object that securely stores the data.

createByteArray

SecureByteArray createByteArray(byte[] arrayToStore,
                                boolean wipeSource)

Creates the secure byte array object.

Parameters:

arrayToStore - The data to store to the output object.

wipeSource - Pass true to wipe the original data.

Returns:

The secure byte array object.