A C D E F G H I L M P R S W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractRESTPlugin - Class in adams.flow.dropwizard
-
Ancestor for REST plugins.
- AbstractRESTPlugin() - Constructor for class adams.flow.dropwizard.AbstractRESTPlugin
- AbstractRESTPluginWithDatabaseConnection - Class in adams.flow.dropwizard
-
Ancestor for REST plugins that require a database connection.
- AbstractRESTPluginWithDatabaseConnection() - Constructor for class adams.flow.dropwizard.AbstractRESTPluginWithDatabaseConnection
- AbstractRESTPluginWithFlowContext - Class in adams.flow.dropwizard
-
Ancestor for REST plugins that require a flow context.
- AbstractRESTPluginWithFlowContext() - Constructor for class adams.flow.dropwizard.AbstractRESTPluginWithFlowContext
- AbstractRESTProvider - Class in adams.flow.dropwizard
-
Ancestor for servers providing webservices.
- AbstractRESTProvider() - Constructor for class adams.flow.dropwizard.AbstractRESTProvider
- adams.flow.dropwizard - package adams.flow.dropwizard
- adams.flow.dropwizard.echo - package adams.flow.dropwizard.echo
- adams.flow.dropwizard.healthcheck - package adams.flow.dropwizard.healthcheck
- adams.flow.standalone - package adams.flow.standalone
C
- check() - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Performs some initial checks before starting the service.
- check() - Method in class adams.flow.dropwizard.healthcheck.Dummy
- cleanUp() - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Cleans up data structures, frees up memory.
- cleanUp() - Method in interface adams.flow.dropwizard.RESTProvider
-
Cleans up data structures, frees up memory.
- cleanUp() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Cleans up after the execution has finished.
- configFileTipText() - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Returns the tip text for this property.
- configurePlugins(RESTPlugin[]) - Method in class adams.flow.dropwizard.GenericServer
-
For configuring the plugins, e.g., setting the flow context.
D
- defineOptions() - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Adds options to the internal list of options.
- defineOptions() - Method in class adams.flow.dropwizard.GenericServer
-
Adds options to the internal list of options.
- defineOptions() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Adds options to the internal list of options.
- doExecute() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Executes the flow item.
- doStart() - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Performs the actual start of the service.
- doStart() - Method in class adams.flow.dropwizard.echo.EchoServer
-
Performs the actual start of the service.
- doStart() - Method in class adams.flow.dropwizard.GenericServer
-
Performs the actual start of the service.
- doStop() - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Performs the actual stop of the service.
- DropwizardRESTServer - Class in adams.flow.standalone
-
Runs a Dropwizard REST webservice.
- DropwizardRESTServer() - Constructor for class adams.flow.standalone.DropwizardRESTServer
- Dummy - Class in adams.flow.dropwizard.healthcheck
-
Dummy check, always returns healthy.
- Dummy() - Constructor for class adams.flow.dropwizard.healthcheck.Dummy
E
- Echo - Class in adams.flow.dropwizard.echo
-
Simple echo of the input.
Based on code from here:
https://github.com/zalacer/projects-tn/blob/master/JAX-RSdemo1/src/main/java/tn/HelloWorld.java
- Echo() - Constructor for class adams.flow.dropwizard.echo.Echo
- EchoApplication(EchoServer) - Constructor for class adams.flow.dropwizard.echo.EchoServer.EchoApplication
- EchoServer - Class in adams.flow.dropwizard.echo
-
Only offers: adams.flow.dropwizard.echo.Echo
REST Class
- Path: @jakarta.ws.rs.Path(value="/echo/{input}")
- Produces: @jakarta.ws.rs.Produces(value={"text/plain"})
REST Method 'ping'
- Parameter #1: @jakarta.ws.rs.PathParam(value="input")
- Method(s): GET
- EchoServer() - Constructor for class adams.flow.dropwizard.echo.EchoServer
- EchoServer.EchoApplication - Class in adams.flow.dropwizard.echo
F
- findCallableActor() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Tries to find the callable actor referenced by its callable name.
G
- GenericApplication(GenericServer) - Constructor for class adams.flow.dropwizard.GenericServer.GenericApplication
- GenericServer - Class in adams.flow.dropwizard
-
Generic REST service provider, which allows you to assemble the REST plugins that should make up the service.
Automatically sets the flow context of plugins, if they should implement the adams.flow.core.FlowContextHandler interface. - GenericServer() - Constructor for class adams.flow.dropwizard.GenericServer
- GenericServer.GenericApplication - Class in adams.flow.dropwizard
- getAdditionalInformation() - Method in class adams.flow.dropwizard.AbstractRESTPlugin
-
Returns the additional information.
- getAdditionalInformation() - Method in class adams.flow.dropwizard.GenericServer
-
Returns the additional information.
- getAdditionalInformation() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Returns the additional information.
- getAdditionalInformation(RESTPlugin) - Static method in class adams.flow.dropwizard.RESTUtils
-
Generates information about the plugin, to be used for the information return by
AdditionalInformationHandler
. - getAdditionalInformation(Class) - Static method in class adams.flow.dropwizard.RESTUtils
-
Returns the additional for the class, if any.
- getAdditionalInformation(Method) - Static method in class adams.flow.dropwizard.RESTUtils
-
Returns the additional for the method, if any.
- getCallableActor() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Returns the currently set callable actor.
- getConfigFile() - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Returns the YAML config file in use.
- getConfigFile() - Method in interface adams.flow.dropwizard.RESTProvider
-
Returns the YAML config file in use.
- getDefaultHealthChecks() - Method in class adams.flow.dropwizard.GenericServer
-
Returns the default health checks to use.
- getDefaultPlugins() - Method in class adams.flow.dropwizard.GenericServer
-
Returns the default plugins to use.
- getEnvironment() - Method in class adams.flow.dropwizard.echo.EchoServer.EchoApplication
- getEnvironment() - Method in class adams.flow.dropwizard.GenericServer.GenericApplication
- getFlowContext() - Method in class adams.flow.dropwizard.AbstractRESTPluginWithFlowContext
-
Returns the flow context, if any.
- getFlowContext() - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Returns the owning actor.
- getFlowContext() - Method in interface adams.flow.dropwizard.RESTProvider
-
Returns the owning actor.
- getHealthChecks() - Method in class adams.flow.dropwizard.GenericServer
-
Returns the health checks in use.
- getLog() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Returns the name of the callable log actor in use.
- getName() - Method in class adams.flow.dropwizard.echo.EchoServer.EchoApplication
- getName() - Method in class adams.flow.dropwizard.GenericServer.GenericApplication
- getPlugins() - Method in class adams.flow.dropwizard.GenericServer
-
Returns the REST plugins in use.
- getQuickInfo() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Returns a quick info about the actor, which will be displayed in the GUI.
- getWebService() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Returns the webservice in use.
- globalInfo() - Method in class adams.flow.dropwizard.echo.Echo
-
Returns a string describing the object.
- globalInfo() - Method in class adams.flow.dropwizard.echo.EchoServer
-
Returns a string describing the object.
- globalInfo() - Method in class adams.flow.dropwizard.GenericServer
-
Returns a string describing the object.
- globalInfo() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Returns a string describing the object.
H
- hasCallableActor() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Checks whether a reference to the callable actor is currently available.
- healthChecksTipText() - Method in class adams.flow.dropwizard.GenericServer
-
Returns the tip text for this property.
I
- initDatabase() - Method in class adams.flow.dropwizard.AbstractRESTPluginWithDatabaseConnection
-
Initializes the database from the flow context.
- initialize() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Initializes the members.
- initialize(Bootstrap<Configuration>) - Method in class adams.flow.dropwizard.echo.EchoServer.EchoApplication
- initialize(Bootstrap<Configuration>) - Method in class adams.flow.dropwizard.GenericServer.GenericApplication
- isRunning() - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Returns whether the service is running.
- isRunning() - Method in interface adams.flow.dropwizard.RESTProvider
-
Returns whether the service is running.
L
- log(String, String) - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Logs an error message if a valid global log actor has been set up.
- log(String, String) - Method in class adams.flow.standalone.DropwizardRESTServer
-
Logs an error message if a valid callable log actor has been set up.
- logTipText() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Returns the tip text for this property.
M
- m_Application - Variable in class adams.flow.dropwizard.AbstractRESTProvider
-
the application.
- m_ConfigFile - Variable in class adams.flow.dropwizard.AbstractRESTProvider
-
the YAML config file to use.
- m_DatabaseConnection - Variable in class adams.flow.dropwizard.AbstractRESTPluginWithDatabaseConnection
-
the database to use.
- m_Environment - Variable in class adams.flow.dropwizard.AbstractRESTProvider
-
the environment in use.
- m_Environment - Variable in class adams.flow.dropwizard.echo.EchoServer.EchoApplication
-
the environment.
- m_Environment - Variable in class adams.flow.dropwizard.GenericServer.GenericApplication
-
the environment.
- m_FlowContext - Variable in class adams.flow.dropwizard.AbstractRESTPluginWithFlowContext
-
the flow context.
- m_HealthChecks - Variable in class adams.flow.dropwizard.GenericServer
-
the healthchecks.
- m_Helper - Variable in class adams.flow.standalone.DropwizardRESTServer
-
the helper class.
- m_Log - Variable in class adams.flow.standalone.DropwizardRESTServer
-
the callable name.
- m_LogActor - Variable in class adams.flow.standalone.DropwizardRESTServer
-
the callable log actor.
- m_Owner - Variable in class adams.flow.dropwizard.AbstractRESTProvider
-
the owning actor.
- m_Owner - Variable in class adams.flow.dropwizard.echo.EchoServer.EchoApplication
-
the owner.
- m_Owner - Variable in class adams.flow.dropwizard.GenericServer.GenericApplication
-
the owner.
- m_Plugins - Variable in class adams.flow.dropwizard.GenericServer
-
the plugins that make up the server.
- m_Running - Variable in class adams.flow.dropwizard.AbstractRESTProvider
-
whether the webservice is running.
- m_WebService - Variable in class adams.flow.standalone.DropwizardRESTServer
-
the webservice to run.
P
- ping(String) - Method in class adams.flow.dropwizard.echo.Echo
- pluginsTipText() - Method in class adams.flow.dropwizard.GenericServer
-
Returns the tip text for this property.
R
- reset() - Method in class adams.flow.dropwizard.AbstractRESTPluginWithDatabaseConnection
-
Resets the plugin.
- RESTPlugin - Interface in adams.flow.dropwizard
-
Interface for classes that provide REST functionality.
- RESTProvider - Interface in adams.flow.dropwizard
-
Interface for REST webservice providers, i.e., the server side.
- RESTUtils - Class in adams.flow.dropwizard
-
Utility class around REST webservices.
- RESTUtils() - Constructor for class adams.flow.dropwizard.RESTUtils
- run(Configuration, Environment) - Method in class adams.flow.dropwizard.echo.EchoServer.EchoApplication
- run(Configuration, Environment) - Method in class adams.flow.dropwizard.GenericServer.GenericApplication
S
- setConfigFile(PlaceholderFile) - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Sets the YAML config file to use.
- setConfigFile(PlaceholderFile) - Method in interface adams.flow.dropwizard.RESTProvider
-
Sets the YAML config file to use.
- setFlowContext(Actor) - Method in class adams.flow.dropwizard.AbstractRESTPluginWithDatabaseConnection
-
Sets the flow context.
- setFlowContext(Actor) - Method in class adams.flow.dropwizard.AbstractRESTPluginWithFlowContext
-
Sets the flow context.
- setFlowContext(Actor) - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Sets the actor that executes this webservice.
- setFlowContext(Actor) - Method in interface adams.flow.dropwizard.RESTProvider
-
Sets the actor that executes this webservice.
- setHealthChecks(HealthCheck[]) - Method in class adams.flow.dropwizard.GenericServer
-
Sets the health checks to use.
- setLog(CallableActorReference) - Method in class adams.flow.standalone.DropwizardRESTServer
-
Sets the name of the callable log actor to use.
- setPlugins(RESTPlugin[]) - Method in class adams.flow.dropwizard.GenericServer
-
Sets the REST plugins to use.
- setUp() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Initializes the item for flow execution.
- setWebService(RESTProvider) - Method in class adams.flow.standalone.DropwizardRESTServer
-
Sets the webservice to use.
- start() - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Starts the service.
- start() - Method in interface adams.flow.dropwizard.RESTProvider
-
Starts the service.
- stop() - Method in class adams.flow.dropwizard.AbstractRESTProvider
-
Stops the service.
- stop() - Method in interface adams.flow.dropwizard.RESTProvider
-
Stops the service.
W
- webServiceTipText() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Returns the tip text for this property.
- wrapUp() - Method in class adams.flow.standalone.DropwizardRESTServer
-
Cleans up after the execution has finished.
All Classes All Packages