org.ligoj.app.resource.plugin

Class PluginResource

java.lang.Object

org.ligoj.app.resource.plugin.PluginResource

@Path(value="/plugin")
 @Component
 @Produces(value="application/json")
public class PluginResource
extends Object

Manage plug-in life-cycle.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.ligoj.bootstrap.core.dao.csv.CsvForJpa	csvForJpa
protected javax.persistence.EntityManager	em

Constructor Summary

Constructors

Constructor and Description
PluginResource()

Method Summary

Modifier and Type	Method and Description
protected void	configurePluginEntities(org.ligoj.app.api.FeaturePlugin plugin, List<Class<?>> csvEntities) Insert the configuration entities of the plug-in.
protected void	configurePluginEntity(Stream<URL> csv, Class<?> entityClass, String pluginLocation)
protected void	configurePluginInstall(org.ligoj.app.api.FeaturePlugin plugin) Configure the new plug-in in this order : The required entities for the plug-in are persisted.
protected void	configurePluginUpdate(org.ligoj.app.api.FeaturePlugin plugin, Plugin entity) Configure the updated plug-in in this order : The required entities for the plug-in are persisted.
protected PluginType	determinePluginType(org.ligoj.app.api.ServicePlugin plugin) Determine the plug-in type and check it regarding the contact and the convention.
List<PluginVo>	findAll() Return all plug-ins with details.
protected String	getLastModifiedTime(org.ligoj.app.api.FeaturePlugin plugin) Returns a plug-in's last modified time.
protected org.ligoj.app.model.Node	getParentNode(String key) Return the parent node from a key.
protected PluginsClassLoader	getPluginClassLoader()
protected URL	getPluginLocation(org.ligoj.app.api.FeaturePlugin plugin)
protected String	getVersion(org.ligoj.app.api.FeaturePlugin plugin) Return a fail-safe computed version of the given FeaturePlugin
void	install(String artifact) Install the last available version of given plug-in from the remote server.
void	install(String artifact, String version) Install the specific version of given plug-in from the remote server.
protected org.ligoj.app.model.Node	newNode(org.ligoj.app.api.ServicePlugin service) Build a new Node from the given plug-in instance using the naming convention to link the parent.
void	refreshPlugins(org.springframework.context.event.ContextRefreshedEvent event) Handle the newly installed plug-ins implementing FeaturePlugin, and that's includes ServicePlugin.
void	remove(String artifact) Remove all versions the specified plug-in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

csvForJpa

@Autowired
protected org.ligoj.bootstrap.core.dao.csv.CsvForJpa csvForJpa

em

@Autowired
protected javax.persistence.EntityManager em

Constructor Detail

PluginResource

public PluginResource()

Method Detail

findAll

@GET
public List<PluginVo> findAll()

Return all plug-ins with details.

Returns:

All plug-ins with details.

install

@POST
 @Path(value="{artifact:[\\w-]+}")
public void install(@PathParam(value="artifact")
                                                               String artifact)

Install the last available version of given plug-in from the remote server.

Parameters:

artifact - The Maven artifact identifier and also corresponding to the plug-in simple name.

remove

@DELETE
 @Path(value="{artifact:[\\w-]+}")
public void remove(@PathParam(value="artifact")
                                                                String artifact)
                                                         throws IOException

Remove all versions the specified plug-in.

Parameters:

artifact - The Maven artifact identifier and also corresponding to the plug-in simple name.

Throws:

IOException

install

@POST
 @Path(value="{artifact:[\\w-]+}/{version:[\\w-]+}")
public void install(@PathParam(value="artifact")
                                                                                 String artifact,
                                                                                 @PathParam(value="version")
                                                                                 String version)

Install the specific version of given plug-in from the remote server. The previous version is not deleted. The downloaded version will be used only if it is a most recent version than the locally ones.

Parameters:

artifact - The Maven artifact identifier and also corresponding to the plug-in simple name.

version - The vrsion to install.

getPluginClassLoader

protected PluginsClassLoader getPluginClassLoader()

refreshPlugins

@EventListener
public void refreshPlugins(org.springframework.context.event.ContextRefreshedEvent event)

Handle the newly installed plug-ins implementing FeaturePlugin, and that's includes ServicePlugin. Note the plug-ins are installed in a natural order based on their key's name to ensure the parents plug-ins are configured first.
Note the transactional behavior of this process : if one plug-in failed to be configured, then the entire process is cancelled. The previously and the not processed discovered plug-ins are not configured.

Parameters:

event - The Spring event.

getLastModifiedTime

protected String getLastModifiedTime(org.ligoj.app.api.FeaturePlugin plugin)
                              throws IOException,
                                     URISyntaxException

Returns a plug-in's last modified time.

Parameters:

plugin - The plug-in class. Will be used to find the related container archive or class file.

Returns:

a String representing the time the file was last modified, or a default time stamp to indicate the time of last modification is not supported by the file system

Throws:

URISyntaxException - if an I/O error occurs

IOException - if an I/O error occurs

SecurityException - In the case of the default provider, and a security manager is installed, its checkRead method denies read access to the file.

configurePluginUpdate

protected void configurePluginUpdate(org.ligoj.app.api.FeaturePlugin plugin,
                                     Plugin entity)

Configure the updated plug-in in this order :

• The required entities for the plug-in are persisted. These entities are discovered from FeaturePlugin.getInstalledEntities() and related CSV files are load in the data base.
• The entity Plugin is updated to reflect the new version.

Parameters:

plugin - The newly discovered plug-in.

configurePluginInstall

protected void configurePluginInstall(org.ligoj.app.api.FeaturePlugin plugin)

Configure the new plug-in in this order :

• The required entities for the plug-in are persisted. These entities are discovered from FeaturePlugin.getInstalledEntities() and related CSV files are load in the data base. Note that there is at least one Node records added and related to the plug-in key.
• A new Plugin is inserted to maintain the validated plug-in and version

Parameters:

plugin - The newly discovered plug-in.

determinePluginType

protected PluginType determinePluginType(org.ligoj.app.api.ServicePlugin plugin)

Determine the plug-in type and check it regarding the contact and the convention.

Parameters:

plugin - The plug-in resource.

Returns:

The checked PluginType

configurePluginEntities

protected void configurePluginEntities(org.ligoj.app.api.FeaturePlugin plugin,
                                       List<Class<?>> csvEntities)
                                throws IOException

Insert the configuration entities of the plug-in.

Parameters:

plugin - The related plug-in

installedEntities - The managed entities where CSV data need to be persisted with this plug-in.

Throws:

IOException - When the CSV management failed.

getPluginLocation

protected URL getPluginLocation(org.ligoj.app.api.FeaturePlugin plugin)

configurePluginEntity

protected void configurePluginEntity(Stream<URL> csv,
                                     Class<?> entityClass,
                                     String pluginLocation)
                              throws IOException

Throws:

IOException

newNode

protected org.ligoj.app.model.Node newNode(org.ligoj.app.api.ServicePlugin service)

Build a new Node from the given plug-in instance using the naming convention to link the parent.

getParentNode

protected org.ligoj.app.model.Node getParentNode(String key)

Return the parent node from a key. The node entity is retrieved from the data base without cache.

Parameters:

key - The plug-in key.

Returns:

the parent node entity or null when this the top most definition. Note if there is an expected parent by convention, and the parent is not found, an error will be raised.

getVersion

protected String getVersion(org.ligoj.app.api.FeaturePlugin plugin)

Return a fail-safe computed version of the given FeaturePlugin

Parameters:

plugin - The plug-in instance

Returns: