org.ops4j.pax.wicket.api
Class PaxWicketApplicationFactory

java.lang.Object
  org.ops4j.pax.wicket.api.PaxWicketApplicationFactory

All Implemented Interfaces:

org.apache.wicket.protocol.http.IWebApplicationFactory, org.osgi.service.cm.ManagedService

public final class PaxWicketApplicationFactory
extends java.lang.Object
implements org.apache.wicket.protocol.http.IWebApplicationFactory, org.osgi.service.cm.ManagedService

Constructor Summary

PaxWicketApplicationFactory(org.osgi.framework.BundleContext aBundleContext, java.lang.Class<? extends org.apache.wicket.Page> aHomepageClass, java.lang.String aMountPoint, java.lang.String anApplicationName)
Construct an instance of PaxWicketApplicationFactory with the specified arguments.

Method Summary

void	addComponentInstantiationListener(org.apache.wicket.application.IComponentInstantiationListener listener)
org.apache.wicket.protocol.http.WebApplication	createApplication(org.apache.wicket.protocol.http.WicketFilter aFilter) Creates a web application.
void	dispose() Clear resources used by this PaxWicketApplicationFactory instance.
java.lang.String	getMountPoint() Returns the mount point that the wicket application will be accessible.
org.osgi.framework.ServiceRegistration	register() Register this PaxWicketApplicationFactory instance to OSGi container.
void	setAuthenticator(PaxWicketAuthenticator anAuthenticator, java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> aSignInPage) Sets the authenticator of this pax application factory.
void	setPageMounter(PageMounter aPageMounter)
void	setPaxWicketBundle(org.osgi.framework.Bundle aBundle)
void	updated(java.util.Dictionary config)

Methods inherited from class java.lang.Object

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

Constructor Detail

PaxWicketApplicationFactory

public PaxWicketApplicationFactory(org.osgi.framework.BundleContext aBundleContext,
                                   java.lang.Class<? extends org.apache.wicket.Page> aHomepageClass,
                                   java.lang.String aMountPoint,
                                   java.lang.String anApplicationName)
                            throws java.lang.IllegalArgumentException

Construct an instance of PaxWicketApplicationFactory with the specified arguments.

Parameters:

aBundleContext - The bundle context. This argument must not be null.

aHomepageClass - The homepage class. This argument must not be null.

aMountPoint - The mount point. This argument must not be be null.

anApplicationName - The application name. This argument must not be null.

Throws:

java.lang.IllegalArgumentException - Thrown if one or some or all arguments are null.

Since:

1.0.0

Method Detail

setAuthenticator

public final void setAuthenticator(PaxWicketAuthenticator anAuthenticator,
                                   java.lang.Class<? extends org.apache.wicket.markup.html.WebPage> aSignInPage)
                            throws java.lang.IllegalArgumentException

Sets the authenticator of this pax application factory.

Note: Value changed will only affect wicket application created after this method invocation.

Parameters:

anAuthenticator - The authenticator.

aSignInPage - The sign in page.

Throws:

java.lang.IllegalArgumentException - Thrown if one of the arguments are null.

Since:

1.0.0

See Also:

register()

dispose

public final void dispose()

Clear resources used by this PaxWicketApplicationFactory instance.

Note: dispose does not unregister this PaxWicketApplicationFactory instance from the OSGi container.

Since:

1.0.0

getMountPoint

public final java.lang.String getMountPoint()

Returns the mount point that the wicket application will be accessible. This method must not return null string.

Returns:

The mount point that the wicket application will be accessible.

Since:

1.0.0

updated

public final void updated(java.util.Dictionary config)
                   throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

org.osgi.service.cm.ConfigurationException

register

public final org.osgi.framework.ServiceRegistration register()

Register this PaxWicketApplicationFactory instance to OSGi container.

Returns:

The service registration.

Since:

1.0.0

setPageMounter

public final void setPageMounter(PageMounter aPageMounter)

setPaxWicketBundle

public final void setPaxWicketBundle(org.osgi.framework.Bundle aBundle)

addComponentInstantiationListener

public void addComponentInstantiationListener(org.apache.wicket.application.IComponentInstantiationListener listener)

createApplication

public final org.apache.wicket.protocol.http.WebApplication createApplication(org.apache.wicket.protocol.http.WicketFilter aFilter)

Creates a web application.

Specified by:

createApplication in interface org.apache.wicket.protocol.http.IWebApplicationFactory

Parameters:

aFilter - The wicket filter.

Returns:

The new web application.