com.vaadin.flow.server.

java.lang.Object
- com.vaadin.flow.server.AppShellRegistry

All Implemented Interfaces:

Serializable
```
public class AppShellRegistry
extends Object
implements Serializable
```
The registry class for AppShellConfigurator annotations.

Since:

3.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AppShellRegistry.AppShellRegistryWrapper
A wrapper class for storing the AppShellRegistry instance in the servlet context.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ERROR_HEADER_NO_APP_CONFIGURATOR`
`static String`	`ERROR_HEADER_NO_SHELL`
`static String`	`ERROR_HEADER_OFFENDING_CONFIGURATOR`
`static String`	`ERROR_HEADER_OFFENDING_PWA`

Method Summary

All Methods
Modifier and Type	Method	Description
`static AppShellRegistry`	`getInstance(VaadinContext context)`	Returns the instance of the registry, or create a new one if it does not exist yet.
`Class<? extends AppShellConfigurator>`	`getShell()`	Returns the `AppShellConfigurator` class in the application.
`boolean`	`isShell(Class<?> clz)`	Deprecated. use `AppShellPredicate` to test whether the class is an `AppShellConfigurator` or not
`void`	`modifyIndexHtml(org.jsoup.nodes.Document document, VaadinRequest request)`	Modifies the `index.html` document based on the `AppShellConfigurator` annotations or `AppShellConfigurator.configurePage(AppShellSettings)` method.
`void`	`modifyPushConfiguration(PushConfiguration pushConfiguration)`	Modifies PushConfiguration instance based on the `Push` annotation on `AppShellConfigurator`.
`void`	`reset()`	Reset the registry configuration so as it's possible to perform a new configuration and validation.
`void`	`setShell(Class<? extends AppShellConfigurator> shell)`	Sets the `AppShellConfigurator` class in the application.
`String`	`toString()`
`String`	`validateClass(Class<?> clz)`	Checks whether a class have annotations that should only be in `AppShellConfigurator` classes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ERROR_HEADER_NO_SHELL
```
public static final String ERROR_HEADER_NO_SHELL
```
    See Also:
    
    Constant Field Values
  - ERROR_HEADER_OFFENDING_PWA
```
public static final String ERROR_HEADER_OFFENDING_PWA
```
    See Also:
    
    Constant Field Values
  - ERROR_HEADER_NO_APP_CONFIGURATOR
```
public static final String ERROR_HEADER_NO_APP_CONFIGURATOR
```
    See Also:
    
    Constant Field Values
  - ERROR_HEADER_OFFENDING_CONFIGURATOR
```
public static final String ERROR_HEADER_OFFENDING_CONFIGURATOR
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static AppShellRegistry getInstance(VaadinContext context)
```
    Returns the instance of the registry, or create a new one if it does not exist yet.
    
    Parameters:
    
    context - servlet context
    
    Returns:
    
    the registry instance
  - reset
```
public void reset()
```
    Reset the registry configuration so as it's possible to perform a new configuration and validation.
  - setShell
```
public void setShell(Class<? extends AppShellConfigurator> shell)
```
    Sets the AppShellConfigurator class in the application. Pass a null to reset the previous one when reusing the instance.
    
    Parameters:
    
    shell - the class implementing AppShellConfigurator.
  - getShell
```
public Class<? extends AppShellConfigurator> getShell()
```
    Returns the AppShellConfigurator class in the application.
    
    Returns:
    
    the app shell class
  - isShell
```
@Deprecated
public boolean isShell(Class<?> clz)
```
    Deprecated.
    use AppShellPredicate to test whether the class is an AppShellConfigurator or not
    
    Checks whether the class is extending AppShellConfigurator.
    
    Parameters:
    
    clz - the class to check.
    
    Returns:
    
    true if the class extends AppShellConfigurator.
  - validateClass
```
public String validateClass(Class<?> clz)
```
    Checks whether a class have annotations that should only be in AppShellConfigurator classes.
    
    Parameters:
    
    clz - the class to check.
    
    Returns:
    
    a string with the error lines if the class has offending annotations
  - modifyIndexHtml
```
public void modifyIndexHtml(org.jsoup.nodes.Document document,
                            VaadinRequest request)
```
    Modifies the `index.html` document based on the AppShellConfigurator annotations or AppShellConfigurator.configurePage(AppShellSettings) method.
    
    Parameters:
    
    document - a JSoup document for the index.html page
    
    request - The request to handle
  - modifyPushConfiguration
```
public void modifyPushConfiguration(PushConfiguration pushConfiguration)
```
    Modifies PushConfiguration instance based on the Push annotation on AppShellConfigurator.
    
    Parameters:
    
    pushConfiguration - the PushConfigration instance to modify
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

com.vaadin.flow.server.

Class AppShellRegistry

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ERROR_HEADER_NO_SHELL

ERROR_HEADER_OFFENDING_PWA

ERROR_HEADER_NO_APP_CONFIGURATOR

ERROR_HEADER_OFFENDING_CONFIGURATOR

Method Detail

getInstance

reset

setShell

getShell

isShell

validateClass

modifyIndexHtml

modifyPushConfiguration

toString