org.apache.jetspeed.util.descriptor
Class PortletApplicationDescriptor

java.lang.Object
  org.apache.jetspeed.util.descriptor.PortletApplicationDescriptor

public class PortletApplicationDescriptor
extends Object

Object used to perform operation upon a portlet application descriptor, usually, portlet.xml.

Version:

$Id: PortletApplicationDescriptor.java 516448 2007-03-09 16:25:47Z ate $

Author:

Roger Ruttimann, David Sean Taylor, Scott T. Weaver

Field Summary

private String	appName
protected static org.apache.commons.logging.Log	log
protected Reader	portletXmlReader

Constructor Summary

PortletApplicationDescriptor(Reader portletXmlReader, String appName)

Method Summary

org.apache.jetspeed.om.common.portlet.MutablePortletApplication	createPortletApplication()
org.apache.jetspeed.om.common.portlet.MutablePortletApplication	createPortletApplication(ClassLoader classLoader) Maps the content of the portlet application descriptor into a new MutablePortletApplication object
void	validate(org.apache.jetspeed.om.common.portlet.MutablePortletApplication app) Validate a PortletApplicationDefinition tree AFTER its WebApplicationDefinition has been loaded.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

portletXmlReader

protected Reader portletXmlReader

appName

private String appName

Constructor Detail

PortletApplicationDescriptor

public PortletApplicationDescriptor(Reader portletXmlReader,
                                    String appName)

Method Detail

createPortletApplication

public org.apache.jetspeed.om.common.portlet.MutablePortletApplication createPortletApplication()
                                                                                         throws PortletApplicationException

Throws:

PortletApplicationException

createPortletApplication

public org.apache.jetspeed.om.common.portlet.MutablePortletApplication createPortletApplication(ClassLoader classLoader)
                                                                                         throws PortletApplicationException

Maps the content of the portlet application descriptor into a new MutablePortletApplication object

Returns:

MutablePortletApplication newly created MutablePortletApplication with all values of the portlet application descriptor mapped into it.

Throws:

PortletApplicationException

validate

public void validate(org.apache.jetspeed.om.common.portlet.MutablePortletApplication app)
              throws PortletApplicationException

Validate a PortletApplicationDefinition tree AFTER its WebApplicationDefinition has been loaded. Currently, only the security role references of the portlet definitions are validated:

• A security role reference should reference a security role through a roleLink. A warning message is logged if a direct reference is used.
• For a security role reference a security role must be defined in the web application. An error message is logged and a PortletApplicationException is thrown if not.

Parameters:

app - The PortletApplicationDefinition to validate

Throws:

PortletApplicationException