com.atlassian.jira.portal
Class PortletImpl

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

All Implemented Interfaces:

Portlet

Direct Known Subclasses:

AbstractRequiresUserPortlet, AbstractVotesAndWatchesPortlet, AdminPortlet, ProjectStatsPortlet, StatsPortlet, TwoDimensionalStatsPortlet

public class PortletImpl
extends Object
implements Portlet

Field Summary

protected ApplicationProperties	applicationProperties
protected JiraAuthenticationContext	authenticationContext
protected PermissionManager	permissionManager

Constructor Summary

PortletImpl(JiraAuthenticationContext authenticationContext)
Deprecated. Use full constructor instead.

PortletImpl(JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, ApplicationProperties applicationProperties)

Method Summary

boolean	equals(Object o)
String	getCornerThumbnail()
String	getDescription()
PortletModuleDescriptor	getDescriptor()
String	getId()
IssueConstant	getIssueConstant(org.ofbiz.core.entity.GenericValue issueConstantGV)
String	getName()
com.atlassian.configurable.ObjectConfiguration	getObjectConfiguration(Map params)
int	getPermission() Returns a list of permissions for this portlet.
String	getTemplateLocation()
String	getThumbnailfile() The path to a thumbnail image of this portlet
protected Map	getVelocityParams(PortletConfiguration portletConfiguration) Allow for the addition of additional Velocity parameters to the context.
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

permissionManager

protected PermissionManager permissionManager

applicationProperties

protected ApplicationProperties applicationProperties

Constructor Detail

PortletImpl

public PortletImpl(JiraAuthenticationContext authenticationContext)

Deprecated. Use full constructor instead.

PortletImpl

public PortletImpl(JiraAuthenticationContext authenticationContext,
                   PermissionManager permissionManager,
                   ApplicationProperties applicationProperties)

Method Detail

init

public void init(PortletModuleDescriptor descriptor)

Specified by:

init in interface Portlet

getTemplateLocation

public String getTemplateLocation()

Specified by:

getTemplateLocation in interface Portlet

getViewHtml

public String getViewHtml(PortletConfiguration portletConfiguration)

Specified by:

getViewHtml in interface Portlet

getVelocityParams

protected 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(Map params)
                                                                      throws com.atlassian.configurable.ObjectConfigurationException

Specified by:

getObjectConfiguration in interface Portlet

Throws:

com.atlassian.configurable.ObjectConfigurationException

getId

public String getId()

Specified by:

getId in interface Portlet

getName

public String getName()

Specified by:

getName in interface Portlet

getDescription

public 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 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 String getCornerThumbnail()

Specified by:

getCornerThumbnail in interface Portlet

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDescriptor

public PortletModuleDescriptor getDescriptor()

Specified by:

getDescriptor in interface Portlet

getIssueConstant

public IssueConstant getIssueConstant(org.ofbiz.core.entity.GenericValue issueConstantGV)