org.jahia.services.applications

Class ApplicationsManagerServiceImpl

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.applications.ApplicationsManagerService

org.jahia.services.applications.ApplicationsManagerServiceImpl

All Implemented Interfaces:

JahiaAfterInitializationService

public class ApplicationsManagerServiceImpl
extends ApplicationsManagerService
implements JahiaAfterInitializationService

This Service is used to manage the jahia application definitions.

Version:

1.0

Author:

Khue ng

Field Summary

Fields

Modifier and Type	Field and Description
static String	WEBAPPS_PERMISSION_PATH

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApplicationsManagerServiceImpl() constructor

Method Summary

Modifier and Type	Method and Description
void	addCustomPortletModeBean(CustomPortletMode customPortletMode) Add custom portlet modes
void	addCustomWindowState(CustomWindowState customWindowState) Add custom window state
boolean	addDefinition(ApplicationBean app) Add a new Application Definition.
EntryPointInstance	createEntryPointInstance(EntryPointDefinition entryPointDefinition, String path) Creates an instance of an application entry point definition.
List<EntryPointDefinition>	getAppEntryPointDefinitions(ApplicationBean appBean) Get all EntryPointDefinition od the application bean
ApplicationBean	getApplication(String appID) return an Application Definition get directly from db
ApplicationBean	getApplicationByContext(String context) return an Application Definition looking at its context.
WebAppContext	getApplicationContext(ApplicationBean appBean) Get an WebAppContext for a given application bean
WebAppContext	getApplicationContext(String id) Get an ApplicationContext for a given application id
List<ApplicationBean>	getApplications() return all application Definitions
EntryPointInstance	getEntryPointInstance(JCRPortletNode node) Get entryPoint object from JCRPorletNode
EntryPointInstance	getEntryPointInstance(String epInstanceID, String workspaceName) Retrieves an EntryPointInstance object from the persistance system by using it's ID as a search key
static String	getEntryPointNamespaceURI(String appName, String entryPointDefinitionName)
static String	getEntryPointPrefix(String appName, String entryPointDefinitionName)
static ApplicationsManagerServiceImpl	getInstance() return the singleton instance
static String	getPortletQualifiedNodeName(String appName, String entryPointDefinitionName, String localName)
org.apache.pluto.container.PortletWindow	getPortletWindow(EntryPointInstance entryPointInstance, String windowID, JahiaUser jahiaUser, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, javax.servlet.ServletContext servletContext, String workspaceName) Get Portlet Window object
List<javax.portlet.PortletMode>	getSupportedPortletModes() Get supported portlet modes
List<javax.portlet.WindowState>	getSupportedWindowStates() Get supported window states
static String	getWebAppNamespaceURI(String appName)
static String	getWebAppPrefix(String appName)
static String	getWebAppQualifiedNodeName(String appName, String localName)
void	initAfterAllServicesAreStarted()
void	loadCustomPortletModes(String supportedPortletModesConfigFileName) load custom portlet mode
void	loadCustomWindowStates(String supportedWindowStatesConfigFileName) Load custom window states
void	registerListeners()
void	removeApplication(String appID) Removes an application from the persistant storage area and from registry.
void	removeEntryPointInstance(String epInstanceID) Removes an entry point instance from the persistance system.
boolean	saveDefinition(ApplicationBean app) Save the Application Definition.
void	setCacheService(CacheService cacheService)
void	setDefaultPortletModeMappings(Map<String,String> defaultPortletModeMappings)
void	setDefaultPortletPermissionMappings(Map<String,String> defaultPortletPermissionMappings)
void	setDefaultWebAppRoleMappings(Map<String,String> defaultWebAppRoleMappings)
void	setGroupManagerService(JahiaGroupManagerService groupManagerService)
void	setJcrTemplate(JCRTemplate jcrTemplate)
void	setManagerProviders(Map<String,ApplicationsManagerProvider> managerProviders)
void	setPlutoServices(org.apache.pluto.container.driver.PlutoServices plutoServices)
void	setServletContextManager(ServletContextManager servletContextManager)
boolean	setVisible(String appID, boolean visible) set an application Visible to users
void	start() Initialze disk path
void	stop()

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object

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

Field Detail

WEBAPPS_PERMISSION_PATH

public static final String WEBAPPS_PERMISSION_PATH

See Also:

Constant Field Values

Constructor Detail

ApplicationsManagerServiceImpl

