com.atlassian.jira.portal
Class DefaultPortalManager

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

All Implemented Interfaces:

PortalManager

public class DefaultPortalManager

extends java.lang.Object

implements PortalManager

The DefaultPortalManager is the default PortalManager, getting it's configuration on a portlets.xml configuration file.

Field Summary

protected Category

log

Constructor Summary

DefaultPortalManager()

DefaultPortalManager(java.lang.String xml)

Method Summary

void	createPortalPageConfiguration(User u, java.lang.String pagename) Creates a new Portal Page Configuration in the database.
void	deletePortalPageConfiguration(User u, java.lang.String pagename) This function removed a portal page configuration for a user including all of its portlet configurations and there properties
java.util.List	getAllPortalPageConfigurations(java.lang.String pagename)
java.util.Collection	getAllPortlets() Get all the available portlets.
PortalPageConfiguration	getDefaultPortalPage(java.lang.String pagename) Goes to the database and fetches the default dashboard configuration.
PortalPageConfiguration	getEditablePortalPageConfiguration(User user, java.lang.String pagename)
PortalPageConfiguration	getPortalPageConfiguration(User user, java.lang.String pagename) Get a portlet configuration for a particular user and page from the database.
Portlet	getPortlet(java.lang.String id) Get a particular portlet, based on it's id.
java.util.Collection	getPortlets(User user) This function returns all the portlets a user has permission to see.
void	resetDefault(java.lang.String pagename) This function reloads the default portal page configuration from the database.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final Category log

Constructor Detail

DefaultPortalManager

public DefaultPortalManager()

DefaultPortalManager

public DefaultPortalManager(java.lang.String xml)

Method Detail

getAllPortlets

public java.util.Collection getAllPortlets()

Get all the available portlets.

Specified by:

getAllPortlets in interface PortalManager

Returns:

A Collection of all available portlets.

getPortlets

public java.util.Collection getPortlets(User user)

This function returns all the portlets a user has permission to see.

Specified by:

getPortlets in interface PortalManager

Parameters:

user - requesting portlets

Returns:

List of portlets for this user

createPortalPageConfiguration

public void createPortalPageConfiguration(User u,
                                          java.lang.String pagename)
                                   throws PortletConfigurationException

Creates a new Portal Page Configuration in the database.

Specified by:

createPortalPageConfiguration in interface PortalManager

Parameters:

u -

pagename -

Throws:

PortletConfigurationException

getAllPortalPageConfigurations

public java.util.List getAllPortalPageConfigurations(java.lang.String pagename)
                                              throws PortletConfigurationException

Specified by:

getAllPortalPageConfigurations in interface PortalManager

Throws:

PortletConfigurationException

getPortalPageConfiguration

public PortalPageConfiguration getPortalPageConfiguration(User user,
                                                          java.lang.String pagename)
                                                   throws PortletConfigurationException

Get a portlet configuration for a particular user and page from the database.

If it does not exist, the default portlet configuration will be used.

Specified by:

getPortalPageConfiguration in interface PortalManager

Throws:

PortletConfigurationException

getEditablePortalPageConfiguration

public PortalPageConfiguration getEditablePortalPageConfiguration(User user,
                                                                  java.lang.String pagename)
                                                           throws PortletConfigurationException

Specified by:

getEditablePortalPageConfiguration in interface PortalManager

Throws:

PortletConfigurationException

resetDefault

public void resetDefault(java.lang.String pagename)

This function reloads the default portal page configuration from the database. Into the static variable.

Specified by:

resetDefault in interface PortalManager

Parameters:

pagename - e.g. dashboard.

getDefaultPortalPage

public PortalPageConfiguration getDefaultPortalPage(java.lang.String pagename)
                                             throws PortletConfigurationException

Goes to the database and fetches the default dashboard configuration.

Specified by:

getDefaultPortalPage in interface PortalManager

Parameters:

pagename - eg. dashboard

Returns:

Throws:

PortletConfigurationException

deletePortalPageConfiguration

public void deletePortalPageConfiguration(User u,
                                          java.lang.String pagename)
                                   throws PortletConfigurationException

Description copied from interface: PortalManager

This function removed a portal page configuration for a user including all of its portlet configurations and there properties

Specified by:

deletePortalPageConfiguration in interface PortalManager

Parameters:

u - Owner

pagename - Name of portalpage e.g. dashboard

Throws:

PortletConfigurationException

getPortlet

public Portlet getPortlet(java.lang.String id)

Get a particular portlet, based on it's id.

Specified by:

getPortlet in interface PortalManager