com.ibm.jaggr.core

Interface IAggregatorExtension

All Known Implementing Classes:

AggregatorExtension

public interface IAggregatorExtension

Interface for a registered aggregator extension. An Iterable of IAggregatorExtension objects is returned by the method IAggregator.getExtensions(String)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttribute(String name) Returns the value of the specified attribute.
Set<String>	getAttributeNames() Returns the set of attribute names for which getAttribute(String) will return a value.
String	getContributorId() Returns the bundle symbolic name for the bundle that contributed this extension.
String	getExtensionPointId() Returns the extension point id that this extension object implements
InitParams	getInitParams() Returns the init params for the extension.
Object	getInstance() Returns the object instance implementing this extension
String	getUniqueId() Returns the unique id for this extension

Method Detail

getExtensionPointId

String getExtensionPointId()

Returns the extension point id that this extension object implements

Returns:

The extension point id

getUniqueId

String getUniqueId()

Returns the unique id for this extension

Returns:

the extension unique id

getContributorId

String getContributorId()

Returns the bundle symbolic name for the bundle that contributed this extension. If the extension was registered through the IExtensionInitializer.IExtensionRegistrar interface, then the value is null.

Returns:

The contributor id

getInstance

Object getInstance()

Returns the object instance implementing this extension

Returns:

the object instance

getAttribute

String getAttribute(String name)

Returns the value of the specified attribute. These are the same as the attributes specified in the xml defining the extension, or in the case of extensions registered through IExtensionInitializer.IExtensionRegistrar.registerExtension(Object, Properties, InitParams, String, String, IAggregatorExtension), they are the attributes provided in the properties object.

Parameters:

name - the attribute name

Returns:

the attribute value

getAttributeNames

Set<String> getAttributeNames()

Returns the set of attribute names for which getAttribute(String) will return a value. The extension attributes which are allowed are defined by the extension point. For OSGi, they are specified in the extension point schema. All extensions must specify the (non-optional) attributes defined by the extension point and may not specify any attributes which are not defined by the extension point.

Returns:

The attribute names

getInitParams

InitParams getInitParams()

Returns the init params for the extension. Unlike attributes, init-params are not defined by the extension point, but rather by the implementing extension. Init-params may be multi-valued.

Returns:

the init params