protected ApplicationsManagerServiceImpl()

constructor

Method Detail

setCacheService

public void setCacheService(CacheService cacheService)

setManagerProviders

public void setManagerProviders(Map<String,ApplicationsManagerProvider> managerProviders)

setGroupManagerService

public void setGroupManagerService(JahiaGroupManagerService groupManagerService)

setServletContextManager

public void setServletContextManager(ServletContextManager servletContextManager)

setJcrTemplate

public void setJcrTemplate(JCRTemplate jcrTemplate)

setPlutoServices

public void setPlutoServices(org.apache.pluto.container.driver.PlutoServices plutoServices)

setDefaultPortletPermissionMappings

public void setDefaultPortletPermissionMappings(Map<String,String> defaultPortletPermissionMappings)

setDefaultWebAppRoleMappings

public void setDefaultWebAppRoleMappings(Map<String,String> defaultWebAppRoleMappings)

setDefaultPortletModeMappings

public void setDefaultPortletModeMappings(Map<String,String> defaultPortletModeMappings)

getInstance

public static ApplicationsManagerServiceImpl getInstance()

return the singleton instance

start

public void start()
           throws JahiaInitializationException

Initialze disk path

Specified by:

start in class JahiaService

Throws:

JahiaInitializationException

initAfterAllServicesAreStarted

public void initAfterAllServicesAreStarted()
                                    throws JahiaInitializationException

Specified by:

initAfterAllServicesAreStarted in interface JahiaAfterInitializationService

Throws:

JahiaInitializationException

stop

public void stop()

Specified by:

stop in class JahiaService

getApplication

public ApplicationBean getApplication(String appID)
                               throws JahiaException

return an Application Definition get directly from db

Specified by:

getApplication in class ApplicationsManagerService

Parameters:

appID - the appID

Returns:

ApplicationBean, the Application Definition

Throws:

JahiaException

getApplicationByContext

public ApplicationBean getApplicationByContext(String context)
                                        throws JahiaException

return an Application Definition looking at its context.

Specified by:

getApplicationByContext in class ApplicationsManagerService

Parameters:

context - , the context

Returns:

ApplicationBean, the Application Definition

Throws:

JahiaException

getApplications

public List<ApplicationBean> getApplications()
                                      throws JahiaException

return all application Definitions

Specified by:

getApplications in class ApplicationsManagerService

Returns:

Iterator an enumerations of ApplicationBean or null if empty

Throws:

JahiaException

setVisible

public boolean setVisible(String appID,
                          boolean visible)
                   throws JahiaException

set an application Visible to users

Specified by:

setVisible in class ApplicationsManagerService

Parameters:

appID -

visible - status

Returns:

false on error

Throws:

JahiaException

getWebAppNamespaceURI

public static String getWebAppNamespaceURI(String appName)

getWebAppPrefix

public static String getWebAppPrefix(String appName)

getEntryPointNamespaceURI

public static String getEntryPointNamespaceURI(String appName,
                                               String entryPointDefinitionName)

getEntryPointPrefix

public static String getEntryPointPrefix(String appName,
                                         String entryPointDefinitionName)

getWebAppQualifiedNodeName

public static String getWebAppQualifiedNodeName(String appName,
                                                String localName)

getPortletQualifiedNodeName

public static String getPortletQualifiedNodeName(String appName,
                                                 String entryPointDefinitionName,
                                                 String localName)

addDefinition

public boolean addDefinition(ApplicationBean app)
                      throws JahiaException

Add a new Application Definition. both in ApplicationsRegistry and in Persistance

Specified by:

addDefinition in class ApplicationsManagerService

Parameters:

app - the app Definition

Returns:

false on error

Throws:

JahiaException

saveDefinition

public boolean saveDefinition(ApplicationBean app)
                       throws JahiaException

Save the Application Definition. both in ApplicationsRegistry and in Persistance

Specified by:

saveDefinition in class ApplicationsManagerService

Parameters:

app - the app Definition

Returns:

false on error

Throws:

JahiaException

removeApplication

public void removeApplication(String appID)
                       throws JahiaException

Removes an application from the persistant storage area and from registry.

Specified by:

removeApplication in class ApplicationsManagerService

Parameters:

appID - identifier of the application to remove from the persistant storage area

Throws:

JahiaException - generated if there was an error while removing the application data from persistant storage area

getApplicationContext

