org.eclipse.gemini.blueprint.extender.support.internal

Class ConfigUtils

java.lang.Object

org.eclipse.gemini.blueprint.extender.support.internal.ConfigUtils

public abstract class ConfigUtils
extends java.lang.Object

Utility class for dealing with the extender configuration and OSGi bundle manifest headers. Defines Spring/OSGi constants and methods for configuring Spring application context.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	COMMA
static java.lang.String	CONFIG_WILDCARD
static java.lang.String	CONTEXT_LOCATION_SEPARATOR
static java.lang.String	DIRECTIVE_CREATE_ASYNCHRONOUSLY Create asynchronously directive.
static boolean	DIRECTIVE_CREATE_ASYNCHRONOUSLY_DEFAULT
static long	DIRECTIVE_NO_TIMEOUT
static java.lang.String	DIRECTIVE_PUBLISH_CONTEXT Directive for publishing Spring application context as a service.
static boolean	DIRECTIVE_PUBLISH_CONTEXT_DEFAULT
static java.lang.String	DIRECTIVE_SEPARATOR Token used for separating directives inside a header.
static java.lang.String	DIRECTIVE_TIMEOUT Directive for indicating wait-for time when satisfying mandatory dependencies defined in seconds
static long	DIRECTIVE_TIMEOUT_DEFAULT
static java.lang.String	DIRECTIVE_TIMEOUT_VALUE_NONE
static java.lang.String	DIRECTIVE_WAIT_FOR_DEPS Wait for dependencies or directly start the context.
static boolean	DIRECTIVE_WAIT_FOR_DEPS_DEFAULT DIRECTIVE_WAIT_FOR_DEPS default.
static java.lang.String	EQUALS
static java.lang.String	EXTENDER_VERSION
private static java.lang.String	LEFT_CLOSED_INTERVAL
private static java.lang.String	LEFT_OPEN_INTERVAL
private static org.apache.commons.logging.Log	log
private static java.lang.String	RIGHT_CLOSED_INTERVAL
private static java.lang.String	RIGHT_OPEN_INTERVAL
static java.lang.String	SPRING_CONTEXT_HEADER Manifest entry name for configuring Spring application context.

Constructor Summary

Constructors

Constructor and Description
ConfigUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	getCreateAsync(java.util.Dictionary headers) Shortcut for finding the boolean value for DIRECTIVE_CREATE_ASYNCHRONOUSLY directive using the given headers.
private static java.lang.String	getDirectiveValue(java.util.Dictionary headers, java.lang.String directiveName) Shortcut method to retrieve directive values.
static java.lang.String	getDirectiveValue(java.lang.String header, java.lang.String directive) Return the directive value as a String.
static java.lang.String[]	getHeaderLocations(java.util.Dictionary headers) Returns the location headers (if any) specified by the Spring-Context header (if available).
static java.lang.String[]	getLocationsFromHeader(java.lang.String header, java.lang.String defaultValue) Similar to getHeaderLocations(Dictionary) but looks at a specified header directly.
static boolean	getPublishContext(java.util.Dictionary headers) Shortcut for finding the boolean value for DIRECTIVE_PUBLISH_CONTEXT directive using the given headers.
static java.lang.String	getSpringContextHeader(java.util.Dictionary headers) Return the "Spring-Context" if present from the given dictionary.
static long	getTimeOut(java.util.Dictionary headers) Shortcut for finding the boolean value for DIRECTIVE_TIMEOUT directive using the given headers.
static boolean	getWaitForDependencies(java.util.Dictionary headers) Shortcut for finding the boolean value for DIRECTIVE_WAIT_FOR_DEPS directive using the given headers.
static boolean	isDirectiveDefined(java.util.Dictionary headers, java.lang.String directiveName) Returns true if the given directive is present or false otherwise.
static boolean	matchExtenderVersionRange(org.osgi.framework.Bundle bundle, java.lang.String header, org.osgi.framework.Version versionToMatch)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.apache.commons.logging.Log log

EXTENDER_VERSION

public static final java.lang.String EXTENDER_VERSION

See Also:

Constant Field Values

LEFT_CLOSED_INTERVAL

private static final java.lang.String LEFT_CLOSED_INTERVAL

See Also:

Constant Field Values

LEFT_OPEN_INTERVAL

private static final java.lang.String LEFT_OPEN_INTERVAL

See Also:

Constant Field Values

RIGHT_CLOSED_INTERVAL

private static final java.lang.String RIGHT_CLOSED_INTERVAL

See Also:

Constant Field Values

RIGHT_OPEN_INTERVAL

private static final java.lang.String RIGHT_OPEN_INTERVAL

See Also:

Constant Field Values

COMMA

private static final java.lang.String COMMA

See Also:

Constant Field Values

CONFIG_WILDCARD

public static final java.lang.String CONFIG_WILDCARD

See Also:

Constant Field Values

SPRING_CONTEXT_HEADER

public static final java.lang.String SPRING_CONTEXT_HEADER

Manifest entry name for configuring Spring application context.

See Also:

Constant Field Values

DIRECTIVE_PUBLISH_CONTEXT

public static final java.lang.String DIRECTIVE_PUBLISH_CONTEXT

Directive for publishing Spring application context as a service.

See Also:

Constant Field Values

DIRECTIVE_TIMEOUT

public static final java.lang.String DIRECTIVE_TIMEOUT

Directive for indicating wait-for time when satisfying mandatory dependencies defined in seconds

See Also:

Constant Field Values

DIRECTIVE_TIMEOUT_VALUE_NONE

public static final java.lang.String DIRECTIVE_TIMEOUT_VALUE_NONE

See Also:

Constant Field Values

DIRECTIVE_CREATE_ASYNCHRONOUSLY

public static final java.lang.String DIRECTIVE_CREATE_ASYNCHRONOUSLY

Create asynchronously directive.

See Also:

Constant Field Values

DIRECTIVE_WAIT_FOR_DEPS

public static final java.lang.String DIRECTIVE_WAIT_FOR_DEPS

Wait for dependencies or directly start the context.

See Also:

Constant Field Values

DIRECTIVE_WAIT_FOR_DEPS_DEFAULT

public static final boolean DIRECTIVE_WAIT_FOR_DEPS_DEFAULT

DIRECTIVE_WAIT_FOR_DEPS default.

See Also:

Constant Field Values

EQUALS

public static final java.lang.String EQUALS

See Also:

Constant Field Values

DIRECTIVE_SEPARATOR

public static final java.lang.String DIRECTIVE_SEPARATOR

Token used for separating directives inside a header.

See Also:

Constant Field Values

CONTEXT_LOCATION_SEPARATOR

public static final java.lang.String CONTEXT_LOCATION_SEPARATOR

See Also:

Constant Field Values

DIRECTIVE_PUBLISH_CONTEXT_DEFAULT

public static final boolean DIRECTIVE_PUBLISH_CONTEXT_DEFAULT

See Also:

Constant Field Values

DIRECTIVE_CREATE_ASYNCHRONOUSLY_DEFAULT

public static final boolean DIRECTIVE_CREATE_ASYNCHRONOUSLY_DEFAULT

See Also:

Constant Field Values

DIRECTIVE_TIMEOUT_DEFAULT

public static final long DIRECTIVE_TIMEOUT_DEFAULT

See Also:

Constant Field Values

DIRECTIVE_NO_TIMEOUT

public static final long DIRECTIVE_NO_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

ConfigUtils

public ConfigUtils()

Method Detail

matchExtenderVersionRange

public static boolean matchExtenderVersionRange(org.osgi.framework.Bundle bundle,
                                                java.lang.String header,
                                                org.osgi.framework.Version versionToMatch)

getSpringContextHeader

public static java.lang.String getSpringContextHeader(java.util.Dictionary headers)

Return the "Spring-Context" if present from the given dictionary.

Parameters:

headers -

Returns:

getDirectiveValue

public static java.lang.String getDirectiveValue(java.lang.String header,
                                                 java.lang.String directive)

Return the directive value as a String. If the directive does not exist or is invalid (wrong format) a null string will be returned.

Parameters:

header -

directive -

Returns:

getDirectiveValue

private static java.lang.String getDirectiveValue(java.util.Dictionary headers,
                                                  java.lang.String directiveName)

Shortcut method to retrieve directive values. Used internally by the dedicated getXXX.

Parameters:

directiveName -

Returns:

isDirectiveDefined

public static boolean isDirectiveDefined(java.util.Dictionary headers,
                                         java.lang.String directiveName)

Returns true if the given directive is present or false otherwise.

Parameters:

headers -

directiveName -

Returns:

getPublishContext

public static boolean getPublishContext(java.util.Dictionary headers)

Shortcut for finding the boolean value for DIRECTIVE_PUBLISH_CONTEXT directive using the given headers. Assumes the headers belong to a Spring powered bundle.

Parameters:

headers -

Returns:

getCreateAsync

public static boolean getCreateAsync(java.util.Dictionary headers)

Shortcut for finding the boolean value for DIRECTIVE_CREATE_ASYNCHRONOUSLY directive using the given headers. Assumes the headers belong to a Spring powered bundle.

Parameters:

headers -

Returns:

getTimeOut

public static long getTimeOut(java.util.Dictionary headers)

Shortcut for finding the boolean value for DIRECTIVE_TIMEOUT directive using the given headers. Assumes the headers belong to a Spring powered bundle. Returns the timeout (in seconds) for which the application context should wait to have its dependencies satisfied.

Parameters:

headers -

Returns:

getWaitForDependencies

public static boolean getWaitForDependencies(java.util.Dictionary headers)

Shortcut for finding the boolean value for DIRECTIVE_WAIT_FOR_DEPS directive using the given headers. Assumes the headers belong to a Spring powered bundle.

Parameters:

headers -

Returns:

getHeaderLocations

public static java.lang.String[] getHeaderLocations(java.util.Dictionary headers)

Returns the location headers (if any) specified by the Spring-Context header (if available). The returned Strings can be sent to a ResourceLoader for loading the configurations.

Parameters:

headers - bundle headers

Returns:

array of locations specified (if any)

getLocationsFromHeader

public static java.lang.String[] getLocationsFromHeader(java.lang.String header,
                                                        java.lang.String defaultValue)

Similar to getHeaderLocations(Dictionary) but looks at a specified header directly.

Parameters:

header - header to look at

defaultValue - default locations if none is specified

Returns: