org.apache.pluto.container.driver

Interface PortletRegistryService

public interface PortletRegistryService

Interface defining the services used by the container to access portlet applications. The registry acts as both registry and publically as a mechanism for notifying the container of new applications.

Since:

1.1.0

Method Summary

Modifier and Type	Method and Description
void	addPortletRegistryListener(PortletRegistryListener listener) Add a listener which will recieve notifications of newly registered applications.
org.apache.pluto.container.om.portlet.PortletDefinition	getPortlet(String applicationName, String portletName) Retreive the Portlet for the specified portlet.
org.apache.pluto.container.om.portlet.PortletApplicationDefinition	getPortletApplication(String applicationName) Retrieve the PortletApp for the specified portlet application Name.
Iterator<String>	getRegisteredPortletApplicationNames() Retrieve the names of all registered applications.
void	removePortletRegistryListener(PortletRegistryListener listener) Remove a previously registered listener.

Method Detail

getRegisteredPortletApplicationNames

Iterator<String> getRegisteredPortletApplicationNames()

Retrieve the names of all registered applications. This list will only contain those applications which have been registered with the container. Others may or may not be available within the servers.

Returns:

iterator of all PortletApp names (strings).

getPortletApplication

org.apache.pluto.container.om.portlet.PortletApplicationDefinition getPortletApplication(String applicationName)
                                                                                  throws org.apache.pluto.container.PortletContainerException

Retrieve the PortletApp for the specified portlet application Name.

Parameters:

applicationName - the name of the portlet application.

Returns:

the named PortletApp.

Throws:

org.apache.pluto.container.PortletContainerException - if the portlet application isn't registered.

getPortlet

org.apache.pluto.container.om.portlet.PortletDefinition getPortlet(String applicationName,
                                                                   String portletName)
                                                            throws org.apache.pluto.container.PortletContainerException

Retreive the Portlet for the specified portlet.

Parameters:

applicationName - portlet application name

portletName - portlet name

Returns:

portlet

Throws:

org.apache.pluto.container.PortletContainerException - if portlet or application unknown

addPortletRegistryListener

void addPortletRegistryListener(PortletRegistryListener listener)

Add a listener which will recieve notifications of newly registered applications.

Parameters:

listener - the listener to add

removePortletRegistryListener

void removePortletRegistryListener(PortletRegistryListener listener)

Remove a previously registered listener.

Parameters:

listener - the listener to remove