Package org.ametys.core.source

Class StaticOptionalSourceFallback

java.lang.Object

org.ametys.core.source.StaticOptionalSourceFallback

All Implemented Interfaces:

OptionalSourceFallback, PluginAware, Component, Configurable

public class StaticOptionalSourceFallback
extends Object
implements OptionalSourceFallback, Component, Configurable, PluginAware

A configurable static fallback for optional sources

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	StaticOptionalSourceFallback.Fallbacks	A fallback static configuration

Constructor Summary

Constructors

Constructor	Description
StaticOptionalSourceFallback()

Method Summary

Modifier and Type	Method	Description
static String	applyFallbacks(String uri, StaticOptionalSourceFallback.Fallbacks fallbacks)	Apply the given fallbacks to an uri
void	configure(Configuration configuration)
static StaticOptionalSourceFallback.Fallbacks	configureFallbacks(Configuration configuration, String baseUri)	Configure fallbacks based upon a static xml configuration
String	fallback(String uri)	Fallback to a default value if the uri is not supported
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 java.lang.Object

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

Constructor Details

StaticOptionalSourceFallback

public StaticOptionalSourceFallback()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

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

configureFallbacks

public static StaticOptionalSourceFallback.Fallbacks configureFallbacks(Configuration configuration,
 String baseUri)
                                                                 throws ConfigurationException

Configure fallbacks based upon a static xml configuration

Parameters:

configuration - The configuration

baseUri - The uri of the configuration. For example, if the configuration is in a plugin, should be the root of the plugin

Returns:

The fallbacks configured

Throws:

ConfigurationException - If the configuration has issues

fallback

public String fallback(String uri)

Description copied from interface: OptionalSourceFallback

Fallback to a default value if the uri is not supported

Specified by:

fallback in interface OptionalSourceFallback

Parameters:

uri - The uri that is not supported

Returns:

The fallback url if any or null otherwise

applyFallbacks

public static String applyFallbacks(String uri,
 StaticOptionalSourceFallback.Fallbacks fallbacks)

Apply the given fallbacks to an uri

Parameters:

uri - The uri to consider

fallbacks - The fallbacks to applu

Returns:

The fallback or null if no one apply