com.ibm.rules.engine.load

Interface XUEngineDynamicLoader

public interface XUEngineDynamicLoader

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	XUEngineDynamicLoader.CreationException
static class	XUEngineDynamicLoader.Output Instance of this class handles an output stream.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DSAR This mode is useful to load an EngineDefinition from a DSAR document.
static java.lang.String	DSAR_DEBUG This mode is useful to load an EngineDefinition in debug mode from a DSAR document.
static java.lang.String	JAR This mode is useful to load a standard jar file containing an EngineDefinition implementation.
static java.lang.String	JAR_DEBUG This mode is useful to load an EngineDefinition in debug mode from a JAR file.

Method Summary

Methods

Modifier and Type	Method and Description
EngineDefinition	createEngineDefinition(java.lang.String mode, java.io.InputStream inputStream, java.lang.ClassLoader XOMClassLoader, XUEngineDynamicLoader.Output output, java.util.Map<java.lang.String,java.lang.String> properties, EngineService... engineServices) Calls this method to load an EngineDefinition from a stream.

Field Detail

DSAR

static final java.lang.String DSAR

This mode is useful to load an EngineDefinition from a DSAR document.

See Also:

Constant Field Values

JAR

static final java.lang.String JAR

This mode is useful to load a standard jar file containing an EngineDefinition implementation.

See Also:

Constant Field Values

DSAR_DEBUG

static final java.lang.String DSAR_DEBUG

This mode is useful to load an EngineDefinition in debug mode from a DSAR document.

See Also:

Constant Field Values

JAR_DEBUG

static final java.lang.String JAR_DEBUG

This mode is useful to load an EngineDefinition in debug mode from a JAR file. The jar file should have been produced with DSAR_DEBUG mode before.

See Also:

Constant Field Values

Method Detail

createEngineDefinition

EngineDefinition createEngineDefinition(java.lang.String mode,
                                      java.io.InputStream inputStream,
                                      java.lang.ClassLoader XOMClassLoader,
                                      XUEngineDynamicLoader.Output output,
                                      java.util.Map<java.lang.String,java.lang.String> properties,
                                      EngineService... engineServices)
                                        throws XUEngineDynamicLoader.CreationException

Calls this method to load an EngineDefinition from a stream. The stream could be either a stream on a DSAR document or on a JAR.

In the first case : If the DSAR document contains a JAR file, this file is used and nothing else is done, on the other hands if the DSAR document doesn't contain a JAR file, this one is generated inside the output argument and a EngineDefinition is loaded from it.

In the second case : the JAR file is used to load and nothing else is done.

Throws:

XUEngineDynamicLoader.CreationException - in case of any kind of problem.

Parameters:

mode - is a string which is "com.ibm.rules.engine.de.dsar" or "com.ibm.rules.engine.de.jar", depending of the type of document provided by the inputStream argument. Couldn't be null.

inputStream - a stream on a DSAR document or a JAR document. Couldn't be null.

XOMClassLoader - a classloader on the XOM. Could be null.

output - an handle on a OutputStream instance. Shouldn't be null.

properties - unused. ( For future usage )

engineServices - see EngineService API.

Returns:

and EngineDefinition instance as described inside the provided document.