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

Class BlueprintConfigUtils

java.lang.Object

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

public class BlueprintConfigUtils
extends java.lang.Object

RFC124-version of ConfigUtils class. Basically a small util class that handles the retrieval of relevant headers from the any given bundle.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BLUEPRINT_GRACE_PERIOD Standard wait for dependencies header
static java.lang.String	BLUEPRINT_HEADER Manifest entry name for configuring Blueprint modules
static java.lang.String	BLUEPRINT_TIMEOUT Standard timeout header
private static java.lang.String	COMMA
private static java.lang.String	EQUALS
static java.lang.String	EXTENDER_VERSION
private static java.lang.String	SEMI_COLON

Constructor Summary

Constructors

Constructor and Description
BlueprintConfigUtils()

Method Summary

Modifier and Type	Method and Description
private static java.lang.String	getBlueprintDirectiveValue(java.util.Dictionary headers, java.lang.String directiveName) Shortcut method for retrieving the directive values.
static java.lang.String	getBlueprintHeader(java.util.Dictionary headers) Returns the "Bundle-Blueprint" if present from the given dictionary.
static java.lang.String[]	getBlueprintHeaderLocations(java.util.Dictionary headers) Returns the location headers (if any) specified by the Blueprint-Bundle header (if available).
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 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	getSymNameHeader(java.util.Dictionary headers)
static long	getTimeOut(java.util.Dictionary headers) Shortcut for finding the boolean value for BLUEPRINT_TIMEOUT directive using the given headers.
static boolean	getWaitForDependencies(java.util.Dictionary headers) Shortcut for finding the boolean value for BLUEPRINT_GRACE_PERIOD directive using the given headers.
static boolean	hasTimeout(java.util.Dictionary headers)

Methods inherited from class java.lang.Object

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

Field Detail

EQUALS

private static final java.lang.String EQUALS

See Also:

Constant Field Values

SEMI_COLON

private static final java.lang.String SEMI_COLON

See Also:

Constant Field Values

COMMA

private static final java.lang.String COMMA

See Also:

Constant Field Values

BLUEPRINT_HEADER

public static final java.lang.String BLUEPRINT_HEADER

Manifest entry name for configuring Blueprint modules

See Also:

Constant Field Values

BLUEPRINT_GRACE_PERIOD

public static final java.lang.String BLUEPRINT_GRACE_PERIOD

Standard wait for dependencies header

See Also:

Constant Field Values

BLUEPRINT_TIMEOUT

public static final java.lang.String BLUEPRINT_TIMEOUT

Standard timeout header

See Also:

Constant Field Values

EXTENDER_VERSION

public static final java.lang.String EXTENDER_VERSION

See Also:

Constant Field Values

Constructor Detail

BlueprintConfigUtils

public BlueprintConfigUtils()

Method Detail

getBlueprintHeader

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

Returns the "Bundle-Blueprint" if present from the given dictionary.

Parameters:

headers -

Returns:

getSymNameHeader

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

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:

getBlueprintDirectiveValue

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

Shortcut method for retrieving the directive values. Different then getDirectiveValue(Dictionary, String) since it looks at the Bundle-Symbolic header and not at Spring-Context.

Parameters:

headers -

directiveName -

Returns:

hasTimeout

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

getTimeOut

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

Shortcut for finding the boolean value for BLUEPRINT_TIMEOUT directive using the given headers. Assumes the headers belong to a Spring powered bundle. Returns the timeout (in milliseconds) 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 BLUEPRINT_GRACE_PERIOD directive using the given headers. Assumes the headers belong to a Spring powered bundle.

Parameters:

headers -

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:

getBlueprintHeaderLocations

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

Returns the location headers (if any) specified by the Blueprint-Bundle header (if available). The returned Strings can be sent to a ResourceLoader for loading the configurations. Different from ConfigUtils.getLocationsFromHeader(String, String) since "," is used for separating clauses while ; is used inside a clause to allow parameters or directives besides paths. Since the presence of the header, disables any processing this method will return null if the header is not specified, an empty array if it's empty (disabled) or a populated array otherwise.

Parameters:

headers - bundle headers

Returns:

array of locations specified (if any)