com.mattunderscore.filter.contentnegotiation.variantsource

Interface VariantSource

All Known Subinterfaces:

ConfigurableVariantSource, InputStreamVariantSource, VariantSourceForFilter

All Known Implementing Classes:

BaseVariantXMLSource, CachedVariantSource, FilterVariantXMLSource

public interface VariantSource

A variant source is any object that provides variants to the content negotiation filter.

This may get variants from an XML configuration file, a database or any other source of information. This is intended to be more flexible than the deprecated NegotiationXMLParser. It reuses the the data structures returned by the NegotiationXMLParser.

Since:

0.2.0

Author:

Matt Champion

Method Summary

Modifier and Type	Method and Description
List<Variant>	getVariants() Get the variants from the variant source.

Method Detail

getVariants

List<Variant> getVariants()
                   throws VariantSourceException

Get the variants from the variant source. The variants are returned a list.

Returns:

A list of the variants defined by the variant source

Throws:

VariantSourceException - Thrown when unable to return the variants

VariantSourceConfigurationException - Thrown when the variant source is not configured

Since:

0.2.0