com.gemalto.idp.mobile.core.util

Interface SecureString

All Superinterfaces:

SecureByteArray, SecureContainer

public interface SecureString
extends SecureByteArray

Secure string interface. Builds on top of the secure byte array by adding string related utilities.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
SecureString	append(SecureString data) Append a secure string to this secure string object.
SecureString	clone() Creates a clone of this secure string object.
int	stringLength() Retrieves the length of the text stored in this secure string object.
String	toString() Returns a string representation of the data carried by this object.

Methods inherited from interface com.gemalto.idp.mobile.core.util.SecureByteArray

length, toByteArray

Methods inherited from interface com.gemalto.idp.mobile.core.util.SecureContainer

equals, hashCode, wipe

Method Detail

toString

String toString()

Returns a string representation of the data carried by this object. The data are internally still stored as a byte array. The conversion is done using the specified encoding which can optionally be passed the corresponding factory method (UTF8 is the default one).

WARNING:

This method creates an immutable string which can be a potential security issue. In Java, there is no simple way how to wipe this string from memory.

Overrides:

toString in class Object

Returns:

A string representation of the data carried by this object.

stringLength

int stringLength()

Retrieves the length of the text stored in this secure string object.

Returns:

The number of characters of the contained text.

append

SecureString append(SecureString data)

Append a secure string to this secure string object.

Attention:

The secure string objects created with the custom string encoding MUST NOT be concatenated.

Parameters:

data - The secure string to append to this secure string.

Returns:

The new secure string object containing the concatenation of the two secure strings.

clone

SecureString clone()

Creates a clone of this secure string object.

Specified by:

clone in interface SecureByteArray

Specified by:

clone in interface SecureContainer

Returns:

The clone of this secure string object whatever implementation it is.