|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.paris.lutece.portal.service.plugin.PluginFile
public class PluginFile
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(java.lang.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 |
addInsertService(InsertService is)
Add an Insert Service to the plugin definition |
void |
addJavascriptFile(java.lang.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(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 |
addServlet(ServletEntry entry)
Add a servlet to the plugin definition |
void |
addXPageApplication(XPageApplicationEntry application)
Add an Application to the plugin definition |
java.util.List<DashboardComponentEntry> |
getAdminDashboardComponents()
Returns all admin dashbaord compopents of the plugin |
java.util.List<ContentServiceEntry> |
getContentServices()
Returns all Content Services of the plugin |
java.lang.String |
getCopyright()
Returns the Copyright of the plugin |
java.util.List<java.lang.String> |
getCssStyleSheets()
Returns all CSS Style Sheets of the plugin |
java.lang.String |
getCssStylesheetsScope()
Returns the Css Stylesheet Scope |
java.util.List<DaemonEntry> |
getDaemons()
Returns all Daemons of the plugin |
java.util.List<DashboardComponentEntry> |
getDashboardComponents()
Returns all Dashboard Component Services of the plugin |
java.lang.String |
getDescription()
Returns the description of the plugin |
java.lang.String |
getDocumentationUrl()
Returns the Documentation's URL of the plugin |
java.util.List<FilterEntry> |
getFilters()
Returns filter list 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.util.List<java.lang.String> |
getJavascriptFiles()
Returns all Javascript File of the plugin |
java.lang.String |
getJavascriptFilesScope()
Returns the javascripts Scope |
java.util.List<HttpSessionListenerEntry> |
getListeners()
Returns listener list of the plugin |
java.lang.String |
getMaxCoreVersion()
Returns the max core version compatibility for the plugin |
java.lang.String |
getMinCoreVersion()
Returns the min core version compatibility for the plugin |
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.util.List<ServletEntry> |
getServlets()
Returns servlet list 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 |
setCssStylesheetsScope(java.lang.String strCssStylesheetScope)
Sets the css stylesheets scope |
void |
setDescription(java.lang.String strDescription)
Sets the description of the plugin to the specified string. |
void |
setDocumentationUrl(java.lang.String strDocumentationUrl)
Sets the url of the Documentation 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 |
setJavascriptFilesScope(java.lang.String strJavascriptFilescope)
Sets the javascripts scope |
void |
setMaxCoreVersion(java.lang.String strMaxCoreVersion)
Sets the the max core version compatibility for the plugin |
void |
setMinCoreVersion(java.lang.String strMinCoreVersion)
Sets the the min core version compatibility for the plugin |
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 |
---|
public PluginFile()
Method Detail |
---|
public void load(java.lang.String strFilename) throws LuteceInitException
strFilename
- The XML plugin filename
LuteceInitException
- If a problem occured during the loadingpublic java.lang.String getName()
public void setName(java.lang.String strName)
strName
- The name of the pluginpublic java.lang.String getVersion()
public void setVersion(java.lang.String strVersion)
strVersion
- The version of the pluginpublic java.lang.String getDescription()
public void setDescription(java.lang.String strDescription)
strDescription
- The descriptionpublic java.lang.String getProvider()
public void setProvider(java.lang.String strProvider)
strProvider
- The providerpublic java.lang.String getProviderUrl()
public void setProviderUrl(java.lang.String strProviderUrl)
strProviderUrl
- The url of the providerpublic java.lang.String getIconUrl()
public void setIconUrl(java.lang.String strIconUrl)
strIconUrl
- The url of the iconpublic java.lang.String getDocumentationUrl()
public void setDocumentationUrl(java.lang.String strDocumentationUrl)
strDocumentationUrl
- the url of the documentationpublic java.lang.String getCopyright()
public void setCopyright(java.lang.String strCopyright)
strCopyright
- The copyrightpublic java.lang.String getPluginClass()
public void setPluginClass(java.lang.String strPluginClass)
strPluginClass
- The name of the classpublic boolean isInstalled()
public void setIsInstalled(boolean bIsInstalled)
bIsInstalled
- The installed booleanpublic java.lang.String getMinCoreVersion()
public void setMinCoreVersion(java.lang.String strMinCoreVersion)
strMinCoreVersion
- The min core versionpublic java.lang.String getMaxCoreVersion()
public void setMaxCoreVersion(java.lang.String strMaxCoreVersion)
strMaxCoreVersion
- The max core versionpublic void addCssStyleSheet(java.lang.String strStyleSheet)
strStyleSheet
- The StyleSheet pathpublic java.util.List<java.lang.String> getCssStyleSheets()
public void addJavascriptFile(java.lang.String strJavascriptFile)
strJavascriptFile
- The Javascript File pathpublic java.util.List<java.lang.String> getJavascriptFiles()
public void addRight(Right right)
right
- The Right to Addpublic java.util.List<Right> getRights()
public void addXPageApplication(XPageApplicationEntry application)
application
- The application to Addpublic java.util.List<XPageApplicationEntry> getXPageApplications()
public void addFilter(FilterEntry entry)
entry
- The filter entrypublic java.util.List<FilterEntry> getFilters()
public void addServlet(ServletEntry entry)
entry
- The servlet entrypublic java.util.List<ServletEntry> getServlets()
public void addListener(HttpSessionListenerEntry entry)
entry
- The listener entrypublic java.util.List<HttpSessionListenerEntry> getListeners()
public void addPortletType(PortletType portletType)
portletType
- a portlet type to the plugin definitionpublic java.util.List<PortletType> getPortletTypes()
public void addContentService(ContentServiceEntry entry)
entry
- The entrypublic java.util.List<ContentServiceEntry> getContentServices()
public void addInsertService(InsertService is)
is
- The Insert Servicepublic java.util.List<InsertService> getInsertServices()
public void addSearchIndexer(SearchIndexerEntry entry)
entry
- The Search Indexer Entrypublic java.util.List<SearchIndexerEntry> getSearchIndexers()
public void addPageInclude(PageIncludeEntry entry)
entry
- The Page Include Entrypublic java.util.List<PageIncludeEntry> getPageIncludes()
public void addDashboardComponent(DashboardComponentEntry entry)
entry
- The Dashboard Component Entrypublic java.util.List<DashboardComponentEntry> getDashboardComponents()
public void addAdminDashboardComponent(DashboardComponentEntry dashboardComponent)
DashboardComponentEntry
to the plugin definition
dashboardComponent
- the admin dashboard componentpublic java.util.List<DashboardComponentEntry> getAdminDashboardComponents()
public void addRBACResourceType(RBACResourceTypeEntry entry)
entry
- The RBACResourceTypepublic java.util.List<RBACResourceTypeEntry> getRBACResourceTypes()
public void addDaemon(DaemonEntry daemonEntry)
daemonEntry
- The daemon entry to addpublic java.util.List<DaemonEntry> getDaemons()
public boolean isDbPoolRequired()
public void setIsDbPoolRequired(boolean bDbPoolRequired)
bDbPoolRequired
- The required booleanpublic java.util.Map<java.lang.String,java.lang.String> getParams()
public void addParameter(java.lang.String strName, java.lang.String strValue)
strName
- The parameter namestrValue
- The parameter valuepublic java.lang.String getSearchIndexerClass()
public void setSearchIndexerClass(java.lang.String strSearchIndexerClass)
strSearchIndexerClass
- The Class namepublic java.lang.String getCssStylesheetsScope()
public void setCssStylesheetsScope(java.lang.String strCssStylesheetScope)
strCssStylesheetScope
- The scopepublic java.lang.String getJavascriptFilesScope()
public void setJavascriptFilesScope(java.lang.String strJavascriptFilescope)
strJavascriptFilescope
- The scope
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |