Modifier and Type	Class and Description
public static class	AbstractConfiguration.Builder

Access	Constructor and Description
protected	AbstractConfiguration(AbstractConfiguration.Builder builder)

Modifier and Type	Method and Description
public boolean	abort(WebAppContext context) Implements org.eclipse.jetty.ee10.webapp.Configuration.abort.
public void	configure(WebAppContext The context to configure context) Implements org.eclipse.jetty.ee10.webapp.Configuration.configure. Configure WebApp.
public void	deconfigure(WebAppContext The context to configure context) Implements org.eclipse.jetty.ee10.webapp.Configuration.deconfigure. DeConfigure WebApp.
public void	destroy(WebAppContext The context to configure context) Implements org.eclipse.jetty.ee10.webapp.Configuration.destroy. Destroy WebApp.
public Collection<String>	getDependencies() Overrides default org.eclipse.jetty.ee10.webapp.Configuration.getDependencies. Get known Configuration Dependencies.
public Collection<String>	getDependents() Overrides default org.eclipse.jetty.ee10.webapp.Configuration.getDependents. Get known Configuration Dependents.
public ClassMatcher	getServerClasses() Overrides default org.eclipse.jetty.ee10.webapp.Configuration.getServerClasses. Get the system classes associated with this Configuration.
public ClassMatcher	getSystemClasses() Overrides default org.eclipse.jetty.ee10.webapp.Configuration.getSystemClasses. Get the system classes associated with this Configuration.
public boolean	isEnabledByDefault() Implements org.eclipse.jetty.ee10.webapp.Configuration.isEnabledByDefault.
public void	postConfigure(WebAppContext The context to configure context) Implements org.eclipse.jetty.ee10.webapp.Configuration.postConfigure. Clear down after configuration.
public void	preConfigure(WebAppContext The context to configure context) Implements org.eclipse.jetty.ee10.webapp.Configuration.preConfigure. Set up for configuration.

_after	back to summary
private final List<String> _after

_before	back to summary
private final List<String> _before

_enabledByDefault	back to summary
private final boolean _enabledByDefault

_server	back to summary
private final ClassMatcher _server

_system	back to summary
private final ClassMatcher _system

AbstractConfiguration	back to summary
protected AbstractConfiguration(AbstractConfiguration.Builder builder)

Method Detail

abort	back to summary
public boolean abort(WebAppContext context) Implements org.eclipse.jetty.ee10.webapp.Configuration.abort. Returns:boolean Doc from org.eclipse.jetty.ee10.webapp.Configuration.abort. true if configuration should be aborted Annotations @Override

abort

back to summary

public boolean abort(WebAppContext context)

Implements org.eclipse.jetty.ee10.webapp.Configuration.abort.

Returns:boolean

Doc from org.eclipse.jetty.ee10.webapp.Configuration.abort.

true if configuration should be aborted

Annotations

@Override

configure back to summary

configure	back to summary
public void configure(WebAppContext context) throws Exception Implements org.eclipse.jetty.ee10.webapp.Configuration.configure. Doc from org.eclipse.jetty.ee10.webapp.Configuration.configure. Configure WebApp. Typically this step applies the discovered configuration resources to either the `WebAppContext` or the associated `MetaData`. Parameters context:WebAppContext The context to configure Annotations @Override Exceptions Exception: if unable to configure

public void configure(WebAppContext context) throws Exception

Implements org.eclipse.jetty.ee10.webapp.Configuration.configure.

Doc from org.eclipse.jetty.ee10.webapp.Configuration.configure.

Configure WebApp.

Typically this step applies the discovered configuration resources to either the WebAppContext or the associated MetaData.

Parameters

context:WebAppContext: The context to configure

Annotations

@Override

Exceptions

Exception:: if unable to configure

deconfigure	back to summary
public void deconfigure(WebAppContext context) throws Exception Implements org.eclipse.jetty.ee10.webapp.Configuration.deconfigure. Doc from org.eclipse.jetty.ee10.webapp.Configuration.deconfigure. DeConfigure WebApp. This method is called to undo all configuration done. This is called to allow the context to work correctly over a stop/start cycle Parameters context:WebAppContext The context to configure Annotations @Override Exceptions Exception: if unable to deconfigure

deconfigure

back to summary

public void deconfigure(WebAppContext context) throws Exception

Implements org.eclipse.jetty.ee10.webapp.Configuration.deconfigure.

Doc from org.eclipse.jetty.ee10.webapp.Configuration.deconfigure.

DeConfigure WebApp. This method is called to undo all configuration done. This is called to allow the context to work correctly over a stop/start cycle

Parameters

context:WebAppContext: The context to configure

Annotations

@Override

Exceptions

Exception:: if unable to deconfigure

destroy	back to summary
public void destroy(WebAppContext context) throws Exception Implements org.eclipse.jetty.ee10.webapp.Configuration.destroy. Doc from org.eclipse.jetty.ee10.webapp.Configuration.destroy. Destroy WebApp. This method is called to destroy a webappcontext. It is typically called when a context is removed from a server handler hierarchy by the deployer. Parameters context:WebAppContext The context to configure Annotations @Override Exceptions Exception: if unable to destroy

destroy

back to summary

public void destroy(WebAppContext context) throws Exception

Implements org.eclipse.jetty.ee10.webapp.Configuration.destroy.

Doc from org.eclipse.jetty.ee10.webapp.Configuration.destroy.

Destroy WebApp. This method is called to destroy a webappcontext. It is typically called when a context is removed from a server handler hierarchy by the deployer.

Parameters

context:WebAppContext: The context to configure

Annotations

@Override

Exceptions

Exception:: if unable to destroy

getDependencies back to summary

getDependencies	back to summary
public Collection<String> getDependencies() Overrides default org.eclipse.jetty.ee10.webapp.Configuration.getDependencies. Doc from org.eclipse.jetty.ee10.webapp.Configuration.getDependencies. Get known Configuration Dependencies. Returns:Collection<String> The names of Configurations that `TopologicalSort` must order before this configuration. Annotations @Override

public Collection<String> getDependencies()

Overrides default org.eclipse.jetty.ee10.webapp.Configuration.getDependencies.

Doc from org.eclipse.jetty.ee10.webapp.Configuration.getDependencies.

Get known Configuration Dependencies.

Returns:Collection<String>

The names of Configurations that TopologicalSort must order before this configuration.

Annotations

@Override

getDependents back to summary

getDependents	back to summary
public Collection<String> getDependents() Overrides default org.eclipse.jetty.ee10.webapp.Configuration.getDependents. Doc from org.eclipse.jetty.ee10.webapp.Configuration.getDependents. Get known Configuration Dependents. Returns:Collection<String> The names of Configurations that `TopologicalSort` must order after this configuration. Annotations @Override

public Collection<String> getDependents()

Overrides default org.eclipse.jetty.ee10.webapp.Configuration.getDependents.

Doc from org.eclipse.jetty.ee10.webapp.Configuration.getDependents.

Get known Configuration Dependents.

Returns:Collection<String>

The names of Configurations that TopologicalSort must order after this configuration.

Annotations

@Override

getServerClasses	back to summary
public ClassMatcher getServerClasses() Overrides default org.eclipse.jetty.ee10.webapp.Configuration.getServerClasses. Doc from org.eclipse.jetty.ee10.webapp.Configuration.getServerClasses. Get the system classes associated with this Configuration. Returns:ClassMatcher ClassMatcher of server classes. Annotations @Override

getServerClasses

back to summary

public ClassMatcher getServerClasses()

Overrides default org.eclipse.jetty.ee10.webapp.Configuration.getServerClasses.

Doc from org.eclipse.jetty.ee10.webapp.Configuration.getServerClasses.

Get the system classes associated with this Configuration.

Returns:ClassMatcher

ClassMatcher of server classes.

Annotations

@Override

getSystemClasses	back to summary
public ClassMatcher getSystemClasses() Overrides default org.eclipse.jetty.ee10.webapp.Configuration.getSystemClasses. Doc from org.eclipse.jetty.ee10.webapp.Configuration.getSystemClasses. Get the system classes associated with this Configuration. Returns:ClassMatcher ClassMatcher of system classes. Annotations @Override

getSystemClasses

back to summary

public ClassMatcher getSystemClasses()

Overrides default org.eclipse.jetty.ee10.webapp.Configuration.getSystemClasses.

