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

Class MarketplaceServiceInternalImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.marketplace.internal.MarketplaceServiceInternalImpl

All Implemented Interfaces:

MarketplaceServiceInternal, org.springframework.beans.factory.InitializingBean

public class MarketplaceServiceInternalImpl
extends Object
implements MarketplaceServiceInternal, org.springframework.beans.factory.InitializingBean

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

Since:

3.1.2

Author:

joseross

Field Summary

Fields

Modifier and Type	Field and Description
protected String	edition The current Crafter CMS edition, sent with all requests
protected org.springframework.http.HttpHeaders	httpHeaders The custom HTTP headers to sent with all requests
protected InstanceService	instanceService
protected com.fasterxml.jackson.databind.ObjectMapper	mapper
protected org.craftercms.commons.rest.RestTemplate	restTemplate
protected boolean	showPending Indicates if the search should include plugins pending of approval
protected SiteService	siteService
protected SitesServiceInternal	sitesServiceInternal
protected StudioConfiguration	studioConfiguration
protected String	url The Marketplace URL to use
protected String	version The current Crafter CMS version, sent with all requests

Fields inherited from interface org.craftercms.studio.api.v2.service.marketplace.internal.MarketplaceServiceInternal

HEADER_JAVA_VERSION, HEADER_OS_ARCH, HEADER_OS_NAME, HEADER_OS_VERSION, HEADER_STUDIO_BUILD, HEADER_STUDIO_ID, HEADER_STUDIO_VERSION

Constructor Summary

Constructors

Constructor and Description
MarketplaceServiceInternalImpl(InstanceService instanceService, SiteService siteService, SitesServiceInternal sitesServiceInternal, StudioConfiguration studioConfiguration)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	createSite(CreateSiteRequest request) Creates a site using the given blueprint
protected Map<String,Object>	getDescriptor(String id, org.craftercms.commons.plugin.model.Version version)
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	setShowPending(boolean showPending)
void	setUrl(String url)
protected void	validate()

Methods inherited from class java.lang.Object

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

Field Detail

instanceService

protected InstanceService instanceService

siteService

protected SiteService siteService

sitesServiceInternal

protected SitesServiceInternal sitesServiceInternal

studioConfiguration

protected StudioConfiguration studioConfiguration

restTemplate

protected org.craftercms.commons.rest.RestTemplate restTemplate

mapper

protected com.fasterxml.jackson.databind.ObjectMapper mapper

httpHeaders

protected org.springframework.http.HttpHeaders httpHeaders

The custom HTTP headers to sent with all requests

version

protected String version

The current Crafter CMS version, sent with all requests

edition

protected String edition

The current Crafter CMS edition, sent with all requests

url

protected String url

The Marketplace URL to use

showPending

protected boolean showPending

Indicates if the search should include plugins pending of approval

Constructor Detail

MarketplaceServiceInternalImpl

public MarketplaceServiceInternalImpl(InstanceService instanceService,
                                      SiteService siteService,
                                      SitesServiceInternal sitesServiceInternal,
                                      StudioConfiguration studioConfiguration)

Method Detail

setUrl

public void setUrl(String url)

setShowPending

public void setShowPending(boolean showPending)

afterPropertiesSet

public void afterPropertiesSet()
                        throws IOException

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

IOException

searchPlugins

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

Description copied from interface: MarketplaceServiceInternal

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

Specified by:

searchPlugins in interface MarketplaceServiceInternal

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

validate

protected void validate()
                 throws MarketplaceException

Throws:

MarketplaceException

getDescriptor

protected Map<String,Object> getDescriptor(String id,
                                           org.craftercms.commons.plugin.model.Version version)
                                    throws MarketplaceException,
                                           BlueprintNotFoundException

Throws:

MarketplaceException

BlueprintNotFoundException

createSite

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

Description copied from interface: MarketplaceServiceInternal

Creates a site using the given blueprint

Specified by:

createSite in interface MarketplaceServiceInternal

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