|
||||||||||
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 |
addFreemarkerMacrosFile(String strMacroFileName)
Adds a that file that will be autoincluded in freemarker templates |
void |
addJavascriptFile(String strJavascriptFile)
Add an Javascript File to the plugin definition |
int |
compareTo(Plugin plugin)
Implementation of the Comparable interface. |
List<XPageApplicationEntry> |
getApplications()
Returns the list of XPage Applications of the plugin |
PluginConnectionService |
getConnectionService()
Returns a Connection Service associated to the plugin |
ContentService |
getContentService()
|
List<ContentServiceEntry> |
getContentServices()
Returns the list of Content services of the plugin |
String |
getCopyright()
Returns the Copyright of the plugin |
List<String> |
getCssStyleSheets()
Returns all CSS Style Sheets of the plugin |
List<DaemonEntry> |
getDaemons()
Returns The daemons list of the plugin. |
String |
getDbPoolName()
Gets the current database connection pool associated to the plugin |
String |
getDescription()
Returns the description of the plugin |
String |
getDocumentationUrl()
Returns the Documentation's URL of the plugin |
List<String> |
getFreeMarkerMacrosFiles()
Gets the free marker macros files. |
String |
getIconUrl()
Returns the Icon's URL of the plugin |
List<InsertService> |
getInsertServices()
Returns the list of insert services of the plugin |
List<String> |
getJavascriptFiles()
Returns all Javascript File 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 |
Map<String,String> |
getParams()
Gets plugin's parameters |
String |
getParamValue(String strParamName)
Gets a parameter value for a given parameter name |
List<PortletType> |
getPortletTypes()
Returns the list of portlet type of the plugin |
String |
getProvider()
Returns the Provider of the plugin |
String |
getProviderUrl()
Returns the Provider's URL of the plugin |
List<Right> |
getRights()
Returns the list of portlet type of the plugin |
String |
getServiceClass()
Returns the main Class of the plugin |
int |
getType()
Returns the type of the plugin |
String |
getVersion()
Returns the version of the plugin |
Theme |
getXPageTheme(javax.servlet.http.HttpServletRequest request)
Returns the theme the plugin use for rendering a Xpage |
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(String strPoolName)
Initializes the plugin's ConnectionService |
void |
install()
Installs a Plugin |
boolean |
isCssStylesheetsScopePortal()
Give the scope of css stylesheets |
boolean |
isCssStylesheetsScopeXPage()
Give the scope of css stylesheets |
boolean |
isDbPoolRequired()
Returns if the plugin needs a database connection pool |
boolean |
isInstalled()
Returns the installation status of the plugin |
boolean |
isJavascriptFilesScopePortal()
Give the scope of javascripts |
boolean |
isJavascriptFilesScopeXPage()
Give the scope of javascripts |
protected void |
registerAdminDashboardComponents()
Register Admin Dashboard Components |
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 |
registerListeners()
Register listeners |
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 |
registerServlets()
Register Servlets |
protected void |
registerXPageApplications()
Register XPage applications |
void |
setConnectionService(PluginConnectionService connectionService)
Sets the connection service |
void |
setCopyright(String strCopyright)
Sets the copyright |
void |
setDescription(String strDescription)
Sets the description of the plugin |
void |
setDocumentationUrl(String strDocumentationUrl)
Sets the url of the plugin's Documentation |
void |
setIconUrl(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(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 |
void |
setParams(Map<String,String> mapParams)
Sets parameters values with an hashtable |
void |
setParamValue(String strParamName,
String strParamValue)
Sets a parameter value for a given parameter name |
void |
setPoolName(String strPoolName)
Updates a database connection pool associated to the plugin and stores it |
void |
setPortletTypes(List<PortletType> listPortletTypes)
Sets the list of portlet type |
void |
setProvider(String strProvider)
Sets the provider name |
void |
setProviderUrl(String strProviderUrl)
Sets the provider url |
void |
setRights(List<Right> listRights)
Sets plugin rights list |
void |
setServiceClass(String strPluginClass)
Sets the class service of plugin |
void |
setStatus(boolean bStatus)
Modify the plugin status |
void |
setVersion(String strVersion)
Sets the version plugin name |
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(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 List<DaemonEntry> getDaemons()
protected void update()
public void setStatus(boolean bStatus)
bStatus
- true installed, false uninstalledpublic void updatePoolName(String strPoolName)
strPoolName
- the name of the poolpublic void setPoolName(String strPoolName)
strPoolName
- The name of the poolpublic 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 registerServlets() throws LuteceInitException
LuteceInitException
- If an error occursprotected void registerListeners() 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 registerAdminDashboardComponents() 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 List<InsertService> getInsertServices()
public List<ContentServiceEntry> getContentServices()
public List<XPageApplicationEntry> getApplications()
public List<PortletType> getPortletTypes()
public void setPortletTypes(List<PortletType> listPortletTypes)
listPortletTypes
- The portlet type listpublic List<Right> getRights()
public void setRights(List<Right> listRights)
listRights
- The rights listpublic String getName()
public void setName(String strName)
strName
- The plugin namepublic String getVersion()
public void setVersion(String strVersion)
strVersion
- The versionpublic String getDescription()
public void setDescription(String strDescription)
strDescription
- The descriptionpublic String getProvider()
public void setProvider(String strProvider)
strProvider
- The provider namepublic String getProviderUrl()
public void setProviderUrl(String strProviderUrl)
strProviderUrl
- the name of the providerpublic String getIconUrl()
public void setIconUrl(String strIconUrl)
strIconUrl
- The url of iconpublic String getDocumentationUrl()
public void setDocumentationUrl(String strDocumentationUrl)
strDocumentationUrl
- The documentation Urlpublic String getCopyright()
public void setCopyright(String strCopyright)
strCopyright
- The copyrightpublic String getServiceClass()
public void setServiceClass(String strPluginClass)
strPluginClass
- The plugin classpublic boolean isInstalled()
public void setIsInstalled(boolean bIsInstalled)
bIsInstalled
- The installed booleanpublic String getMinCoreVersion()
public void setMinCoreVersion(String strMinCoreVersion)
strMinCoreVersion
- The min core versionpublic String getMaxCoreVersion()
public void setMaxCoreVersion(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(String strPoolName)
strPoolName
- The pool namepublic Map<String,String> getParams()
public String getParamValue(String strParamName)
strParamName
- The name of the parameter
public void setParams(Map<String,String> mapParams)
mapParams
- The parameter mappublic void setParamValue(String strParamName, String strParamValue)
strParamName
- The name of the parameterstrParamValue
- The value of the parameterpublic int compareTo(Plugin plugin)
compareTo
in interface Comparable<Plugin>
plugin
- A plugin Object
public List<String> getCssStyleSheets()
public Theme getXPageTheme(javax.servlet.http.HttpServletRequest request)
request
- The HttpServletRequest
public void addJavascriptFile(String strJavascriptFile)
strJavascriptFile
- The Javascript File pathpublic List<String> getJavascriptFiles()
public boolean isCssStylesheetsScopePortal()
public boolean isCssStylesheetsScopeXPage()
public boolean isJavascriptFilesScopePortal()
public boolean isJavascriptFilesScopeXPage()
public void addFreemarkerMacrosFile(String strMacroFileName)
strMacroFileName
- the file namepublic List<String> getFreeMarkerMacrosFiles()
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |