|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.paris.lutece.portal.service.plugin.Plugin
public abstract class Plugin
This class is the general plugin element
Field Summary | |
---|---|
static int |
PLUGIN_TYPE_APPLICATION
|
static int |
PLUGIN_TYPE_CONTENTSERVICE
|
static int |
PLUGIN_TYPE_DAEMON
|
static int |
PLUGIN_TYPE_FEATURE
|
static int |
PLUGIN_TYPE_INSERTSERVICE
|
static int |
PLUGIN_TYPE_PORTLET
|
Constructor Summary | |
---|---|
Plugin()
|
Method Summary | |
---|---|
void |
addJavascriptFile(java.lang.String strJavascriptFile)
Add an Javascript File to the plugin definition |
int |
compareTo(Plugin plugin)
Implementation of the Comparable interface. |
java.util.List<XPageApplicationEntry> |
getApplications()
Returns the list of XPage Applications of the plugin |
PluginConnectionService |
getConnectionService()
Returns a Connection Service associated to the plugin |
ContentService |
getContentService()
|
java.util.List<ContentServiceEntry> |
getContentServices()
Returns the list of 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.util.List<DaemonEntry> |
getDaemons()
Returns The daemons list of the plugin. |
java.lang.String |
getDbPoolName()
Gets the current database connection pool associated to 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.lang.String |
getIconUrl()
Returns the Icon's URL of the plugin |
java.util.List<InsertService> |
getInsertServices()
Returns the list of insert services of the plugin |
java.util.List<java.lang.String> |
getJavascriptFiles()
Returns all Javascript File 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.Map<java.lang.String,java.lang.String> |
getParams()
Gets plugin's parameters |
java.lang.String |
getParamValue(java.lang.String strParamName)
Gets a parameter value for a given parameter name |
java.util.List<PortletType> |
getPortletTypes()
Returns the list of portlet type 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<Right> |
getRights()
Returns the list of portlet type of the plugin |
java.lang.String |
getServiceClass()
Returns the main Class of the plugin |
int |
getType()
Returns the type of the plugin |
java.lang.String |
getVersion()
Returns the version of the plugin |
boolean |
hasDaemons()
Returns weither or not plugin has daemon. |
boolean |
hasPortlets()
Returns weither or not plugin has portlet. |
abstract void |
init()
Initializes the plugin at the first load |
void |
initConnectionService(java.lang.String strPoolName)
Initializes the plugin's ConnectionService |
void |
install()
Installs a Plugin |
boolean |
isDbPoolRequired()
Returns if the plugin needs a database connection pool |
boolean |
isInstalled()
Returns the installation status of the plugin |
protected void |
registerContentServices()
Register Content Services |
protected void |
registerDaemons()
Register Daemons |
protected void |
registerDashboardComponents()
Register Dashboard Components |
protected void |
registerFilters()
Register Filters |
protected void |
registerInsertServices()
Register Insert Services |
protected void |
registerPageIncludes()
Register Page Includes |
protected void |
registerPortlets()
Creates a new portlet in the portlets type set |
protected void |
registerRBACResourceTypes()
Register RBAC Resource Types |
protected void |
registerRights()
Creates a new right in the rights set |
protected void |
registerSearchIndexers()
Register Search Indexers |
protected void |
registerXPageApplications()
Register XPage applications |
void |
setConnectionService(PluginConnectionService connectionService)
Sets the connection service |
void |
setCopyright(java.lang.String strCopyright)
Sets the copyright |
void |
setDescription(java.lang.String strDescription)
Sets the description of the plugin |
void |
setDocumentationUrl(java.lang.String strDocumentationUrl)
Sets the url of the plugin's Documentation |
void |
setIconUrl(java.lang.String strIconUrl)
Sets the url of the plugin's icon |
void |
setIsDbPoolRequired(boolean bDbPoolRequired)
Sets the boolean which shows if a pool is required |
void |
setIsInstalled(boolean bIsInstalled)
Sets the boolean which shows if the plugin is installed |
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 |
void |
setParams(java.util.Map<java.lang.String,java.lang.String> mapParams)
Sets parameters values with an hashtable |
void |
setParamValue(java.lang.String strParamName,
java.lang.String strParamValue)
Sets a parameter value for a given parameter name |
void |
setPoolName(java.lang.String strPoolName)
Updates a database connection pool associated to the plugin and stores it |
void |
setPortletTypes(java.util.List<PortletType> listPortletTypes)
Sets the list of portlet type |
void |
setProvider(java.lang.String strProvider)
Sets the provider name |
void |
setProviderUrl(java.lang.String strProviderUrl)
Sets the provider url |
void |
setRights(java.util.List<Right> listRights)
Sets plugin rights list |
void |
setServiceClass(java.lang.String strPluginClass)
Sets the class service of plugin |
void |
setStatus(boolean bStatus)
Modify the plugin status |
void |
setVersion(java.lang.String strVersion)
Sets the version plugin name |
java.lang.String |
toString()
Useful for debugging |
void |
uninstall()
Uninstalls a Plugin |
protected void |
unregisterPortlets()
Remove a portlet from the portlets type set. |
protected void |
unregisterRights()
Remove a right from the rights set. |
protected void |
update()
Updates the plg file |
void |
updatePoolName(java.lang.String strPoolName)
Updates a database connection pool associated to the plugin and stores it |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int PLUGIN_TYPE_FEATURE
public static final int PLUGIN_TYPE_PORTLET
public static final int PLUGIN_TYPE_APPLICATION
public static final int PLUGIN_TYPE_INSERTSERVICE
public static final int PLUGIN_TYPE_CONTENTSERVICE
public static final int PLUGIN_TYPE_DAEMON
Constructor Detail |
---|
public Plugin()
Method Detail |
---|
public abstract void init()
public ContentService getContentService()
public boolean hasPortlets()
public boolean hasDaemons()
public java.util.List<DaemonEntry> getDaemons()
protected void update()
public void setStatus(boolean bStatus)
bStatus
- true installed, false uninstalledpublic void updatePoolName(java.lang.String strPoolName)
strPoolName
- the name of the poolpublic void setPoolName(java.lang.String strPoolName)
strPoolName
- The name of the poolpublic java.lang.String getDbPoolName()
protected void registerRights()
protected void unregisterRights()
protected void registerPortlets()
protected void unregisterPortlets()
protected void registerXPageApplications() throws LuteceInitException
LuteceInitException
- If an error occursprotected void registerFilters() throws LuteceInitException
LuteceInitException
- If an error occursprotected void registerContentServices() throws LuteceInitException
LuteceInitException
- If an error occursprotected void registerInsertServices() throws LuteceInitException
LuteceInitException
- If an error occursprotected void registerSearchIndexers() throws LuteceInitException
LuteceInitException
- If an error occursprotected void registerPageIncludes() throws LuteceInitException
LuteceInitException
- If an error occuredprotected void registerDashboardComponents() throws LuteceInitException
LuteceInitException
- If an error occuredprotected void registerRBACResourceTypes() throws LuteceInitException
LuteceInitException
- If an error occursprotected void registerDaemons() throws LuteceInitException
LuteceInitException
- If an error occurspublic void install()
public void uninstall()
public int getType()
public java.util.List<InsertService> getInsertServices()
public java.util.List<ContentServiceEntry> getContentServices()
public java.util.List<XPageApplicationEntry> getApplications()
public java.util.List<PortletType> getPortletTypes()
public void setPortletTypes(java.util.List<PortletType> listPortletTypes)
listPortletTypes
- The portlet type listpublic java.util.List<Right> getRights()
public void setRights(java.util.List<Right> listRights)
listRights
- The rights listpublic java.lang.String getName()
public void setName(java.lang.String strName)
strName
- The plugin namepublic java.lang.String getVersion()
public void setVersion(java.lang.String strVersion)
strVersion
- The versionpublic 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 provider namepublic java.lang.String getProviderUrl()
public void setProviderUrl(java.lang.String strProviderUrl)
strProviderUrl
- the name of the providerpublic java.lang.String getIconUrl()
public void setIconUrl(java.lang.String strIconUrl)
strIconUrl
- The url of iconpublic java.lang.String getDocumentationUrl()
public void setDocumentationUrl(java.lang.String strDocumentationUrl)
strDocumentationUrl
- The documentation Urlpublic java.lang.String getCopyright()
public void setCopyright(java.lang.String strCopyright)
strCopyright
- The copyrightpublic java.lang.String getServiceClass()
public void setServiceClass(java.lang.String strPluginClass)
strPluginClass
- The plugin 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 boolean isDbPoolRequired()
public void setIsDbPoolRequired(boolean bDbPoolRequired)
bDbPoolRequired
- The dbpool booleanpublic PluginConnectionService getConnectionService()
public void setConnectionService(PluginConnectionService connectionService)
connectionService
- The connection Service objectpublic void initConnectionService(java.lang.String strPoolName)
strPoolName
- The pool namepublic java.util.Map<java.lang.String,java.lang.String> getParams()
public java.lang.String getParamValue(java.lang.String strParamName)
strParamName
- The name of the parameter
public void setParams(java.util.Map<java.lang.String,java.lang.String> mapParams)
mapParams
- The parameter mappublic void setParamValue(java.lang.String strParamName, java.lang.String strParamValue)
strParamName
- The name of the parameterstrParamValue
- The value of the parameterpublic int compareTo(Plugin plugin)
compareTo
in interface java.lang.Comparable<Plugin>
plugin
- A plugin Object
public 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 java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |