fr.paris.lutece.portal.service.plugin
Class PluginFile

java.lang.Object
  extended by fr.paris.lutece.portal.service.plugin.PluginFile

public class PluginFile
extends Object

This class is the plugin file element


Constructor Summary
PluginFile()
           
 
Method Summary
 void addAdminDashboardComponent(DashboardComponentEntry dashboardComponent)
          Add a DashboardComponentEntry to the plugin definition
 void addContentService(ContentServiceEntry entry)
          Add an Content Service to the plugin definition
 void addCssStyleSheet(String strStyleSheet)
          Add an CSS stylesheet to the plugin definition
 void addDaemon(DaemonEntry daemonEntry)
          Add a Daemon to the plugin definition
 void addDashboardComponent(DashboardComponentEntry entry)
          Add an Dashboard Component to the plugin definition
 void addFilter(FilterEntry entry)
          Add a filter to the plugin definition
 void addFreemarkerMacrosFile(String strFileName)
          Adds the file to freemarker autoinclude configuration
 void addInsertService(InsertService is)
          Add an Insert Service to the plugin definition
 void addJavascriptFile(String strJavascriptFile)
          Add an Javascript File to the plugin definition
 void addListener(HttpSessionListenerEntry entry)
          Add a listener to the plugin definition
 void addPageInclude(PageIncludeEntry entry)
          Add an Page Include to the plugin definition
 void addParameter(String strName, String strValue)
          Add a parameter to the plugin definition
 void addPortletType(PortletType portletType)
          Add a portlet type to the plugin definition
 void addRBACResourceType(RBACResourceTypeEntry entry)
          Add an RBAC Resource Type to the plugin definition
 void addRight(Right right)
          Add an AdminFeature Right to the plugin definition
 void addSearchIndexer(SearchIndexerEntry entry)
          Add a SearchIndexer to the plugin definition
 void addServlet(ServletEntry entry)
          Add a servlet to the plugin definition
 void addXPageApplication(XPageApplicationEntry application)
          Add an Application to the plugin definition
 List<DashboardComponentEntry> getAdminDashboardComponents()
          Returns all admin dashbaord compopents of the plugin
 List<ContentServiceEntry> getContentServices()
          Returns all Content Services of the plugin
 String getCopyright()
          Returns the Copyright of the plugin
 List<String> getCssStyleSheets()
          Returns all CSS Style Sheets of the plugin
 String getCssStylesheetsScope()
          Returns the Css Stylesheet Scope
 List<DaemonEntry> getDaemons()
          Returns all Daemons of the plugin
 List<DashboardComponentEntry> getDashboardComponents()
          Returns all Dashboard Component Services of the plugin
 String getDescription()
          Returns the description of the plugin
 String getDocumentationUrl()
          Returns the Documentation's URL of the plugin
 List<FilterEntry> getFilters()
          Returns filter list of the plugin
 List<String> getFreemarkerMacrosFiles()
          Gets the freemarker macros files.
 String getIconUrl()
          Returns the Icon's URL of the plugin
 List<InsertService> getInsertServices()
          Returns all Insert Services of the plugin
 List<String> getJavascriptFiles()
          Returns all Javascript File of the plugin
 String getJavascriptFilesScope()
          Returns the javascripts Scope
 List<HttpSessionListenerEntry> getListeners()
          Returns listener list of the plugin
 String getMaxCoreVersion()
          Returns the max core version compatibility for the plugin
 String getMinCoreVersion()
          Returns the min core version compatibility for the plugin
 String getName()
          Returns the name of the plugin
 List<PageIncludeEntry> getPageIncludes()
          Returns all Page Include Services of the plugin
 Map<String,String> getParams()
          Gets plugin parameters defined in the XML file
 String getPluginClass()
          Returns the main Class of the plugin
 List<PortletType> getPortletTypes()
          Returns the portlet types list of the plugin
 String getProvider()
          Returns the Provider of the plugin
 String getProviderUrl()
          Returns the Provider's URL of the plugin
 List<RBACResourceTypeEntry> getRBACResourceTypes()
          Returns all RBAC Resource Types of the plugin
 List<Right> getRights()
          Returns right list of the plugin
 String getSearchIndexerClass()
          Returns the SearchIndexer Class of the plugin
 List<SearchIndexerEntry> getSearchIndexers()
          Returns all Search Indexer of the plugin
 List<ServletEntry> getServlets()
          Returns servlet list of the plugin
 String getVersion()
          Returns the version of the plugin
 List<XPageApplicationEntry> getXPageApplications()
          Returns application list of the plugin
 boolean isDbPoolRequired()
          Returns if the plugin needs a database connection pool
 boolean isInstalled()
          Returns the installation status of the plugin
 void load(String strFilename)
          Load plugin data from the XML file using Jakarta Commons Digester
 void setCopyright(String strCopyright)
          Sets the copyright of the plugin to the specified string.
 void setCssStylesheetsScope(String strCssStylesheetScope)
          Sets the css stylesheets scope
 void setDescription(String strDescription)
          Sets the description of the plugin to the specified string.
 void setDocumentationUrl(String strDocumentationUrl)
          Sets the url of the Documentation of the plugin to the specified string.
 void setIconUrl(String strIconUrl)
          Sets the url of the icon of the plugin to the specified string.
 void setIsDbPoolRequired(boolean bDbPoolRequired)
          Sets the boolean which shows if a pool is required for the plugin
 void setIsInstalled(boolean bIsInstalled)
          Sets the boolean wich shows if the plugin is installed
 void setJavascriptFilesScope(String strJavascriptFilescope)
          Sets the javascripts scope
 void setMaxCoreVersion(String strMaxCoreVersion)
          Sets the the max core version compatibility for the plugin
 void setMinCoreVersion(String strMinCoreVersion)
          Sets the the min core version compatibility for the plugin
 void setName(String strName)
          Sets the name of the plugin to the specified string.
 void setPluginClass(String strPluginClass)
          Sets the class name of the plugin to the specified string.
 void setProvider(String strProvider)
          Sets the provider of the plugin to the specified string.
 void setProviderUrl(String strProviderUrl)
          Sets the provider url to the specified string.
 void setSearchIndexerClass(String strSearchIndexerClass)
          Sets the class service of plugin
 void setVersion(String strVersion)
          Sets the version of the plugin to the specified string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PluginFile

