org.ow2.chameleon.core

Class Chameleon

java.lang.Object

org.ow2.chameleon.core.Chameleon

public class Chameleon
extends Object

Chameleon main entry point.

Version:

$Id: 1.0.4 $Id

Author:

The OW2 Chameleon Team

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHAMELEON_BASEDIR A system property to set the chameleon location externally.

Constructor Summary

Constructors

Constructor and Description
Chameleon(boolean interactive) Creates a Chameleon instance.
Chameleon(boolean interactive, Map<String,Object> userProperties) Creates a Chameleon instance.
Chameleon(ChameleonConfiguration configuration) Creates a chameleon instance.
Chameleon(File basedir, boolean interactive, Map<String,Object> userProperties) Creates a chameleon instance.
Chameleon(String basedir, boolean interactive) Creates a Chameleon instance.

Method Summary

Modifier and Type	Method and Description
org.osgi.framework.BundleContext	context() Retrieves the bundle context of the underlying framework.
org.osgi.framework.launch.Framework	framework() Retrieves the underlying framework.
static org.slf4j.Logger	initializeLoggingSystem(ChameleonConfiguration configuration) Initialized the logging framework (backend).
void	start() Initializes and Starts the Chameleon frameworks.
void	stop() Stops the underlying framework.

Methods inherited from class java.lang.Object

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

Field Detail

CHAMELEON_BASEDIR

public static final String CHAMELEON_BASEDIR

A system property to set the chameleon location externally.

See Also:

Constant Field Values

Constructor Detail

Chameleon

public Chameleon(File basedir,
                 boolean interactive,
                 Map<String,Object> userProperties)
          throws IOException

Creates a chameleon instance.

Parameters:

basedir - the base directory

interactive - if the interactive mode enabled.

userProperties - the system properties provided by the user in command line

Throws:

IOException - if the chameleon instance cannot be created.

Chameleon

public Chameleon(ChameleonConfiguration configuration)
          throws IOException

Creates a chameleon instance.

Parameters:

configuration - the configuration to use

Throws:

IOException - if the chameleon instance cannot be created.

Chameleon

public Chameleon(boolean interactive)
          throws IOException

Creates a Chameleon instance. This constructor does not allows to set the core directory (so, uses 'core'), nor the chameleon properties.

Notice that if the 'chameleon.base' system property is set, it uses this location.

Parameters:

interactive - is the debug mode enabled.

Throws:

IOException - something wrong happens.

Chameleon

public Chameleon(String basedir,
                 boolean interactive)
          throws IOException

Creates a Chameleon instance. This constructor does not allows to set the core directory (so, uses 'core'), nor the chameleon properties.

Parameters:

basedir - the chameleon's base directory

interactive - is the debug mode enabled.

Throws:

IOException - something wrong happens.

Chameleon

public Chameleon(boolean interactive,
                 Map<String,Object> userProperties)
          throws IOException

Creates a Chameleon instance. This constructor does not allows to set the core directory (so, uses 'core'), nor the chameleon properties, but support user properties specified by the user using -Dxxx=yyy in the command line arguments.

Notice that if the 'chameleon.base' system property is set, it uses this location.

Parameters:

interactive - is the debug mode enabled.

userProperties - the user properties

Throws:

IOException - something wrong happens.

Method Detail

initializeLoggingSystem

public static org.slf4j.Logger initializeLoggingSystem(ChameleonConfiguration configuration)
                                                throws IOException

Initialized the logging framework (backend).

Parameters:

configuration - chameleon's configuration.

Returns:

the chameleon logger

Throws:

IOException - occurs when the logging cannot be configured

start

public void start()
           throws org.osgi.framework.BundleException

Initializes and Starts the Chameleon frameworks. It configure the embedded OSGi framework and deploys bundles

Throws:

org.osgi.framework.BundleException - if a bundle cannot be installed or started correctly.

stop

public void stop()
          throws org.osgi.framework.BundleException,
                 InterruptedException

Stops the underlying framework.

Throws:

org.osgi.framework.BundleException - should not happen.

InterruptedException - if the method is interrupted during the waiting time.

context

public org.osgi.framework.BundleContext context()

Retrieves the bundle context of the underlying framework. The framework must have been successfully started first.

Returns:

the bundle context

framework

public org.osgi.framework.launch.Framework framework()

Retrieves the underlying framework. The framework must have been successfully started first.

Returns:

the bundle context