com.ibm.portal.cp.resources.builder
Interface CustomResourceBuilderProvider

public interface CustomResourceBuilderProvider

Provider of ResourceBuilders.

There is an extension point to register a custom ResourceBuilderProvider for certain URI schemes. Example to register a filter provider for the URI schemes foo and bar:

 <extension point="com.ibm.portal.cp.CustomResourceBuilderProvider" id="FooBarResourceBuilderProvider;>
        <factory id="FooBarResourceBuilderProvider" class="com.ibm.wps.sample.FooBarResourceBuilderProvider">
            <properties>
                <entry key="scheme">foo</entry>
                <entry key="scheme">bar</entry>
            </properties>
        </factory>
    </extension>
 

Since:

7.0.0

Note:

This interface is designed to be implemented by clients.

Field Summary

static java.lang.String	ATTR_CLASS name of the class attribute used for instantiation
static java.lang.String	DEFAULT_EXTENSION_ID ID of the default custom resource builder provider that dispatches to all pluged-in providers based on the type schema
static java.lang.String	EXTENSION_POINT_ID ID of the ResourceBuilder extension point
static java.lang.String	FALLBACK_EXTENSION_ID ID of a custom resource builder provider that does not check if a resource exists and provides no titles etc.

Method Summary

CustomResourceBuilder

getResourceBuilder(Context ctx, java.util.Map<java.lang.String,java.lang.String[]> params) Obtains the ResourceBuilder for the given COR context.

Field Detail

EXTENSION_POINT_ID

static final java.lang.String EXTENSION_POINT_ID

ID of the ResourceBuilder extension point

See Also:

Constant Field Values

DEFAULT_EXTENSION_ID

static final java.lang.String DEFAULT_EXTENSION_ID

ID of the default custom resource builder provider that dispatches to all pluged-in providers based on the type schema

See Also:

Constant Field Values

FALLBACK_EXTENSION_ID

static final java.lang.String FALLBACK_EXTENSION_ID

ID of a custom resource builder provider that does not check if a resource exists and provides no titles etc. This in particular can be used when doing some administrative work.

See Also:

Constant Field Values

ATTR_CLASS

static final java.lang.String ATTR_CLASS

name of the class attribute used for instantiation

See Also:

Constant Field Values

Method Detail

getResourceBuilder

CustomResourceBuilder getResourceBuilder(Context ctx,
                                         java.util.Map<java.lang.String,java.lang.String[]> params)
                                         throws ResourceBuilderException

Obtains the ResourceBuilder for the given COR context.

Parameters:

ctx - The COR context, never null

params - The parameters. As of version 7.0.0 the parameters are empty by default. This might change in later versions.

Returns:

The ResourceBuilder, never null

Throws:

ResourceBuilderException