public PluginFile()
Method Detail

load

public void load(String strFilename)
          throws LuteceInitException
Load plugin data from the XML file using Jakarta Commons Digester

Parameters:
strFilename - The XML plugin filename
Throws:
LuteceInitException - If a problem occured during the loading

getName

public String getName()
Returns the name of the plugin

Returns:
the plugin name as a String

setName

public void setName(String strName)
Sets the name of the plugin to the specified string.

Parameters:
strName - The name of the plugin

getVersion

public String getVersion()
Returns the version of the plugin

Returns:
the plugin version as a String

setVersion

public void setVersion(String strVersion)
Sets the version of the plugin to the specified string.

Parameters:
strVersion - The version of the plugin

getDescription

public String getDescription()
Returns the description of the plugin

Returns:
the plugin description as a String

setDescription

public void setDescription(String strDescription)
Sets the description of the plugin to the specified string.

Parameters:
strDescription - The description

getProvider

public String getProvider()
Returns the Provider of the plugin

Returns:
the plugin Provider as a String

setProvider

public void setProvider(String strProvider)
Sets the provider of the plugin to the specified string.

Parameters:
strProvider - The provider

getProviderUrl

public String getProviderUrl()
Returns the Provider's URL of the plugin

Returns:
the plugin Provider's URL as a String

setProviderUrl

public void setProviderUrl(String strProviderUrl)
Sets the provider url to the specified string.

Parameters:
strProviderUrl - The url of the provider

getIconUrl

public String getIconUrl()
Returns the Icon's URL of the plugin

Returns:
the plugin Icon's URL as a String

setIconUrl

public void setIconUrl(String strIconUrl)
Sets the url of the icon of the plugin to the specified string.

Parameters:
strIconUrl - The url of the icon

getDocumentationUrl

public String getDocumentationUrl()
Returns the Documentation's URL of the plugin

Returns:
the plugin Documentation's URL as a String

setDocumentationUrl

public void setDocumentationUrl(String strDocumentationUrl)
Sets the url of the Documentation of the plugin to the specified string.

