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

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

public class PluginFile
extends java.lang.Object

This class is the plugin file element


Constructor Summary
PluginFile()
           
 
Method Summary
 void addContentService(ContentServiceEntry entry)
          Add an Content Service to the plugin definition
 void addDaemon(DaemonEntry daemonEntry)
          Add a Daemon to the plugin definition
 void addInsertService(InsertService is)
          Add an Insert Service to the plugin definition
 void addPageInclude(PageIncludeEntry entry)
          Add an Page Include to the plugin definition
 void addParameter(java.lang.String strName, java.lang.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 addXPageApplication(XPageApplicationEntry application)
          Add an Application to the plugin definition
 java.util.List<ContentServiceEntry> getContentServices()
          Returns all Content Services of the plugin
 java.lang.String getCopyright()
          Returns the Copyright of the plugin
 java.lang.String getCssStylesheet()
          Returns the CssStylesheet
 java.util.List<DaemonEntry> getDaemons()
          Returns all Daemons of the plugin
 java.lang.String getDescription()
          Returns the description of the plugin
 java.lang.String getIconUrl()
          Returns the Icon's URL of the plugin
 java.util.List<InsertService> getInsertServices()
          Returns all Insert Services of the plugin
 java.lang.String getJavascriptFile()
          Returns the JavascriptFile
 java.lang.String getName()
          Returns the name of the plugin
 java.util.List<PageIncludeEntry> getPageIncludes()
          Returns all Page Include Services of the plugin
 java.util.Map<java.lang.String,java.lang.String> getParams()
          Gets plugin parameters defined in the XML file
 java.lang.String getPluginClass()
          Returns the main Class of the plugin
 java.util.List<PortletType> getPortletTypes()
          Returns the portlet types list of the plugin
 java.lang.String getProvider()
          Returns the Provider of the plugin
 java.lang.String getProviderUrl()
          Returns the Provider's URL of the plugin
 java.util.List<RBACResourceTypeEntry> getRBACResourceTypes()
          Returns all RBAC Resource Types of the plugin
 java.util.List<Right> getRights()
          Returns right list of the plugin
 java.lang.String getSearchIndexerClass()
          Returns the SearchIndexer Class of the plugin
 java.util.List<SearchIndexerEntry> getSearchIndexers()
          Returns all Search Indexer of the plugin
 java.lang.String getVersion()
          Returns the version of the plugin
 java.util.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(java.lang.String strFilename)
          Load plugin data from the XML file using Jakarta Commons Digester
 void setCopyright(java.lang.String strCopyright)
          Sets the copyright of the plugin to the specified string.
 void setCssStylesheet(java.lang.String strCssStylesheet)
          Sets the CssStylesheet
 void setDescription(java.lang.String strDescription)
          Sets the description of the plugin to the specified string.
 void setIconUrl(java.lang.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 setJavascriptFile(java.lang.String strJavascriptFile)
          Sets the JavascriptFile
 void setName(java.lang.String strName)
          Sets the name of the plugin to the specified string.
 void setPluginClass(java.lang.String strPluginClass)
          Sets the class name of the plugin to the specified string.
 void setProvider(java.lang.String strProvider)
          Sets the provider of the plugin to the specified string.
 void setProviderUrl(java.lang.String strProviderUrl)
          Sets the provider url to the specified string.
 void setSearchIndexerClass(java.lang.String strSearchIndexerClass)
          Sets the class service of plugin
 void setVersion(java.lang.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(java.lang.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 java.lang.String getName()
Returns the name of the plugin

Returns:
the plugin name as a String

setName

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

Parameters:
strName - The name of the plugin

getVersion

public java.lang.String getVersion()
Returns the version of the plugin

Returns:
the plugin version as a String

setVersion

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

Parameters:
strVersion - The version of the plugin

getDescription

public java.lang.String getDescription()
Returns the description of the plugin

Returns:
the plugin description as a String

setDescription

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

Parameters:
strDescription - The description

getProvider

public java.lang.String getProvider()
Returns the Provider of the plugin

Returns:
the plugin Provider as a String

setProvider

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

Parameters:
strProvider - The provider

getProviderUrl

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

Returns:
the plugin Provider's URL as a String

setProviderUrl

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

Parameters:
strProviderUrl - The url of the provider

getIconUrl

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

Returns:
the plugin Icon's URL as a String

setIconUrl

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

Parameters:
strIconUrl - The url of the icon

getCopyright

public java.lang.String getCopyright()
Returns the Copyright of the plugin

Returns:
the plugin Copyright as a String

setCopyright

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

Parameters:
strCopyright - The copyright

getPluginClass

public java.lang.String getPluginClass()
Returns the main Class of the plugin

Returns:
the Class as a String

setPluginClass

public void setPluginClass(java.lang.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

addRight

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

Parameters:
right - The Right to Add

getRights

public java.util.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 java.util.List<XPageApplicationEntry> getXPageApplications()
Returns application list of the plugin

Returns:
the list of applications

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 java.util.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:
contentService - The Content Service

getContentServices

public java.util.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:
insertService - The Insert Service

getInsertServices

public java.util.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:
searchIndexer - The Search Indexer

getSearchIndexers

public java.util.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:
pie - The Page Include Entry

getPageIncludes

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

Returns:
The list of Page Include Services

addRBACResourceType

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

Parameters:
entry - The RBACResourceType

getRBACResourceTypes

public java.util.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 java.util.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 java.util.Map<java.lang.String,java.lang.String> getParams()
Gets plugin parameters defined in the XML file

Returns:
The hashtable of the parameters

addParameter

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

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

getCssStylesheet

public java.lang.String getCssStylesheet()
Returns the CssStylesheet

Returns:
The CssStylesheet
Since:
1.4.1

setCssStylesheet

public void setCssStylesheet(java.lang.String strCssStylesheet)
Sets the CssStylesheet

Parameters:
strCssStylesheet - The CssStylesheet
Since:
1.4.1

getJavascriptFile

public java.lang.String getJavascriptFile()
Returns the JavascriptFile

Returns:
The JavascriptFile
Since:
1.4.1

setJavascriptFile

public void setJavascriptFile(java.lang.String strJavascriptFile)
Sets the JavascriptFile

Parameters:
strJavascriptFile - The JavascriptFile
Since:
1.4.1

getSearchIndexerClass

public java.lang.String getSearchIndexerClass()
Returns the SearchIndexer Class of the plugin

Returns:
the Class as a String
Since:
2.0.0

setSearchIndexerClass

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

Parameters:
strSearchIndexerClass - The PageInclude Class name
Since:
2.0.0


Copyright © 2007 Mairie de Paris. All Rights Reserved.