iaik.ixsil.init

Class IXSILInit

java.lang.Object

iaik.ixsil.init.IXSILInit

public class IXSILInit
extends java.lang.Object

Encapsulates all issues regarding the initialization of IXSIL.

• Specify the IXSIL init properties file, which contains the default values for the basic initialization of IXSIL.
  
• Change values of the IXSIL init properties.
  
• Change values of the IXSIL algorithm properties.
  
• Change values of the IXSIL keymanager properties.

The initialization properties are organized in three property files:

• The basic initialization properties are grouped in the IXSIL init properties file. The location of this file must be specified using the init(iaik.ixsil.util.URI) method of this class.
  
• One basic initialization property contains the location of the file containing the IXSIL algorithm properties. Each of these properties holds an association between an algorithm URI as specified by the XML Signature standard and the class file implementing this algorithm conforming with the IXSIL Algorithm interface.
  
• Another basic initialization property contains the location of the file containing the IXSIL keymanager properties. These properties manages the associations between the kinds of keying information provided by an XML signature, and the corresponding implementation classes for those keying information.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Properties	algorithmProperties_ Contains the IXSIL algorithm properties.
static java.io.PrintStream	debugLog_ The PrintStream where the debug log is written to.
protected static java.util.Properties	initProperties_ Contains the IXSIL init properties.
protected static URI	initPropertiesURI_ Contains the URI locating the IXSIL init properties file.
protected static java.util.Properties	keyManagerProperties_ Contains the IXSIL keymanager properties.
protected static boolean	printDebugLog_ An indicator whether debug log should be output or not.

Constructor Summary

Constructors

Constructor and Description
IXSILInit()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.Class	forName(java.lang.String className) This method is used internally by the Toolkit only to work around a problem specific to IBM Java 1.3, in which the method java.lang.Class.forName(String className) fails to return the requested class.
static java.lang.String	getAlgorithmProperty(java.lang.String name) Gets the IXSIL algorithm property with the specified name.
static java.io.PrintStream	getDebugLogPrintStream() Gets the Printstream IXSIL currently uses to write debug log to.
static URI	getInitPropertiesURI() Gets the URI locating the the IXSIL init properties file specified at the last invocation of the init(iaik.ixsil.util.URI) method.
static java.lang.String	getInitProperty(java.lang.String name) Gets the IXSIL init property with the specified name.
static java.lang.String	getKeyManagerProperty(java.lang.String name) Gets the IXSIL keymanager property with the specified name.
static boolean	getPrintDebugLog() Indicates whether IXSIL is currently configured to print debug log.
static void	init(java.util.Properties initProperties, java.util.Properties algorithmProperties, java.util.Properties keyManagerProperties) An alternative way for initializing the IXSIL API.
static void	init(URI initPropertiesLocation) Initializes IXSIL API with values provided by the specified IXSIL init properties file.
static void	setAlgorithmProperty(java.lang.String name, java.lang.String value) Sets the IXSIL algorithm property with the specified name.
static void	setDebugLogPrintStream(java.io.PrintStream debugLog) Sets the PrintStream where the debug information is written to.
static void	setInitProperty(java.lang.String name, java.lang.String value) Sets the IXSIL init property with the specified name.
static void	setKeyManagerProperty(java.lang.String name, java.lang.String value) Sets the IXSIL keymanager property with the specified name.
static void	setPrintDebugLog(boolean printDebugLog) Sets whether or not IXSIL should pring debug log.
protected static void	setProperty(java.util.Properties props, java.lang.String name, java.lang.String value) Sets value of the property in the specified property object with the specified name.

Methods inherited from class java.lang.Object

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

Field Detail

initProperties_

protected static java.util.Properties initProperties_

Contains the IXSIL init properties.

initPropertiesURI_

protected static URI initPropertiesURI_

Contains the URI locating the IXSIL init properties file.

algorithmProperties_

protected static java.util.Properties algorithmProperties_

Contains the IXSIL algorithm properties.

keyManagerProperties_

protected static java.util.Properties keyManagerProperties_

Contains the IXSIL keymanager properties.

debugLog_

public static java.io.PrintStream debugLog_

The PrintStream where the debug log is written to.

printDebugLog_

protected static boolean printDebugLog_

An indicator whether debug log should be output or not.

Constructor Detail

IXSILInit

public IXSILInit()

Method Detail

init

public static void init(URI initPropertiesLocation)
                 throws InitException

Initializes IXSIL API with values provided by the specified IXSIL init properties file.

Parameters:

initPropertiesLocation - An URI specifying the IXSIL init properties file. If a relative URI is specified, i. e. if there is no scheme part, then the properties file is searched in the class path.

Throws:

InitException - if the IXSIL init properties cannot be read.

init

public static void init(java.util.Properties initProperties,
        java.util.Properties algorithmProperties,
        java.util.Properties keyManagerProperties)
                 throws InitException

An alternative way for initializing the IXSIL API. init, algoritm and keyManager properties are passed to IXSIL as Properties objects. Please note: The property named location.initProperties must be set in the IXSIL init properties, if this method is used to initialize the library. See the inline documentation in the example IXSIL init properties file that is shipped with IXSIL for further information.

Parameters:

initProperties - The IXSIL init properties. Must not be null.

algorithmProperties - The IXSIL algorithms properties. Must not be null.

keyManagerProperties - The IXSIL keyManager properties. Must not be null.

Throws:

InitException - if initialization fails for any reason.

getInitPropertiesURI

public static URI getInitPropertiesURI()

Gets the URI locating the the IXSIL init properties file specified at the last invocation of the init(iaik.ixsil.util.URI) method.

Returns:

the URI locating the the IXSIL init properties file.

getAlgorithmProperty

public static java.lang.String getAlgorithmProperty(java.lang.String name)

Gets the IXSIL algorithm property with the specified name.

Parameters:

name - the name of the IXSIL algorithm property which value is requested.

Returns:

the value of the IXSIL algorithm property with the specified name, or null, if a property with the specified name does not exist.

setAlgorithmProperty

public static void setAlgorithmProperty(java.lang.String name,
                        java.lang.String value)

Sets the IXSIL algorithm property with the specified name.

Parameters:

name - The name of the IXSIL algorithm property, whose value should be set. If no property with this name exists currently, a new property will be added. Must not be null .

value - The value of the IXSIL algorithm property, which should be set. Must not be .

getKeyManagerProperty

public static java.lang.String getKeyManagerProperty(java.lang.String name)

Gets the IXSIL keymanager property with the specified name.

Parameters:

name - the name of the IXSIL keymanager property which value is requested.

Returns:

the value of the IXSIL keymanager property with the specified name, or null , if a property with the specified name does not exist.

setKeyManagerProperty

public static void setKeyManagerProperty(java.lang.String name,
                         java.lang.String value)

Sets the IXSIL keymanager property with the specified name.

Parameters:

name - The name of the IXSIL keymanager property, whose value should be set. If no property with this name exists currently, a new property will be added. Must not be null .

value - The value of the IXSIL keymanager property, which should be set. Must not be .

getInitProperty

public static java.lang.String getInitProperty(java.lang.String name)

Gets the IXSIL init property with the specified name.

Parameters:

name - the name of the IXSIL init property which value is requested.

Returns:

the value of the IXSIL init property with the specified name, or null, if a property with the specified name does not exist.

setInitProperty

public static void setInitProperty(java.lang.String name,
                   java.lang.String value)

Sets the IXSIL init property with the specified name.

Parameters:

name - The name of the IXSIL init property, whose value should be set. If no property with this name exists currently, a new property will be added. Must not be null .

value - The value of the IXSIL init property, which should be set. Must not be .

setProperty

protected static void setProperty(java.util.Properties props,
               java.lang.String name,
               java.lang.String value)

Sets value of the property in the specified property object with the specified name.

Parameters:

props - The property object.

name - The name of the property, whose value should be set.

value - The value of the property, which should be set.

getDebugLogPrintStream

public static java.io.PrintStream getDebugLogPrintStream()

Gets the Printstream IXSIL currently uses to write debug log to.

Returns:

the Printstream IXSIL currently uses to write debug log to.

setDebugLogPrintStream

public static void setDebugLogPrintStream(java.io.PrintStream debugLog)

Sets the PrintStream where the debug information is written to. The default value is System.err .

Parameters:

debugLog - The PrintStream where the debug information is written to.

See Also:

setPrintDebugLog(boolean)

getPrintDebugLog

public static boolean getPrintDebugLog()

Indicates whether IXSIL is currently configured to print debug log.

Returns:

whether IXSIL is currently configured to print debug log.

setPrintDebugLog

public static void setPrintDebugLog(boolean printDebugLog)

Sets whether or not IXSIL should pring debug log.

Parameters:

printDebugLog - Indicates whether or not IXSIL should pring debug log.

See Also:

setDebugLogPrintStream(java.io.PrintStream)

forName

public static java.lang.Class forName(java.lang.String className)
                               throws java.lang.ClassNotFoundException

This method is used internally by the Toolkit only to work around a problem specific to IBM Java 1.3, in which the method java.lang.Class.forName(String className) fails to return the requested class.

The Toolkit uses this method internally, and your application does not need to invoke it.

Throws:

java.lang.ClassNotFoundException - if the class cannot be located.