Parameters:
strDocumentationUrl - the url of the documentation

getCopyright

public String getCopyright()
Returns the Copyright of the plugin

Returns:
the plugin Copyright as a String

setCopyright

public void setCopyright(String strCopyright)
Sets the copyright of the plugin to the specified string.

Parameters:
strCopyright - The copyright

getPluginClass

public String getPluginClass()
Returns the main Class of the plugin

Returns:
the Class as a String

setPluginClass

public void setPluginClass(String strPluginClass)
Sets the class name of the plugin to the specified string.

Parameters:
strPluginClass - The name of the class

isInstalled

public boolean isInstalled()
Returns the installation status of the plugin

Returns:
the installation status as an int

setIsInstalled

public void setIsInstalled(boolean bIsInstalled)
Sets the boolean wich shows if the plugin is installed

Parameters:
bIsInstalled - The installed boolean

getMinCoreVersion

public String getMinCoreVersion()
Returns the min core version compatibility for the plugin

Returns:
the min core version as a String

setMinCoreVersion

public void setMinCoreVersion(String strMinCoreVersion)
Sets the the min core version compatibility for the plugin

Parameters:
strMinCoreVersion - The min core version

getMaxCoreVersion

public String getMaxCoreVersion()
Returns the max core version compatibility for the plugin

Returns:
the max core version as a String

setMaxCoreVersion

public void setMaxCoreVersion(String strMaxCoreVersion)
Sets the the max core version compatibility for the plugin

Parameters:
strMaxCoreVersion - The max core version

addCssStyleSheet

public void addCssStyleSheet(String strStyleSheet)
Add an CSS stylesheet to the plugin definition

Parameters:
strStyleSheet - The StyleSheet path

getCssStyleSheets

public List<String> getCssStyleSheets()
Returns all CSS Style Sheets of the plugin

Returns:
The list of CSS Style Sheets

addJavascriptFile

public void addJavascriptFile(String strJavascriptFile)
Add an Javascript File to the plugin definition

Parameters:
strJavascriptFile - The Javascript File path

getJavascriptFiles

public List<String> getJavascriptFiles()
Returns all Javascript File of the plugin

Returns:
The list of Javascript File

addFreemarkerMacrosFile

public void addFreemarkerMacrosFile(String strFileName)
Adds the file to freemarker autoinclude configuration

Parameters:
strFileName - the file

getFreemarkerMacrosFiles

public List<String> getFreemarkerMacrosFiles()
Gets the freemarker macros files.

Returns:
the freemarker macros files

addRight

public void addRight(Right right)
Add an AdminFeature Right to the plugin definition

Parameters:
right - The Right to Add

getRights

public List<Right> getRights()
Returns right list of the plugin

Returns:
the list of rights

addXPageApplication

public void addXPageApplication(XPageApplicationEntry application)
Add an Application to the plugin definition

Parameters:
application - The application to Add

getXPageApplications

public List<XPageApplicationEntry> getXPageApplications()
Returns application list of the plugin

Returns:
the list of applications

addFilter

public void addFilter(FilterEntry entry)
Add a filter to the plugin definition

Parameters:
entry - The filter entry

getFilters

public List<FilterEntry> getFilters()
Returns filter list of the plugin

Returns:
the list of filters

addServlet

public void addServlet(ServletEntry entry)
Add a servlet to the plugin definition

Parameters:
entry - The servlet entry

getServlets

public List<ServletEntry> getServlets()
Returns servlet list of the plugin

Returns:
the list of servlets

addListener

public void addListener(HttpSessionListenerEntry entry)
Add a listener to the plugin definition

Parameters:
entry - The listener entry

getListeners

public List<HttpSessionListenerEntry> getListeners()
Returns listener list of the plugin

Returns:
the list of listeners

addPortletType

public void addPortletType(PortletType portletType)
Add a portlet type to the plugin definition

Parameters:
portletType - a portlet type to the plugin definition

getPortletTypes

public List<PortletType> getPortletTypes()
Returns the portlet types list of the plugin

Returns:
the portlet types list

addContentService

public void addContentService(ContentServiceEntry entry)
Add an Content Service to the plugin definition

Parameters:
entry - The entry

getContentServices

public List<ContentServiceEntry> getContentServices()
Returns all Content Services of the plugin

