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

Interface MarketplaceService

All Known Implementing Classes:

MarketplaceServiceImpl

public interface MarketplaceService

Provides access to all available Marketplace operations

Since:

3.1.2

Author:

joseross

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
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

Method Detail

searchPlugins

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

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

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

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

Creates a site using the given blueprint

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

List<PluginRecord> getInstalledPlugins(String siteId)
                                throws MarketplaceException

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

Parameters:

siteId - the id of the site

Returns:

the list of plugins

Throws:

MarketplaceException - if there is any error reading the plugin registry

installPlugin

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

Install a plugin in a site

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

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

Copy a plugin in a site

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

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

Removes a plugin from a site

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:

MarketplaceException - if there is any error removing the plugin

ServiceLayerException

getPluginUsage

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

List dependant items for a plugin

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

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

Load the configuration for a given plugin as an object

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

String getPluginConfigurationAsString(String siteId,
                                      String pluginId)
                               throws ContentNotFoundException

Load the configuration for a given plugin as a string

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

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

Writes the configuration for a given plugin

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