com.atlassian.jira.portal
Class PortletImpl

java.lang.Object
  com.atlassian.jira.portal.PortletImpl

All Implemented Interfaces:

Portlet

Direct Known Subclasses:

AdminPortlet, AssignedToMePortlet, ProjectStatsPortlet, StatsPortlet, TwoDimensionalStatsPortlet

public class PortletImpl

extends java.lang.Object

implements Portlet

Field Summary

protected JiraAuthenticationContext

authenticationContext

Constructor Summary

PortletImpl(JiraAuthenticationContext authenticationContext)

Method Summary

boolean	equals(java.lang.Object o)
java.lang.String	getCornerThumbnail()
java.lang.String	getDescription()
PortletModuleDescriptor	getDescriptor()
java.lang.String	getId()
java.lang.String	getName()
com.atlassian.configurable.ObjectConfiguration	getObjectConfiguration(java.util.Map params)
int	getPermission() Returns a list of permissions for this portlet.
java.lang.String	getTemplateLocation()
java.lang.String	getThumbnailfile() The path to a thumbnail image of this portlet
protected java.util.Map	getVelocityParams(PortletConfiguration portletConfiguration) Allow for the addition of additional Velocity parameters to the context.
java.lang.String	getViewHtml(PortletConfiguration portletConfiguration)
int	hashCode()
boolean	hasPermission() Does the portlet have a permission set on it
void	init(PortletModuleDescriptor descriptor)

Methods inherited from class java.lang.Object

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

Field Detail

authenticationContext

protected final JiraAuthenticationContext authenticationContext

Constructor Detail

PortletImpl

public PortletImpl(JiraAuthenticationContext authenticationContext)

Method Detail

init

public void init(PortletModuleDescriptor descriptor)

Specified by:

init in interface Portlet

getTemplateLocation

public java.lang.String getTemplateLocation()

Specified by:

getTemplateLocation in interface Portlet

getViewHtml

public java.lang.String getViewHtml(PortletConfiguration portletConfiguration)

Specified by:

getViewHtml in interface Portlet

getVelocityParams

protected java.util.Map getVelocityParams(PortletConfiguration portletConfiguration)

Allow for the addition of additional Velocity parameters to the context. Sub-classes may wish to override this to add their own object to the velocity context

getObjectConfiguration

public com.atlassian.configurable.ObjectConfiguration getObjectConfiguration(java.util.Map params)
                                                                      throws com.atlassian.configurable.ObjectConfigurationException

Specified by:

getObjectConfiguration in interface Portlet

Throws:

com.atlassian.configurable.ObjectConfigurationException

getId

public java.lang.String getId()

Specified by:

getId in interface Portlet

getName

public java.lang.String getName()

Specified by:

getName in interface Portlet

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Portlet

hasPermission

public boolean hasPermission()

Description copied from interface: Portlet

Does the portlet have a permission set on it

Specified by:

hasPermission in interface Portlet

Returns:

true If this user has a permission e.g. getPermission == -1

getPermission

public int getPermission()

Description copied from interface: Portlet

Returns a list of permissions for this portlet.

Specified by:

getPermission in interface Portlet

Returns:

Returns a Permission. -1 indicates no permission so viewable by everyone

getThumbnailfile

public java.lang.String getThumbnailfile()

Description copied from interface: Portlet

The path to a thumbnail image of this portlet

Specified by:

getThumbnailfile in interface Portlet

Returns:

Path to image

getCornerThumbnail

public java.lang.String getCornerThumbnail()

Specified by:

getCornerThumbnail in interface Portlet

equals

public boolean equals(java.lang.Object o)

hashCode

public int hashCode()

getDescriptor

public PortletModuleDescriptor getDescriptor()

Specified by:

getDescriptor in interface Portlet