public WebAppContext getApplicationContext(String id)
                                    throws JahiaException

Get an ApplicationContext for a given application id

Specified by:

getApplicationContext in class ApplicationsManagerService

Parameters:

id - , the application id

Returns:

the application context , null if not found

Throws:

JahiaException

getApplicationContext

public WebAppContext getApplicationContext(ApplicationBean appBean)
                                    throws JahiaException

Get an WebAppContext for a given application bean

Specified by:

getApplicationContext in class ApplicationsManagerService

Parameters:

appBean - the Application bean for which to retrieve the context

Returns:

the application context , null if not found

Throws:

JahiaException

createEntryPointInstance

public EntryPointInstance createEntryPointInstance(EntryPointDefinition entryPointDefinition,
                                                   String path)
                                            throws JahiaException

Creates an instance of an application entry point definition. This creates the entry in the database.

Specified by:

createEntryPointInstance in class ApplicationsManagerService

Parameters:

entryPointDefinition - EntryPointDefinition

path -

Returns:

the created instance for the entry point definition.

Throws:

JahiaException

getPortletWindow

public org.apache.pluto.container.PortletWindow getPortletWindow(EntryPointInstance entryPointInstance,
                                                                 String windowID,
                                                                 JahiaUser jahiaUser,
                                                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                 javax.servlet.http.HttpServletResponse httpServletResponse,
                                                                 javax.servlet.ServletContext servletContext,
                                                                 String workspaceName)
                                                          throws JahiaException

Get Portlet Window object

Specified by:

getPortletWindow in class ApplicationsManagerService

Parameters:

entryPointInstance -

windowID -

Returns:

Throws:

JahiaException

getAppEntryPointDefinitions

public List<EntryPointDefinition> getAppEntryPointDefinitions(ApplicationBean appBean)

Get all EntryPointDefinition od the application bean

Specified by:

getAppEntryPointDefinitions in class ApplicationsManagerService

Parameters:

appBean - ApplicationBean the application for which to retrieve the entry point definitions

Returns:

getEntryPointInstance

public EntryPointInstance getEntryPointInstance(String epInstanceID,
                                                String workspaceName)
                                         throws JahiaException

Retrieves an EntryPointInstance object from the persistance system by using it's ID as a search key

Specified by:

getEntryPointInstance in class ApplicationsManagerService

Parameters:

epInstanceID - int the unique identifier for the EntryPointInstance object in the persistence system

workspaceName - the name of the workspace in which to look for the entrypoint instance.

Returns:

EntryPointInstance the object if found in the persistance system, or null otherwise.

Throws:

JahiaException - thrown if there was an error communicating with the persistence system.

getEntryPointInstance

public EntryPointInstance getEntryPointInstance(JCRPortletNode node)
                                         throws javax.jcr.RepositoryException

Get entryPoint object from JCRPorletNode

Specified by:

getEntryPointInstance in class ApplicationsManagerService

Parameters:

node -

Returns:

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

removeEntryPointInstance

public void removeEntryPointInstance(String epInstanceID)
                              throws JahiaException

Removes an entry point instance from the persistance system.

Specified by:

removeEntryPointInstance in class ApplicationsManagerService

Parameters:

epInstanceID - int the unique identifier for the entry point instance

Throws:

JahiaException - thrown if there was an error communicating with the persistence system.

loadCustomPortletModes

public void loadCustomPortletModes(String supportedPortletModesConfigFileName)

load custom portlet mode

Parameters:

supportedPortletModesConfigFileName -

addCustomPortletModeBean

public void addCustomPortletModeBean(CustomPortletMode customPortletMode)

Add custom portlet modes

Parameters:

customPortletMode -

getSupportedPortletModes

public List<javax.portlet.PortletMode> getSupportedPortletModes()

Get supported portlet modes

Specified by:

getSupportedPortletModes in class ApplicationsManagerService

Returns:

loadCustomWindowStates

public void loadCustomWindowStates(String supportedWindowStatesConfigFileName)

Load custom window states

Parameters:

supportedWindowStatesConfigFileName -

addCustomWindowState

public void addCustomWindowState(CustomWindowState customWindowState)

Add custom window state

Parameters:

customWindowState -

getSupportedWindowStates

public List<javax.portlet.WindowState> getSupportedWindowStates()

Get supported window states

Specified by:

getSupportedWindowStates in class ApplicationsManagerService

Returns:

registerListeners

public void registerListeners()