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 and Description
void	createSite(CreateSiteRequest request) Creates a site using the given blueprint
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

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

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