org.jahia.services.applications

Class ApplicationsManagerService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.applications.ApplicationsManagerService

Direct Known Subclasses:

ApplicationsManagerServiceImpl

public abstract class ApplicationsManagerService
extends JahiaService

This Service is used to manage the jahia application definitions.

Version:

1.0

Author:

Khue ng

Field Summary

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
ApplicationsManagerService()

Method Summary

Modifier and Type	Method and Description
abstract boolean	addDefinition(ApplicationBean app) Add a new Application Definition.
abstract EntryPointInstance	createEntryPointInstance(EntryPointDefinition entryPointDefinition, String path) Creates an instance of an application entry point definition.
abstract List<EntryPointDefinition>	getAppEntryPointDefinitions(ApplicationBean appBean) Returns the entry point definitions corresponding to the application, or an empty list if there was a problem retrieving them.
abstract ApplicationBean	getApplication(String appID) return an Application Definition get directly from db
abstract ApplicationBean	getApplicationByContext(String context) return an Application Definition looking at its context.
abstract WebAppContext	getApplicationContext(ApplicationBean appBean) Get an ApplicationContext for a given context
abstract WebAppContext	getApplicationContext(String id) Get an ApplicationContext for a given application id
abstract List<ApplicationBean>	getApplications() return all application Definitions
abstract EntryPointInstance	getEntryPointInstance(JCRPortletNode node) Get the corresponding an entrypoint obejct
abstract EntryPointInstance	getEntryPointInstance(String epInstanceID, String workspaceName) Retrieves an EntryPointInstance object from the persistance system by using it's ID as a search key
abstract 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)
abstract List<javax.portlet.PortletMode>	getSupportedPortletModes() Returns the list of portlet modes that are supported by Jahia
abstract List<javax.portlet.WindowState>	getSupportedWindowStates() Returns the list of window states that are supported by Jahia
abstract void	removeApplication(String appID) Removes an application from the persistant storage area and from registry.
abstract void	removeEntryPointInstance(String epInstanceID) Removes an entry point instance from the persistance system.
abstract boolean	saveDefinition(ApplicationBean app) Save the Application Definition.
abstract boolean	setVisible(String appID, boolean visible) set an application Visible to users

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationsManagerService

public ApplicationsManagerService()

Method Detail

getApplication

public abstract ApplicationBean getApplication(String appID)
                                        throws JahiaException

return an Application Definition get directly from db

Parameters:

appID - the appID

Returns:

ApplicationBean, the Application Definition

Throws:

JahiaException

getApplicationByContext

public abstract ApplicationBean getApplicationByContext(String context)
                                                 throws JahiaException

return an Application Definition looking at its context.

Parameters:

context - , the context

Returns:

ApplicationBean, the Application Definition

Throws:

JahiaException

getApplications

public abstract List<ApplicationBean> getApplications()
                                               throws JahiaException

return all application Definitions

Returns:

Iterator an enumerations of ApplicationBean or null if empty

Throws:

JahiaException

setVisible

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

set an application Visible to users

Parameters:

appID - the application identification

visible - status

Returns:

false on error

Throws:

JahiaException

addDefinition

public abstract boolean addDefinition(ApplicationBean app)
                               throws JahiaException

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

Parameters:

app - the app Definition

Returns:

false on error

Throws:

JahiaException

saveDefinition

public abstract boolean saveDefinition(ApplicationBean app)
                                throws JahiaException

Save the Application Definition. both in ApplicationsRegistry and in Persistance

Parameters:

app - the app Definition

Returns:

false on error

Throws:

JahiaException

removeApplication

public abstract void removeApplication(String appID)
                                throws JahiaException

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

Parameters:

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

Throws:

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

getApplicationContext

public abstract WebAppContext getApplicationContext(String id)
                                             throws JahiaException

Get an ApplicationContext for a given application id

Parameters:

id - , the application id

Returns:

the application context , null if not found

Throws:

JahiaException

getApplicationContext

public abstract WebAppContext getApplicationContext(ApplicationBean appBean)
                                             throws JahiaException

Get an ApplicationContext for a given context

Parameters:

appBean - , the application bean

Returns:

the application context , null if not found

Throws:

JahiaException

createEntryPointInstance

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

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

Parameters:

entryPointDefinition - EntryPointDefinition

Throws:

JahiaException

getAppEntryPointDefinitions

public abstract List<EntryPointDefinition> getAppEntryPointDefinitions(ApplicationBean appBean)

Returns the entry point definitions corresponding to the application, or an empty list if there was a problem retrieving them.

Parameters:

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

Returns:

List a list of EntryPointDefinition objects, or an empty list if there was a problem retrieving the definitions.

getEntryPointInstance

public abstract 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

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 abstract EntryPointInstance getEntryPointInstance(JCRPortletNode node)
                                                  throws javax.jcr.RepositoryException

Get the corresponding an entrypoint obejct

Parameters:

node -

Returns:

Throws:

javax.jcr.RepositoryException

removeEntryPointInstance

public abstract void removeEntryPointInstance(String epInstanceID)
                                       throws JahiaException

Removes an entry point instance from the persistance system.

Parameters:

epInstanceID - int the unique identifier for the entry point instance

Throws:

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

getPortletWindow

public abstract 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

Throws:

JahiaException

getSupportedPortletModes

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

Returns the list of portlet modes that are supported by Jahia

Returns:

List a list of PortletModeBean instances that contains the portlet modes supported by Jahia

getSupportedWindowStates

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

Returns the list of window states that are supported by Jahia

Returns:

List a list of WindowStateBean instances that contain the window states supported by Jahia.