Package org.craftercms.studio.impl.v2.service.marketplace

Class MarketplaceServiceImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.marketplace.MarketplaceServiceImpl

All Implemented Interfaces:

MarketplaceService

public class MarketplaceServiceImpl
extends Object
implements MarketplaceService

Default implementation of MarketplaceService that proxies all request to the configured Marketplace

Since:

3.1.2

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected final MarketplaceServiceInternal	marketplaceServiceInternal

Constructor Summary

Constructors

Constructor	Description
MarketplaceServiceImpl(MarketplaceServiceInternal marketplaceServiceInternal)

Method Summary

Modifier and Type	Method	Description
void	copyPlugin(String siteId, String path, Map<String,String> parameters)	Copy a plugin in a site
void	createSite(CreateSiteRequest request)	Creates a site using the given blueprint
List<PluginRecord>	getInstalledPlugins(String siteId)	Returns a list of the plugins currently installed in the given site
org.apache.commons.configuration2.HierarchicalConfiguration<?>	getPluginConfiguration(String siteId, String pluginId)	Load the configuration for a given plugin as an object
String	getPluginConfigurationAsString(String siteId, String pluginId)	Load the configuration for a given plugin as a string
List<String>	getPluginUsage(String siteId, String pluginId)	List dependant items for a plugin
void	installPlugin(String siteId, String pluginId, org.craftercms.commons.plugin.model.Version pluginVersion, Map<String,String> parameters)	Install a plugin in a site
void	removePlugin(String siteId, String pluginId, boolean force)	Removes a plugin from a site
@Valid Map<String,Object>	searchPlugins(String type, String keywords, boolean showIncompatible, long offset, long limit)	Performs a search for all available plugins that match the given filters
void	writePluginConfiguration(String siteId, String pluginId, String content)	Writes the configuration for a given plugin

Methods inherited from class java.lang.Object

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

Field Details

marketplaceServiceInternal

protected final MarketplaceServiceInternal marketplaceServiceInternal

Constructor Details

MarketplaceServiceImpl

@ConstructorProperties("marketplaceServiceInternal")
public MarketplaceServiceImpl(MarketplaceServiceInternal marketplaceServiceInternal)

Method Details

searchPlugins

@Valid
public @Valid Map<String,Object> searchPlugins(String type,
 String keywords,
 boolean showIncompatible,
 long offset,
 long limit)
                                        throws MarketplaceException

Description copied from interface: MarketplaceService

Performs a search for all available plugins that match the given filters

Specified by:

searchPlugins in interface MarketplaceService

Parameters:

type - the type of plugins to search

keywords - the keywords to filter plugins

showIncompatible - indicates if incompatible plugins should be returned

offset - the offset for pagination

limit - the limit for pagination

Returns:

the result from the Marketplace

Throws:

MarketplaceException - if there is any error performing the search

createSite

public void createSite(CreateSiteRequest request)
                throws RemoteRepositoryNotFoundException,
InvalidRemoteRepositoryException,
InvalidRemoteUrlException,
ServiceLayerException,
InvalidRemoteRepositoryCredentialsException

Description copied from interface: MarketplaceService

Creates a site using the given blueprint

Specified by:

createSite in interface MarketplaceService

Parameters:

request - the site information

Throws:

RemoteRepositoryNotFoundException - if there is an error with the remote repository

InvalidRemoteRepositoryException - if there is an error with the remote repository

InvalidRemoteUrlException - if there is an error with the remote repository

ServiceLayerException - if there is any unexpected error

InvalidRemoteRepositoryCredentialsException - if there is any error with the credentials

getInstalledPlugins

public List<PluginRecord> getInstalledPlugins(String siteId)
                                       throws MarketplaceException

Description copied from interface: MarketplaceService

Returns a list of the plugins currently installed in the given site

Specified by:

getInstalledPlugins in interface MarketplaceService

Parameters:

siteId - the id of the site

Returns:

the list of plugins

Throws:

MarketplaceException - if there is any error reading the plugin registry

installPlugin

public void installPlugin(String siteId,
 String pluginId,
 org.craftercms.commons.plugin.model.Version pluginVersion,
 Map<String,String> parameters)
                   throws MarketplaceException

Description copied from interface: MarketplaceService

Install a plugin in a site

Specified by:

installPlugin in interface MarketplaceService

Parameters:

siteId - the id of the site

pluginId - the id of the plugin

pluginVersion - the version of the plugin

parameters - the parameters for the plugin

Throws:

MarketplaceException - if there is any error installing the plugin

copyPlugin

@Valid
public void copyPlugin(String siteId,
 String path,
 Map<String,String> parameters)
                throws MarketplaceException

Description copied from interface: MarketplaceService

Copy a plugin in a site

Specified by:

copyPlugin in interface MarketplaceService

Parameters:

siteId - the id of the site

path - the path of the plugin folder

parameters - the parameters for the plugin

Throws:

MarketplaceException - if there is any error copying the plugin

removePlugin

public void removePlugin(String siteId,
 String pluginId,
 boolean force)
                  throws ServiceLayerException

Description copied from interface: MarketplaceService

Removes a plugin from a site

Specified by:

removePlugin in interface MarketplaceService

Parameters:

siteId - the id of the site

pluginId - the id of the plugin

force - indicates if the plugin should be removed even if there are dependant items

Throws:

ServiceLayerException

getPluginUsage

public List<String> getPluginUsage(String siteId,
 String pluginId)
                            throws ServiceLayerException

Description copied from interface: MarketplaceService

List dependant items for a plugin

Specified by:

getPluginUsage in interface MarketplaceService

Parameters:

siteId - the id of the site

pluginId - the id of the plugin

Throws:

ServiceLayerException - if there is any error getting the dependant items

getPluginConfiguration

public org.apache.commons.configuration2.HierarchicalConfiguration<?> getPluginConfiguration(String siteId,
 String pluginId)
                                                                                      throws ConfigurationException

Description copied from interface: MarketplaceService

Load the configuration for a given plugin as an object

Specified by:

getPluginConfiguration in interface MarketplaceService

Parameters:

siteId - the id of the site

pluginId - the id of the plugin

Returns:

the configuration object

Throws:

ConfigurationException - if there is any error loading the configuration

getPluginConfigurationAsString

public String getPluginConfigurationAsString(String siteId,
 String pluginId)
                                      throws ContentNotFoundException

Description copied from interface: MarketplaceService

Load the configuration for a given plugin as a string

Specified by:

getPluginConfigurationAsString in interface MarketplaceService

Parameters:

siteId - the id of the site

pluginId - the id of the plugin

Returns:

the configuration string

Throws:

ContentNotFoundException - if there is any issue reading the file from the repository

writePluginConfiguration

public void writePluginConfiguration(String siteId,
 String pluginId,
 String content)
                              throws UserNotFoundException,
ServiceLayerException

Description copied from interface: MarketplaceService

Writes the configuration for a given plugin

Specified by:

writePluginConfiguration in interface MarketplaceService

Parameters:

siteId - the id of the site

pluginId - the id of the plugin

content - the new configuration

Throws:

UserNotFoundException - if there is any error authenticating the user

ServiceLayerException - if there is any error writing the configuration