Doc from org.eclipse.jetty.ee10.webapp.Configuration.getSystemClasses.

Get the system classes associated with this Configuration.

Returns:ClassMatcher

ClassMatcher of system classes.

Annotations

@Override

isEnabledByDefault	back to summary
public boolean isEnabledByDefault() Implements org.eclipse.jetty.ee10.webapp.Configuration.isEnabledByDefault. Returns:boolean Doc from org.eclipse.jetty.ee10.webapp.Configuration.isEnabledByDefault. true if configuration is enabled by default Annotations @Override

isEnabledByDefault

back to summary

public boolean isEnabledByDefault()

Implements org.eclipse.jetty.ee10.webapp.Configuration.isEnabledByDefault.

Returns:boolean

Doc from org.eclipse.jetty.ee10.webapp.Configuration.isEnabledByDefault.

true if configuration is enabled by default

Annotations

@Override

postConfigure	back to summary
public void postConfigure(WebAppContext context) throws Exception Implements org.eclipse.jetty.ee10.webapp.Configuration.postConfigure. Doc from org.eclipse.jetty.ee10.webapp.Configuration.postConfigure. Clear down after configuration. Parameters context:WebAppContext The context to configure Annotations @Override Exceptions Exception: if unable to post configure

postConfigure

back to summary

public void postConfigure(WebAppContext context) throws Exception

Implements org.eclipse.jetty.ee10.webapp.Configuration.postConfigure.

Doc from org.eclipse.jetty.ee10.webapp.Configuration.postConfigure.

Clear down after configuration.

Parameters

context:WebAppContext: The context to configure

Annotations

@Override

Exceptions

Exception:: if unable to post configure

preConfigure	back to summary
public void preConfigure(WebAppContext context) throws Exception Implements org.eclipse.jetty.ee10.webapp.Configuration.preConfigure. Doc from org.eclipse.jetty.ee10.webapp.Configuration.preConfigure. Set up for configuration. Typically this step discovers configuration resources. Calls to preConfigure may alter the Configurations configured on the WebAppContext, so long as configurations prior to this configuration are not altered. Parameters context:WebAppContext The context to configure Annotations @Override Exceptions Exception: if unable to pre configure

preConfigure

back to summary

public void preConfigure(WebAppContext context) throws Exception

Implements org.eclipse.jetty.ee10.webapp.Configuration.preConfigure.

Doc from org.eclipse.jetty.ee10.webapp.Configuration.preConfigure.

Set up for configuration.

Typically this step discovers configuration resources. Calls to preConfigure may alter the Configurations configured on the WebAppContext, so long as configurations prior to this configuration are not altered.

Parameters

context:WebAppContext: The context to configure

Annotations

@Override

Exceptions

Exception:: if unable to pre configure

org.eclipse.jetty.ee10.webapp back to summary

public Class AbstractConfiguration.Builder

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jetty.ee10.webapp.AbstractConfiguration.Builder

Field Summary

Modifier and Type	Field and Description
private final List<String>	_after
private final List<String>	_before
private boolean	_enabledByDefault
private final ClassMatcher	_server
private final ClassMatcher	_system

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public AbstractConfiguration.Builder	addDependencies(String... Classname or package name classes) Add configuration classes that come before this configuration
public final AbstractConfiguration.Builder	addDependencies(Class<? extends Configuration>... Classes classes) Add configuration classes that come before this configuration
public AbstractConfiguration.Builder	addDependents(String... Classname or package name classes) Add configuration classes that come after this configuration
public AbstractConfiguration.Builder	addDependents(Class<?>... Class classes) Add configuration classes that come after this configuration
public AbstractConfiguration.Builder	enabledByDefault(boolean enabledByDefault)
public AbstractConfiguration.Builder	expose(String... classname or package pattern classes) Expose classes to the web application by adding them as exclusions to the `WebAppConfiguration#getServerClasses()`
public AbstractConfiguration.Builder	hide(String... classname or package pattern classes) Hide classes from the web application by adding them to the `WebAppConfiguration#getServerClasses()`
public AbstractConfiguration.Builder	protect(String... classname or package pattern classes) Protect classes from modification by the web application by adding them to the `WebAppConfiguration#getSystemClasses()`
public AbstractConfiguration.Builder	protectAndExpose(String... classname or package pattern classes) Protect classes from modification by the web application by adding them to the `WebAppConfiguration#getSystemClasses()` and expose them to the web application by adding them as exclusions to the `WebAppConfiguration#getServerClasses()`

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_after	back to summary
private final List<String> _after

