@NotThreadSafe public abstract static class HTTPModule.Abstract extends Object implements HTTPModule
HTTPModule.Abstract, HTTPModule.Context
Modifier and Type | Field and Description |
---|---|
static String |
MODULE_UUID_PROPERTY
The module UUID is needed when the module is a client of the
metadata server.
|
Constructor and Description |
---|
Abstract() |
Modifier and Type | Method and Description |
---|---|
protected abstract void |
addServlets(Map<String,String> servlets)
Adds the servlets to the servlets map.
|
void |
callbackForEventActions()
Requests a callback for event actions.
|
void |
callbackForPendingActions()
Requests a callback for pending actions.
|
void |
callbackForSignalActions()
Requests a callback for signal actions.
|
void |
doEventActions(Event event)
Does event actions.
|
void |
doPendingActions()
Does pending actions.
|
void |
doSignalActions(Signal signal)
Does signal actions.
|
protected Config |
getConfig()
Gets the config.
|
protected Metadata |
getMetadata()
Gets the metadata.
|
protected MetadataService |
getService()
Gets the service.
|
protected Logger |
getThisLogger()
Gets the logger.
|
protected boolean |
loadMetadata(MetadataFilter metadataFilter)
Loads the metadata.
|
boolean |
needsMetadata()
Asks if this module needs metadata.
|
void |
prepareServletContext(ServletContext servletContext)
Prepares the servlet context.
|
boolean |
setRestartEnabled(boolean restartEnabled)
Sets the restart enabled indicator.
|
boolean |
setUp(HTTPServerAppImpl httpApp,
Map<String,String> servlets,
KeyedGroups contextProperties)
Sets up this server module.
|
protected boolean |
setUp(KeyedGroups contextProperties)
Sets up the server module.
|
void |
tearDown()
Tears down what has been set up.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDefaultPath
public static final String MODULE_UUID_PROPERTY
public final void callbackForEventActions()
public final void callbackForPendingActions()
public final void callbackForSignalActions()
public void doEventActions(Event event)
doEventActions
in interface HTTPModule
event
- The event.public void doPendingActions()
doPendingActions
in interface HTTPModule
public void doSignalActions(Signal signal)
doSignalActions
in interface HTTPModule
signal
- The signal.public boolean needsMetadata()
needsMetadata
in interface HTTPModule
public void prepareServletContext(ServletContext servletContext)
prepareServletContext
in interface HTTPModule
servletContext
- The servlet context.@CheckReturnValue public final boolean setRestartEnabled(boolean restartEnabled)
restartEnabled
- The restart enabled indicator.public final boolean setUp(HTTPServerAppImpl httpApp, Map<String,String> servlets, KeyedGroups contextProperties)
setUp
in interface HTTPModule
httpApp
- The HTTP application.servlets
- The servlets map.contextProperties
- The context properties.public void tearDown()
tearDown
in interface HTTPModule
protected abstract void addServlets(@Nonnull Map<String,String> servlets)
servlets
- The servlets map.@Nonnull @CheckReturnValue protected final Config getConfig()
@Nonnull @CheckReturnValue protected final Metadata getMetadata()
@Nonnull @CheckReturnValue protected final MetadataService getService()
@Nonnull @CheckReturnValue protected final Logger getThisLogger()
@CheckReturnValue protected final boolean loadMetadata(MetadataFilter metadataFilter)
metadataFilter
- The metadata filter.@CheckReturnValue protected boolean setUp(@Nonnull KeyedGroups contextProperties)
contextProperties
- The context properties.Copyright © 2003-2019 Serge Brisson. All Rights Reserved.