Returns:
The list of Content Services

addInsertService

public void addInsertService(InsertService is)
Add an Insert Service to the plugin definition

Parameters:
is - The Insert Service

getInsertServices

public List<InsertService> getInsertServices()
Returns all Insert Services of the plugin

Returns:
The list of Insert Services

addSearchIndexer

public void addSearchIndexer(SearchIndexerEntry entry)
Add a SearchIndexer to the plugin definition

Parameters:
entry - The Search Indexer Entry

getSearchIndexers

public List<SearchIndexerEntry> getSearchIndexers()
Returns all Search Indexer of the plugin

Returns:
The list of Search Indexers

addPageInclude

public void addPageInclude(PageIncludeEntry entry)
Add an Page Include to the plugin definition

Parameters:
entry - The Page Include Entry

getPageIncludes

public List<PageIncludeEntry> getPageIncludes()
Returns all Page Include Services of the plugin

Returns:
The list of Page Include Services

addDashboardComponent

public void addDashboardComponent(DashboardComponentEntry entry)
Add an Dashboard Component to the plugin definition

Parameters:
entry - The Dashboard Component Entry

getDashboardComponents

public List<DashboardComponentEntry> getDashboardComponents()
Returns all Dashboard Component Services of the plugin

Returns:
The list of Dashboard Component Services

addAdminDashboardComponent

public void addAdminDashboardComponent(DashboardComponentEntry dashboardComponent)
Add a DashboardComponentEntry to the plugin definition

Parameters:
dashboardComponent - the admin dashboard component

getAdminDashboardComponents

public List<DashboardComponentEntry> getAdminDashboardComponents()
Returns all admin dashbaord compopents of the plugin

Returns:
the list of admin dashbaord components

addRBACResourceType

public void addRBACResourceType(RBACResourceTypeEntry entry)
Add an RBAC Resource Type to the plugin definition

Parameters:
entry - The RBACResourceType

getRBACResourceTypes

public List<RBACResourceTypeEntry> getRBACResourceTypes()
Returns all RBAC Resource Types of the plugin

Returns:
The list of RBACResourceType

addDaemon

public void addDaemon(DaemonEntry daemonEntry)
Add a Daemon to the plugin definition

Parameters:
daemonEntry - The daemon entry to add

getDaemons

public List<DaemonEntry> getDaemons()
Returns all Daemons of the plugin

Returns:
The list of Daemons

isDbPoolRequired

public boolean isDbPoolRequired()
Returns if the plugin needs a database connection pool

Returns:
true if the plugin needs a database connection pool, otherwise false

setIsDbPoolRequired

public void setIsDbPoolRequired(boolean bDbPoolRequired)
Sets the boolean which shows if a pool is required for the plugin

Parameters:
bDbPoolRequired - The required boolean

getParams

public Map<String,String> getParams()
Gets plugin parameters defined in the XML file

Returns:
The hashtable of the parameters

addParameter

public void addParameter(String strName,
                         String strValue)
Add a parameter to the plugin definition

Parameters:
strName - The parameter name
strValue - The parameter value

getSearchIndexerClass

public String getSearchIndexerClass()
Returns the SearchIndexer Class of the plugin

Returns:
the Class as a String
Since:
2.0.0

setSearchIndexerClass

public void setSearchIndexerClass(String strSearchIndexerClass)
Sets the class service of plugin

Parameters:
strSearchIndexerClass - The Class name
Since:
2.0.0

getCssStylesheetsScope

public String getCssStylesheetsScope()
Returns the Css Stylesheet Scope

Returns:
the scope
Since:
3.0.0

setCssStylesheetsScope

public void setCssStylesheetsScope(String strCssStylesheetScope)
Sets the css stylesheets scope

Parameters:
strCssStylesheetScope - The scope
Since:
3.0.0

getJavascriptFilesScope

public String getJavascriptFilesScope()
Returns the javascripts Scope

Returns:
the scope
Since:
3.0.0

setJavascriptFilesScope

public void setJavascriptFilesScope(String strJavascriptFilescope)
Sets the javascripts scope

Parameters:
strJavascriptFilescope - The scope
Since:
3.0.0


Copyright © 2014 Mairie de Paris. All Rights Reserved.