_before	back to summary
private final List<String> _before

_enabledByDefault	back to summary
private boolean _enabledByDefault

_server	back to summary
private final ClassMatcher _server

_system	back to summary
private final ClassMatcher _system

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

addDependencies	back to summary
public AbstractConfiguration.Builder addDependencies(String... classes) Add configuration classes that come before this configuration Parameters classes:String[] Classname or package name

addDependencies

back to summary

public AbstractConfiguration.Builder addDependencies(String... classes)

Add configuration classes that come before this configuration

Parameters

classes:String[]: Classname or package name

addDependencies	back to summary
public final AbstractConfiguration.Builder addDependencies(Class<? extends Configuration>... classes) Add configuration classes that come before this configuration Parameters classes:Class<? extends Configuration>[] Classes Annotations @SafeVarargs

addDependencies

back to summary

public final AbstractConfiguration.Builder addDependencies(Class<? extends Configuration>... classes)

Add configuration classes that come before this configuration

Parameters

classes:Class<? extends Configuration>[]: Classes

Annotations

@SafeVarargs

addDependents	back to summary
public AbstractConfiguration.Builder addDependents(String... classes) Add configuration classes that come after this configuration Parameters classes:String[] Classname or package name

addDependents

back to summary

public AbstractConfiguration.Builder addDependents(String... classes)

Add configuration classes that come after this configuration

Parameters

classes:String[]: Classname or package name

addDependents	back to summary
public AbstractConfiguration.Builder addDependents(Class<?>... classes) Add configuration classes that come after this configuration Parameters classes:Class<?>[] Class

addDependents

back to summary

public AbstractConfiguration.Builder addDependents(Class<?>... classes)

Add configuration classes that come after this configuration

Parameters

classes:Class<?>[]: Class

enabledByDefault	back to summary
public AbstractConfiguration.Builder enabledByDefault(boolean enabledByDefault)

expose back to summary

expose	back to summary
public AbstractConfiguration.Builder expose(String... classes) Expose classes to the web application by adding them as exclusions to the `WebAppConfiguration#getServerClasses()` Parameters classes:String[] classname or package pattern

public AbstractConfiguration.Builder expose(String... classes)

Expose classes to the web application by adding them as exclusions to the WebAppConfiguration#getServerClasses()

Parameters

classes:String[]: classname or package pattern

hide back to summary

hide	back to summary
public AbstractConfiguration.Builder hide(String... classes) Hide classes from the web application by adding them to the `WebAppConfiguration#getServerClasses()` Parameters classes:String[] classname or package pattern

public AbstractConfiguration.Builder hide(String... classes)

Hide classes from the web application by adding them to the WebAppConfiguration#getServerClasses()

Parameters

classes:String[]: classname or package pattern

protect back to summary

protect	back to summary
public AbstractConfiguration.Builder protect(String... classes) Protect classes from modification by the web application by adding them to the `WebAppConfiguration#getSystemClasses()` Parameters classes:String[] classname or package pattern

public AbstractConfiguration.Builder protect(String... classes)

Protect classes from modification by the web application by adding them to the WebAppConfiguration#getSystemClasses()

Parameters

classes:String[]: classname or package pattern

protectAndExpose back to summary

protectAndExpose	back to summary
public AbstractConfiguration.Builder protectAndExpose(String... classes) Protect classes from modification by the web application by adding them to the `WebAppConfiguration#getSystemClasses()` and expose them to the web application by adding them as exclusions to the `WebAppConfiguration#getServerClasses()` Parameters classes:String[] classname or package pattern

public AbstractConfiguration.Builder protectAndExpose(String... classes)

Protect classes from modification by the web application by adding them to the WebAppConfiguration#getSystemClasses() and expose them to the web application by adding them as exclusions to the WebAppConfiguration#getServerClasses()

Parameters

classes:String[]: classname or package pattern

public Class AbstractConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AbstractConfiguration.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail