org.ametys.web.service

Class StaticService

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.service.StaticService

All Implemented Interfaces:

LogEnabled, PluginAware, Service, Disposable, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

FilteredContentsService, FilteredPagesService, LinkDirectoryService, SearchService, SitemapService, SyndicationService

public class StaticService
extends AbstractLogEnabled
implements Service, Contextualizable, Configurable, PluginAware, Serviceable, Disposable

Class representing a business service.
A service is identified by an id and a Cocoon-URL.
This URL corresponds to a pipeline called by a page template.
URL must be relative to the sitemap of the plugin containing the service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	StaticService.ServiceParameterOrRepeaterParser
private static class	StaticService.ServiceParameterParser

Field Summary

Fields

Modifier and Type	Field and Description
private I18nizableText	_category
protected Context	_context The context.
private List<ClientSideElement.ScriptFile>	_cssFiles
private I18nizableText	_description
private ThreadSafeComponentManager<Enumerator>	_enumeratorManager
protected String	_featureName The feature name
private List<ServiceParameterGroup>	_groups
private String	_iconDecorator
private String	_iconGlyph
private String	_id
private boolean	_isCacheable
private boolean	_isPrivate
private I18nizableText	_label
private String	_largeIcon
protected ServiceManager	_manager The service manager
private String	_mediumIcon
private Map<String,ServiceParameterOrRepeater>	_parameters
private List<String>	_parametersToIndex
protected ClientSideElement.Script	_paramsScript The script configured
protected String	_pluginName The plugin name
private String	_right The right needed to create an instance of this service, blank or null if no right is needed.
private String	_smallIcon
private String	_url
private ThreadSafeComponentManager<Validator>	_validatorManager

Constructor Summary

Constructors

Constructor and Description
StaticService()

Method Summary

Modifier and Type	Method and Description
protected String	_configureClass(Configuration configuration) Configure the js class name
protected List<ClientSideElement.ScriptFile>	_configureImports(Configuration configuration) Configure the import part
protected ClientSideElement.Script	_configureScript(Configuration configuration) Configure the script
private String	_configureThumbnail(Configuration valueConf, String defaultImage)
protected I18nizableText	_parseI18nizableText(Configuration config, String name) Parse an i18n text.
void	configure(Configuration configuration)
protected void	configureIndexation(Configuration configuration) Configure the indexation process. This class only allow to index the value of some parameters (not repeaters).
protected void	configureParameterGroup(ServiceParameterGroup group, Configuration configuration, StaticService.ServiceParameterOrRepeaterParser serviceParameterParser) Configure the service parameters.
protected void	configureParameters(Configuration configuration, StaticService.ServiceParameterOrRepeaterParser serviceParameterParser) Configure the service parameters.
void	contextualize(Context context)
void	dispose()
I18nizableText	getCategory() Retrieves the category of the service.
List<ClientSideElement.ScriptFile>	getCSSFiles() Returns the list of CSS files needed to correctly display the service's in BO, such as the service's icon
I18nizableText	getDescription() Retrieves the description of the service.
String	getIconDecorator() Retrieves the CSS class to use for decorator above the main icon
String	getIconGlyph() Retrieves the CSS class to use for glyph icon
String	getId() Returns the service's id.
I18nizableText	getLabel() Retrieves the label of the service.
String	getLargeIcon() Retrieves the URL of the icon without the context path.
String	getMediumIcon() Retrieves the URL of the icon without the context path.
List<ServiceParameterGroup>	getParameterGroups() Returns the service parameter groups.
Map<String,ServiceParameterOrRepeater>	getParameters() Returns the service's parameters.
ClientSideElement.Script	getParametersScript() This method return the script that will be used to display parameters field.
String	getPluginName() Returns the plugin's name.
String	getRight() Get the right needed to create an instance of this service.
String	getSmallIcon() Retrieves the URL of the icon without the context path.
String	getURL() Returns the service's Cocoon-URL.
void	index(ZoneItem zoneItem, SolrInputDocument document) Fill the index with service data. This method is called during the containing page indexation process.
boolean	isCacheable(Page currentPage, ZoneItem zoneItem) Returns true if the result of this service may be cached, depending on the ZoneItem containing an instance of this service.
boolean	isPrivate() Get whether the service is private, i.e.
void	service(ServiceManager smanager)
void	setPluginInfo(String pluginName, String featureName, String id) Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

