org.ops4j.pax.wicket.api
Interface ContentSource<E extends org.apache.wicket.Component>

All Known Implementing Classes:

AbstractAggregatedSource, AbstractContentSource, FloorAggregatedSource, FranchiseeContentSource

public interface ContentSource<E extends org.apache.wicket.Component>

This is the model interface of ContentSource. ContentSource is categorized as the model of a Wicket component hierarchy, which can be unloaded, replaced and moved in runtime, without needing to shut the application down.

Field Summary

static java.lang.String	AGGREGATION_POINT Service property name for the configuration of the AggregationPoint.
static java.lang.String	APPLICATION_NAME Service property name for the configuration of the ApplicationName.
static java.lang.String	BASIC_ROLES Basic Roles are used for ContentSource authorization.
static java.lang.String	DESTINATION_UNKNOWN Service property value for the configuration of a Destination that is not known, and therefor will not be wired.
static java.lang.String	DESTINATIONS Service property name for the configuration of the Destination of a ContentSource.
static java.lang.String	HOMEPAGE_CLASSNAME Service property name for the configuration of the classname of the HomePage.
static java.lang.String	MOUNTPOINT Service property name for the configuration of the MountPoint.
static java.lang.String	PAGE_ID Service property name for the configuration of the PageId.
static java.lang.String	PAGE_NAME Service property name for the configuration of the PageName.
static java.lang.String	REQUIRED_ROLES Required Roles are used for ContentSource authorization.
static java.lang.String	SOURCE_ID Prefix used in the Constants.SERVICE_PID to uniquely identify Pax Wicket ContentSource instances for the Configuration Admin service.

Method Summary

<T extends org.apache.wicket.MarkupContainer> E	createSourceComponent(java.lang.String wicketId) Create the wicket component represented by this ContentSource instance.
<T extends org.apache.wicket.MarkupContainer> E	createSourceComponent(java.lang.String wicketId, T parent) Create the wicket component represented by this ContentSource instance.
java.lang.String[]	getDestinations() Returns the destinations of this ContentSource instance.
java.lang.String	getSourceId() Returns the content source id.

Field Detail

MOUNTPOINT

static final java.lang.String MOUNTPOINT

Service property name for the configuration of the MountPoint.

See Also:

Constant Field Values

APPLICATION_NAME

static final java.lang.String APPLICATION_NAME

Service property name for the configuration of the ApplicationName.

See Also:

Constant Field Values

DESTINATIONS

static final java.lang.String DESTINATIONS

Service property name for the configuration of the Destination of a ContentSource.

See Also:

Constant Field Values

DESTINATION_UNKNOWN

static final java.lang.String DESTINATION_UNKNOWN

Service property value for the configuration of a Destination that is not known, and therefor will not be wired.

See Also:

Constant Field Values

PAGE_NAME

static final java.lang.String PAGE_NAME

Service property name for the configuration of the PageName.

See Also:

Constant Field Values

PAGE_ID

static final java.lang.String PAGE_ID

Service property name for the configuration of the PageId.

See Also:

Constant Field Values

SOURCE_ID

static final java.lang.String SOURCE_ID

Prefix used in the Constants.SERVICE_PID to uniquely identify Pax Wicket ContentSource instances for the Configuration Admin service.

See Also:

Constant Field Values

AGGREGATION_POINT

static final java.lang.String AGGREGATION_POINT

Service property name for the configuration of the AggregationPoint.

See Also:

Constant Field Values

HOMEPAGE_CLASSNAME

static final java.lang.String HOMEPAGE_CLASSNAME

Service property name for the configuration of the classname of the HomePage.

See Also:

Constant Field Values

BASIC_ROLES

static final java.lang.String BASIC_ROLES

Basic Roles are used for ContentSource authorization.

The current user must have one or more of the roles that are listed in the BASIC_ROLES property of a ContentSource. Otherwise the component(s) of that ContentSource will not be created.

This service property is an array of Strings.

See Also:

Constant Field Values

REQUIRED_ROLES

static final java.lang.String REQUIRED_ROLES

Required Roles are used for ContentSource authorization.

The current user must have all the roles that are listed in the REQUIRED_ROLES property of a ContentSource. Otherwise the component(s) of that ContentSource will not be created.

This service property is an array of Strings.

See Also:

Constant Field Values

Method Detail

getSourceId

java.lang.String getSourceId()

Returns the content source id.

Returns:

The content source id.

Since:

1.0.0

getDestinations

java.lang.String[] getDestinations()

Returns the destinations of this ContentSource instance. This method must not return null object.

The Destination is constructed by concatenating the AggregationPointMatchExpression, ".", and the ContentMatchExpression. For example, If the AggregationPointMatchExpression is "overviewtabs" and the ContentMatchExpression is "quickMenu", the returned Destination is "overviewtabs.quickMenu".

Returns:

The destination id of this ContentSource instance.

Since:

1.0.0

createSourceComponent

<T extends org.apache.wicket.MarkupContainer> E createSourceComponent(java.lang.String wicketId)

Create the wicket component represented by this ContentSource instance. This method must not return null object.

General convention:

• In the use case of Wicket 1 environment. The callee of this method responsibles to add the component created this method;

Parameters:

wicketId - The wicket id. This argument must not be null.

Returns:

The wicket component represented by this ContentSource instance, or null if user has no access to this ContentSource.

Throws:

java.lang.IllegalArgumentException - Thrown if the wicketId argument is null.

Since:

1.0.0

createSourceComponent

<T extends org.apache.wicket.MarkupContainer> E createSourceComponent(java.lang.String wicketId,
                                                                      T parent)

Create the wicket component represented by this ContentSource instance. This method must not return null object.

Parameters:

wicketId - The wicket id. This argument must not be null.

parent - the parent MarkupContainer

Returns:

The wicket component represented by this ContentSource instance, or null if user has no access to this ContentSource.

Throws:

java.lang.IllegalArgumentException - Thrown if the wicketId argument is null.