org.apache.aries.subsystem

Interface ContentHandler

public interface ContentHandler

A handler for custom content in Subsystems. This handler must be registered as Whiteboard services with the CONTENT_TYPE_PROPERTY property indicating the content type this handler must be invoked for.

Custom content embedded inside an subsystem archive (e.g. .esa file) must be declared in the Subsystem-Content header where the EMBEDDED_RESOURCE_ATTRIBUTE can be used to associate it with the name of a file inside the archive.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_TYPE_PROPERTY
static java.lang.String	EMBEDDED_RESOURCE_ATTRIBUTE

Method Summary

Methods

Modifier and Type	Method and Description
void	install(java.io.InputStream is, java.lang.String symbolicName, java.lang.String contentType, Subsystem subsystem, org.osgi.service.coordinator.Coordination coordination) Install this custom content.
void	start(java.lang.String symbolicName, java.lang.String contentType, Subsystem subsystem, org.osgi.service.coordinator.Coordination coordination) Start this custom content.
void	stop(java.lang.String symbolicName, java.lang.String contentType, Subsystem subsystem) Stop this custom content.
void	uninstall(java.lang.String symbolicName, java.lang.String contentType, Subsystem subsystem) Uninstall this custom content.

Field Detail

CONTENT_TYPE_PROPERTY

static final java.lang.String CONTENT_TYPE_PROPERTY

See Also:

Constant Field Values

EMBEDDED_RESOURCE_ATTRIBUTE

static final java.lang.String EMBEDDED_RESOURCE_ATTRIBUTE

See Also:

Constant Field Values

Method Detail

install

void install(java.io.InputStream is,
           java.lang.String symbolicName,
           java.lang.String contentType,
           Subsystem subsystem,
           org.osgi.service.coordinator.Coordination coordination)

Install this custom content.

Parameters:

is - An input stream to the content.

symbolicName - The name of the content.

contentType - The type of the content.

subsystem - The target subsystem.

coordination - The current coordination. Can be used to register a compensation in case of failure or to fail the installation action.

start

void start(java.lang.String symbolicName,
         java.lang.String contentType,
         Subsystem subsystem,
         org.osgi.service.coordinator.Coordination coordination)

Start this custom content.

Parameters:

symbolicName - The name of the content.

contentType - The type of the content.

subsystem - The target subsystem.

coordination - The current coordination. Can be used to register a compensation in case of failure or to fail the start action.

stop

void stop(java.lang.String symbolicName,
        java.lang.String contentType,
        Subsystem subsystem)

Stop this custom content.

Parameters:

symbolicName - The name of the content.

contentType - The type of the content.

subsystem - The target subsystem.

uninstall

void uninstall(java.lang.String symbolicName,
             java.lang.String contentType,
             Subsystem subsystem)

Uninstall this custom content.

Parameters:

symbolicName - The name of the content.

contentType - The type of the content.

subsystem - The target subsystem.