org.ametys.core.ui.ribbonconfiguration

Class RibbonConfigurationSource

java.lang.Object

org.ametys.core.ui.ribbonconfiguration.RibbonConfigurationSource

public class RibbonConfigurationSource
extends Object

A ribbon configuration source and related data

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Long	_lastModified
(package private) Source	_source
(package private) String	_uri

Constructor Summary

Constructors

Constructor and Description
RibbonConfigurationSource(String uri, Source source, Map<String,Object> returnedParameters) Constructor

Method Summary

Modifier and Type	Method and Description
static RibbonConfigurationSource	createFromUri(String uri, SourceResolver resolver) Create a new ribbon configuration source
Configuration	getConfiguration() build the configuration from the source
Long	getLastModified() Get the last modified date
Source	getSource() Get the source
String	getUri() Get the ribbon configuration URI

Methods inherited from class java.lang.Object

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

Field Detail

_source

Source _source

_uri

String _uri

_lastModified

Long _lastModified

Constructor Detail

RibbonConfigurationSource

public RibbonConfigurationSource(String uri,
                                 Source source,
                                 Map<String,Object> returnedParameters)

Constructor

Parameters:

uri - The source uri

source - The source

returnedParameters - The resolve parameters for additional data

Method Detail

createFromUri

public static RibbonConfigurationSource createFromUri(String uri,
                                                      SourceResolver resolver)
                                               throws IOException

Create a new ribbon configuration source

Parameters:

uri - The uri

resolver - The source resolver

Returns:

the ribbon configuration source

Throws:

IOException - If an error occurred when resolving the URI

getSource

public Source getSource()

Get the source

Returns:

The source

getUri

public String getUri()

Get the ribbon configuration URI

Returns:

The uri

getLastModified

public Long getLastModified()

Get the last modified date

Returns:

The last modified date

getConfiguration

public Configuration getConfiguration()
                               throws ConfigurationException,
                                      SAXException,
                                      IOException

build the configuration from the source

Returns:

The configuration

Throws:

ConfigurationException - If an error occurred

SAXException - If an error occurred

IOException - If an error occurred