Package org.eclipse.jetty.ee10.webapp

Class Configurations

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Configuration>

org.eclipse.jetty.ee10.webapp.Configurations

All Implemented Interfaces:

Iterable<Configuration>, Collection<Configuration>, List<Configuration>, Dumpable

public class Configurations
extends AbstractList<Configuration>
implements Dumpable

An ordered list of Configuration instances.

The ordering of Configurations will initially be the order in which they are added. The sort() method can be used to apply a TopologicalSort to the ordering as defined by the Configuration.getDependencies() and Configuration.getDependents() methods. Instances that do not have ordering dependencies will maintain their add order, as will additions/insertions made after the the sort.

If an added Configuration returns a value for Configuration.replaces() then the added instance will replace any existing instance of that type or that has already replaced that type.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVER_DEFAULT_ATTR

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
Configurations()
Configurations(String... configurationClassNames)
Configurations(List<Configuration> configurations)
Configurations(Configuration... configurations)

Method Summary

Modifier and Type	Method	Description
void	add(String... configClass)
boolean	add(Configuration configuration)
void	add(Configuration... configurations)
void	clear()
boolean	configure(WebAppContext webapp)
String	dump()
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
Configuration	get(int index)
<T> T	get(Class<? extends T> configClass)
List<Configuration>	getConfigurations()
<T> List<T>	getConfigurations(Class<? extends T> configClass)
static List<Configuration>	getKnown()
static Configurations	getServerDefault(Server server)	Get/Create the server default Configuration ClassList.
Iterator<Configuration>	iterator()
protected static Configuration	newConfiguration(String classname)
void	postConfigure(WebAppContext webapp)
void	preConfigure(WebAppContext webapp)
final void	remove(Class<? extends Configuration>... configClass)
void	remove(String... configClass)
void	remove(Configuration... configurations)
void	set(String... configClass)
void	set(Configuration... configurations)
static void	setKnown(String... classes)
static Configurations	setServerDefault(Server server)	Get/Set/Create the server default Configuration ClassList.
int	size()
void	sort()
static void	sort(List<Configuration> configurations)
Configuration[]	toArray()
String	toString()
String[]	toStringArray()

Methods inherited from class java.util.AbstractList

add, addAll, equals, hashCode, indexOf, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray

Field Details

SERVER_DEFAULT_ATTR

public static final String SERVER_DEFAULT_ATTR

See Also:

• Constant Field Values

Constructor Details

Configurations

public Configurations()

Configurations

public Configurations(List<Configuration> configurations)

Configurations

public Configurations(Configuration... configurations)

Configurations

public Configurations(String... configurationClassNames)

Method Details

getKnown

public static List<Configuration> getKnown()

setKnown

public static void setKnown(String... classes)

setServerDefault

public static Configurations setServerDefault(Server server)

Get/Set/Create the server default Configuration ClassList.

Get the class list from: a Server bean; or the attribute (which can either be a ClassList instance or an String[] of class names); or a new instance with default configuration classes.

This method also adds the obtained ClassList instance as a dependent bean on the server and clears the attribute

Parameters:

server - The server the default is for

Returns:

the server default ClassList instance of the configuration classes for this server. Changes to this list will change the server default instance.

getServerDefault

public static Configurations getServerDefault(Server server)

Get/Create the server default Configuration ClassList.

Get the class list from: a Server bean; or the attribute (which can either be a ClassList instance or an String[] of class names); or a new instance with default configuration classes.

Parameters:

server - The server the default is for

Returns:

A copy of the server default ClassList instance of the configuration classes for this server. Changes to the returned list will not change the server default.

newConfiguration

protected static Configuration newConfiguration(String classname)

add

public boolean add(Configuration configuration)

Specified by:

add in interface Collection<Configuration>

Specified by:

add in interface List<Configuration>

Overrides:

add in class AbstractList<Configuration>

add

public void add(Configuration... configurations)

add

public void add(@Name("configClass")
 String... configClass)

get

public <T> T get(Class<? extends T> configClass)

getConfigurations

public <T> List<T> getConfigurations(Class<? extends T> configClass)

clear

public void clear()

Specified by:

clear in interface Collection<Configuration>

Specified by:

clear in interface List<Configuration>

Overrides:

clear in class AbstractList<Configuration>

set

public void set(Configuration... configurations)

set

public void set(@Name("configClass")
 String... configClass)

remove

public void remove(Configuration... configurations)

remove

@SafeVarargs
public final void remove(Class<? extends Configuration>... configClass)

remove

public void remove(@Name("configClass")
 String... configClass)

size

public int size()

Specified by:

size in interface Collection<Configuration>

Specified by:

size in interface List<Configuration>

Specified by:

size in class AbstractCollection<Configuration>

toArray

public Configuration[] toArray()

Specified by:

toArray in interface Collection<Configuration>

Specified by:

toArray in interface List<Configuration>

Overrides:

toArray in class AbstractCollection<Configuration>

toStringArray

public String[] toStringArray()

sort

public void sort()

sort

public static void sort(List<Configuration> configurations)

getConfigurations

public List<Configuration> getConfigurations()

get

public Configuration get(int index)

Specified by:

get in interface List<Configuration>

Specified by:

get in class AbstractList<Configuration>

iterator

public Iterator<Configuration> iterator()

Specified by:

iterator in interface Collection<Configuration>

Specified by:

iterator in interface Iterable<Configuration>

Specified by:

iterator in interface List<Configuration>

Overrides:

iterator in class AbstractList<Configuration>

toString

public String toString()

Overrides:

toString in class AbstractCollection<Configuration>

preConfigure

public void preConfigure(WebAppContext webapp)
                  throws Exception

Throws:

Exception

configure

public boolean configure(WebAppContext webapp)
                  throws Exception

Parameters:

webapp - The webapp to configure

Returns:

false if a Configuration.abort(WebAppContext) returns true, true otherwise

Throws:

Exception - Thrown by Configuration.configure(WebAppContext)

postConfigure

public void postConfigure(WebAppContext webapp)
                   throws Exception

Throws:

Exception

dump

public String dump()

Specified by:

dump in interface Dumpable

dump

public void dump(Appendable out,
 String indent)
          throws IOException

Description copied from interface: Dumpable

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Specified by:

dump in interface Dumpable

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable