net.sf.jportlet.portlet.descriptor
Class PortletDescriptor

java.lang.Object
  |
  +--net.sf.jportlet.portlet.descriptor.PortletDescriptor

public class PortletDescriptor

extends java.lang.Object

Descriptor of a Portlet

Author:

Herve Tchepannou

Constructor Summary

PortletDescriptor()

Method Summary

void	addAuthConstraintDescriptor(net.sf.jportlet.portlet.descriptor.AuthConstraintDescriptor descriptor)
void	addCacheDescriptor(net.sf.jportlet.portlet.descriptor.CacheDescriptor descriptor)
void	addInitParameter(java.lang.String name, java.lang.String value)
void	addLanguageDescriptor(net.sf.jportlet.portlet.descriptor.LanguageDescriptor descriptor)
void	addMarkupDescriptor(net.sf.jportlet.portlet.descriptor.MarkupDescriptor descriptor)
void	addWebflowActionDescriptor(net.sf.jportlet.portlet.descriptor.WebflowActionDescriptor descriptor)
java.lang.Class	getActionListenerClass()
net.sf.jportlet.portlet.descriptor.AuthConstraintDescriptor	getAuthConstraintDescriptor(Portlet.Mode mode)
java.util.ResourceBundle	getBundle(java.util.Locale locale) Returns the ResourceBundle of the portlet
net.sf.jportlet.portlet.descriptor.CacheDescriptor	getCacheDescriptor(Portlet.Mode mode)
java.lang.String	getContextName()
java.lang.String	getContextPath()
java.lang.String	getDefaultLocale()
java.lang.String	getInitParameter(java.lang.String name)
java.util.Enumeration	getInitParameterNames()
net.sf.jportlet.portlet.descriptor.LanguageDescriptor	getLanguageDescriptor(java.util.Locale locale)
java.lang.Class	getMessageListenerClass()
java.lang.String	getName()
java.lang.Class	getPortletClass()
net.sf.jportlet.portlet.descriptor.WebflowActionDescriptor	getWebflowAction(java.lang.String name)
void	setActionListenerClass(java.lang.Class actionListenerClass)
void	setContextName(java.lang.String contextName)
void	setDefaultLocale(java.lang.String defaultLocale)
void	setMessageListenerClass(java.lang.Class messageListenerClass)
void	setName(java.lang.String name)
void	setPortletClass(java.lang.Class portletClass)
boolean	supports(Portlet.Mode mode, Portlet.Markup markup)

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletDescriptor

public PortletDescriptor()

Method Detail

addAuthConstraintDescriptor

public void addAuthConstraintDescriptor(net.sf.jportlet.portlet.descriptor.AuthConstraintDescriptor descriptor)

addCacheDescriptor

public void addCacheDescriptor(net.sf.jportlet.portlet.descriptor.CacheDescriptor descriptor)

addInitParameter

public void addInitParameter(java.lang.String name,
                             java.lang.String value)

addLanguageDescriptor

public void addLanguageDescriptor(net.sf.jportlet.portlet.descriptor.LanguageDescriptor descriptor)

addMarkupDescriptor

public void addMarkupDescriptor(net.sf.jportlet.portlet.descriptor.MarkupDescriptor descriptor)
                         throws PortletException

PortletException

addWebflowActionDescriptor

public void addWebflowActionDescriptor(net.sf.jportlet.portlet.descriptor.WebflowActionDescriptor descriptor)
                                throws PortletException

PortletException

getActionListenerClass

public java.lang.Class getActionListenerClass()

getAuthConstraintDescriptor

public net.sf.jportlet.portlet.descriptor.AuthConstraintDescriptor getAuthConstraintDescriptor(Portlet.Mode mode)

getBundle

public java.util.ResourceBundle getBundle(java.util.Locale locale)

Returns the ResourceBundle of the portlet

Parameters:

locale -

Returns:

ResourceBundle

getCacheDescriptor

public net.sf.jportlet.portlet.descriptor.CacheDescriptor getCacheDescriptor(Portlet.Mode mode)

getContextName

public java.lang.String getContextName()

Returns:

String

getContextPath

public java.lang.String getContextPath()

Returns:

String

getDefaultLocale

public java.lang.String getDefaultLocale()

getInitParameter

public java.lang.String getInitParameter(java.lang.String name)

getInitParameterNames

public java.util.Enumeration getInitParameterNames()

getLanguageDescriptor

public net.sf.jportlet.portlet.descriptor.LanguageDescriptor getLanguageDescriptor(java.util.Locale locale)

getMessageListenerClass

public java.lang.Class getMessageListenerClass()

getName

public java.lang.String getName()

getPortletClass

public java.lang.Class getPortletClass()

getWebflowAction

public net.sf.jportlet.portlet.descriptor.WebflowActionDescriptor getWebflowAction(java.lang.String name)

Returns:

HashMap

setActionListenerClass

public void setActionListenerClass(java.lang.Class actionListenerClass)

setContextName

public void setContextName(java.lang.String contextName)

setDefaultLocale

public void setDefaultLocale(java.lang.String defaultLocale)

setMessageListenerClass

public void setMessageListenerClass(java.lang.Class messageListenerClass)

setName

public void setName(java.lang.String name)

setPortletClass

public void setPortletClass(java.lang.Class portletClass)

supports

public boolean supports(Portlet.Mode mode,
                        Portlet.Markup markup)