iaik.ixsil.util

Class Utils

java.lang.Object

iaik.ixsil.util.Utils

public class Utils
extends java.lang.Object

Contains some basic utility functions for use within IXISL.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DISABLE_XML_SECURE_PROCESSING

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	absolutizePath(java.lang.String basePath, java.lang.String candidatePath, char separatorChar) Absolutizes a specified candidate path using a specified base path and a specified separator character.
static byte[]	base64Decode(byte[] encodedData) Transforms the specified base64 encoded data into the corresponding plain data.
static byte[]	base64Encode(byte[] plainData) Transforms the specified plain data into base64 encoded data.
static java.lang.String	byteArrayToString(byte[] bytes) Produces a string representation of a given byte array.
static void	checkArgForCondition(java.lang.String argName, boolean condition) Throws an IXSILIllegalArgumentException if the specified condition is fulfilled.
static void	checkArgForNull(java.lang.Object arg, java.lang.String argName) Throws an IXSILIllegalArgumentException if the specified argument equals null .
static java.lang.String	name2XMLSignatureDNameString(Name name) Serializes a Name object into a DName string compliant with the rules of section 4.4.4 of XML-Signature Syntax and Processing.
static java.lang.String	normalizePathSeparator(java.lang.String candidatePath) Replaces all occurences of the platform dependent file separator (e.
static byte[]	readFromInputStream(java.io.InputStream inputStream) Reads from the specified InputStream until EOF is detected.
static char[]	readFromReader(java.io.Reader reader) Reads from the specified character stream until the end of the stream is detected.
static java.lang.String	searchReplace(java.lang.String candidateStr, java.lang.String searchStr, java.lang.String replaceStr) Replaces all occurences of a pattern string in a candidate string with the value of a replacement string.
static void	setSecureProcessing(javax.xml.parsers.DocumentBuilderFactory bFactory) Tries to set the secure Processing feature for the DocumentBuilderFactory using the JAXP 1.3 setFeature() API.
static void	setSecureProcessing(javax.xml.transform.TransformerFactory tFactory) Tries to set the secure Processing feature for the TransformFactory using the JAXP 1.3 setFeature() API.
static Name	xMLSignatureDNameString2Name(java.lang.String dNameString) Parses a DName string which is encoded according to the rules specfied in section 4.4.4 of XML-Signature Syntax and Processing.

Methods inherited from class java.lang.Object

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

Field Detail

DISABLE_XML_SECURE_PROCESSING

public static final java.lang.String DISABLE_XML_SECURE_PROCESSING

See Also:

Constant Field Values

Constructor Detail

Utils

public Utils()

Method Detail

base64Encode

public static byte[] base64Encode(byte[] plainData)
                           throws UtilsException

Transforms the specified plain data into base64 encoded data.

Parameters:

plainData - The data bytes to be encoded. Must not be null.

Returns:

The base64 encoded data bytes.

Throws:

UtilsException - if the transform fails for any reason.

xMLSignatureDNameString2Name

public static Name xMLSignatureDNameString2Name(java.lang.String dNameString)
                                         throws RFC2253NameParserException

Parses a DName string which is encoded according to the rules specfied in section 4.4.4 of XML-Signature Syntax and Processing.

Parameters:

dNameString - The DName string to be parsed.

Returns:

The Name object parsed from the DName string.

Throws:

RFC2253NameParserException - If parsing the DName string fails for any reasion.

name2XMLSignatureDNameString

public static java.lang.String name2XMLSignatureDNameString(Name name)

Serializes a Name object into a DName string compliant with the rules of section 4.4.4 of XML-Signature Syntax and Processing.

Parameters:

name - The Name object to be serialized.

Returns:

the serialized Name object.

base64Decode

public static byte[] base64Decode(byte[] encodedData)
                           throws UtilsException

Transforms the specified base64 encoded data into the corresponding plain data.

Parameters:

encodedData - The base64 encoded data bytes. Must not be null.

Returns:

The plain data bytes.

Throws:

UtilsException - if the transform fails for any reason.

readFromInputStream

public static byte[] readFromInputStream(java.io.InputStream inputStream)
                                  throws UtilsException

Reads from the specified InputStream until EOF is detected.

Parameters:

inputStream - The input byte stream to be read from. Must not be null.

Returns:

all bytes which have been read until EOF has been detected.

Throws:

UtilsException - if an IO error occurs while reading from the byte stream.

readFromReader

public static char[] readFromReader(java.io.Reader reader)
                             throws UtilsException

Reads from the specified character stream until the end of the stream is detected.

Parameters:

reader - The character stream to be read from. Must not be null.

Returns:

all characters which have been read until the end of stream has been detected.

Throws:

UtilsException - if reading form the stream fails for any reson.

searchReplace

public static java.lang.String searchReplace(java.lang.String candidateStr,
                             java.lang.String searchStr,
                             java.lang.String replaceStr)

Replaces all occurences of a pattern string in a candidate string with the value of a replacement string.

Parameters:

candidateStr - The candiate string. Must not be null.

searchStr - The pattern string. Must not be null.

replaceStr - The replacement string. Must not be null.

Returns:

the value of the candidate string with the replacements made as specified.

absolutizePath

public static java.lang.String absolutizePath(java.lang.String basePath,
                              java.lang.String candidatePath,
                              char separatorChar)
                                       throws UtilsException

Absolutizes a specified candidate path using a specified base path and a specified separator character. The specification how the candidate path is made absolute can be found in RFC 2396, section 5.2.

Parameters:

basePath - The base path used for making the candidate path absolute. Must not be null .

candidatePath - The candidate path to be made absolute. Must not be null.

separatorChar - The character employed for separating path segments.

Returns:

the absolutized candidate path.

Throws:

UtilsException - if the specified candidate path cannot be absolutized using the specified base path.

normalizePathSeparator

public static java.lang.String normalizePathSeparator(java.lang.String candidatePath)

Replaces all occurences of the platform dependent file separator (e. g. '\' on Windows platforms in a specified path with the character '/'.

Parameters:

candidatePath - The file path which separators are to be normalized. Must not be null .

Returns:

the normalize file path.

byteArrayToString

public static java.lang.String byteArrayToString(byte[] bytes)

Produces a string representation of a given byte array. Each byte is represented by its hex value; four ASCII characters are used for the representation; for instance the decimal value 15 will result in 0x0F. The values are separated by a single space. After 10 values a line break will be inserted.

Parameters:

bytes - The byte array to be transformed into a string. May be also null.

Returns:

a string value for the specifiey byte array.

checkArgForNull

public static void checkArgForNull(java.lang.Object arg,
                   java.lang.String argName)

Throws an IXSILIllegalArgumentException if the specified argument equals null .

Parameters:

arg - The candidate argument to test.

argName - The name of the argument to be shown in the exception message.

checkArgForCondition

public static void checkArgForCondition(java.lang.String argName,
                        boolean condition)

Throws an IXSILIllegalArgumentException if the specified condition is fulfilled.

Parameters:

argName - The name of the argument to be shown in the exception message.

condition - The condition to be fulfilled.

setSecureProcessing

public static void setSecureProcessing(javax.xml.transform.TransformerFactory tFactory)

Tries to set the secure Processing feature for the TransformFactory using the JAXP 1.3 setFeature() API. This code uses reflection because JAXP 1.3 API's are not available in the default JDK 1.4.2 configuration.

This method will throw a RuntimeException if there is a problem setting the secure processing feature and the System property iaik.ixsil.util.Utils.disableXMLSecureProcessing is set to true. By default this system property is set to false.

Parameters:

tFactory - The TransformerFactory which will set the Secure processing feature

Since:

7.2 patch

setSecureProcessing

public static void setSecureProcessing(javax.xml.parsers.DocumentBuilderFactory bFactory)

Tries to set the secure Processing feature for the DocumentBuilderFactory using the JAXP 1.3 setFeature() API. This code uses reflection because JAXP 1.3 API's are not available in the default JDK 1.4.2 configuration.

This method will throw a RuntimeException if there is a problem setting the secure processing feature and the System property iaik.ixsil.util.Utils.disableXMLSecureProcessing is set to true. By default this system property is set to false.

Parameters:

bFactory - the DocumentBuildeFactory which will set the secure processing feature

Throws:

UtilsException - if the feature cannot be set

DOMUtilsException

Since:

7.2 patch