_pluginName

protected String _pluginName

The plugin name

_featureName

protected String _featureName

The feature name

_manager

protected ServiceManager _manager

The service manager

_context

protected Context _context

The context.

_paramsScript

protected ClientSideElement.Script _paramsScript

The script configured

_id

private String _id

_label

private I18nizableText _label

_description

private I18nizableText _description

_category

private I18nizableText _category

_iconGlyph

private String _iconGlyph

_iconDecorator

private String _iconDecorator

_smallIcon

private String _smallIcon

_mediumIcon

private String _mediumIcon

_largeIcon

private String _largeIcon

_cssFiles

private List<ClientSideElement.ScriptFile> _cssFiles

_isCacheable

private boolean _isCacheable

_isPrivate

private boolean _isPrivate

_right

private String _right

The right needed to create an instance of this service, blank or null if no right is needed.

_url

private String _url

_parameters

private Map<String,ServiceParameterOrRepeater> _parameters

_groups

private List<ServiceParameterGroup> _groups

_parametersToIndex

private List<String> _parametersToIndex

_validatorManager

private ThreadSafeComponentManager<Validator> _validatorManager

_enumeratorManager

private ThreadSafeComponentManager<Enumerator> _enumeratorManager

Constructor Detail

StaticService

public StaticService()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

dispose

public void dispose()

Specified by:

dispose in interface Disposable

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

configureParameters

protected void configureParameters(Configuration configuration,
                                   StaticService.ServiceParameterOrRepeaterParser serviceParameterParser)
                            throws ConfigurationException

Configure the service parameters.

Parameters:

configuration - the service configuration.

serviceParameterParser - the parser.

Throws:

ConfigurationException - if an error occurs.

configureIndexation

protected void configureIndexation(Configuration configuration)
                            throws ConfigurationException

Configure the indexation process.
This class only allow to index the value of some parameters (not repeaters).

Parameters:

configuration - the indexation configuration.

Throws:

ConfigurationException - if an error occurs.

configureParameterGroup

protected void configureParameterGroup(ServiceParameterGroup group,
                                       Configuration configuration,
                                       StaticService.ServiceParameterOrRepeaterParser serviceParameterParser)
                                throws ConfigurationException

Configure the service parameters.

Parameters:

group - the group to put the params in.

configuration - the service configuration.

serviceParameterParser - the parser.

Throws:

ConfigurationException - if an error occurs.

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getPluginName

public String getPluginName()

Description copied from interface: Service

Returns the plugin's name.

Specified by:

getPluginName in interface Service

Returns:

the plugin's name.

getId

public String getId()

Description copied from interface: Service

Returns the service's id.

Specified by:

getId in interface Service

Returns:

the service's id.

isCacheable

public boolean isCacheable(Page currentPage,
                           ZoneItem zoneItem)

Description copied from interface: Service

Returns true if the result of this service may be cached, depending on the ZoneItem containing an instance of this service.

Specified by:

isCacheable in interface Service

Parameters:

currentPage - the current Page containing the service.

zoneItem - the ZoneItem containing an instance of this service.
N.B: The ZoneItem can belong to a page that is not the current page, when it is inherited.

Returns:

true if the result of this service may be cached.

getLabel

public I18nizableText getLabel()

Description copied from interface: Service

Retrieves the label of the service.

Specified by:

getLabel in interface Service

Returns:

the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: Service

Retrieves the description of the service.

Specified by:

getDescription in interface Service

Returns:

the description.

getCategory

public I18nizableText getCategory()

Description copied from interface: Service

Retrieves the category of the service.

Specified by:

getCategory in interface Service

Returns:

the category.

getIconGlyph

public String getIconGlyph()

Description copied from interface: Service

Retrieves the CSS class to use for glyph icon

Specified by:

getIconGlyph in interface Service

Returns:

the glyph name.

getIconDecorator

public String getIconDecorator()

Description copied from interface: Service

Retrieves the CSS class to use for decorator above the main icon

Specified by:

getIconDecorator in interface Service

Returns:

the glyph name.

getSmallIcon

public String getSmallIcon()

Description copied from interface: Service

Retrieves the URL of the icon without the context path.

Specified by:

getSmallIcon in interface Service

Returns:

the icon URL for the small image 16x16.

getMediumIcon

public String getMediumIcon()

Description copied from interface: Service

Retrieves the URL of the icon without the context path.

Specified by:

getMediumIcon in interface Service

Returns:

the icon URL for the medium image 32x32.

getLargeIcon

public String getLargeIcon()

Description copied from interface: Service

Retrieves the URL of the icon without the context path.

Specified by:

getLargeIcon in interface Service

Returns:

the icon URL for the large image 48x48.

getURL

public String getURL()

Description copied from interface: Service

Returns the service's Cocoon-URL.

Specified by:

getURL in interface Service

Returns:

the service's Cocoon-URL.

getParameters

public Map<String,ServiceParameterOrRepeater> getParameters()

Description copied from interface: Service

Returns the service's parameters.

Specified by:

getParameters in interface Service

Returns:

the service's parameters.

getParameterGroups

public List<ServiceParameterGroup> getParameterGroups()

Description copied from interface: Service

Returns the service parameter groups.

Specified by:

getParameterGroups in interface Service

Returns:

the service parameter groups.

getParametersScript

public ClientSideElement.Script getParametersScript()

Description copied from interface: Service

This method return the script that will be used to display parameters field.

Specified by:

getParametersScript in interface Service

Returns:

The script. Can be null.

getCSSFiles

public List<ClientSideElement.ScriptFile> getCSSFiles()

Description copied from interface: Service

Returns the list of CSS files needed to correctly display the service's in BO, such as the service's icon

Specified by:

getCSSFiles in interface Service

Returns:

The list of CSS files needed. Must not be null.

isPrivate

public boolean isPrivate()

Description copied from interface: Service

Get whether the service is private, i.e. should not be created by the regular service interface.

Specified by:

isPrivate in interface Service

Returns:

true if the service is private, false if it is public.

getRight

public String getRight()

Description copied from interface: Service

Get the right needed to create an instance of this service.

Specified by:

getRight in interface Service

Returns:

the right needed to create an instance of this service. If null is returned, no right is needed.

index

public void index(ZoneItem zoneItem,
                  SolrInputDocument document)

Description copied from interface: Service

Fill the index with service data.
This method is called during the containing page indexation process.

Specified by:

index in interface Service

Parameters:

zoneItem - the ZoneItem containing an instance of this service.

document - the solr document for the containing Page.

_parseI18nizableText

protected I18nizableText _parseI18nizableText(Configuration config,
                                              String name)

Parse an i18n text.

Parameters:

config - the configuration to use.

name - the child name.

Returns:

the i18n text.

_configureThumbnail

private String _configureThumbnail(Configuration valueConf,
                                   String defaultImage)

_configureScript

protected ClientSideElement.Script _configureScript(Configuration configuration)
                                             throws ConfigurationException

Configure the script

Parameters:

configuration - the global configuration

Returns:

The script created

Throws:

ConfigurationException - if configuration is invalid

_configureClass

protected String _configureClass(Configuration configuration)
                          throws ConfigurationException

Configure the js class name

Parameters:

configuration - The configuration on action tag

Returns:

The js class name

Throws:

ConfigurationException - If an error occurs

_configureImports

protected List<ClientSideElement.ScriptFile> _configureImports(Configuration configuration)
                                                        throws ConfigurationException

Configure the import part

Parameters:

configuration - The imports configuration

Returns:

The set of the complete url of imported file

Throws:

ConfigurationException - If an error occurs