Index (clara-java 4.3-SNAPSHOT API)

A B C D E F G H I J L M N O P Q R S T U V W

A

AbstractCommand - Class in org.jlab.clara.std.cli: Default class for new shell commands.
AbstractCommand(Context, String, String) - Constructor for class org.jlab.clara.std.cli.AbstractCommand: Creates a new command.
AbstractEventReaderService<Reader> - Class in org.jlab.clara.std.services: An abstract reader service that reads events from the configured input file.
AbstractEventReaderService() - Constructor for class org.jlab.clara.std.services.AbstractEventReaderService
AbstractEventWriterService<Writer> - Class in org.jlab.clara.std.services: An abstract writer service that writes all received events into the configured output file.
AbstractEventWriterService() - Constructor for class org.jlab.clara.std.services.AbstractEventWriterService
AbstractService - Class in org.jlab.clara.std.services: An base class for service engines that obtains the service information from a YAML file.
AbstractService() - Constructor for class org.jlab.clara.std.services.AbstractService
address() - Method in interface org.jlab.clara.base.ClaraName: Returns the address of the proxy used by this CLARA component.
address() - Method in class org.jlab.clara.base.ContainerName
address() - Method in class org.jlab.clara.base.DpeName
address() - Method in class org.jlab.clara.base.ServiceName
addSubCommand(String, Function<String[], Integer>, String) - Method in class org.jlab.clara.std.cli.BaseCommand: Creates and adds a new subcommand to the list of subcommands supported by this command.
addSubCommand(CommandFactory) - Method in class org.jlab.clara.std.cli.BaseCommand: Adds the given subcommand to the list of subcommands supported by this command.
aliveDpes() - Method in class org.jlab.clara.base.ClaraSubscriptions.GlobalSubscriptionBuilder: A subscription to the periodic alive message reported by all running DPEs.
aliveDpes(String) - Method in class org.jlab.clara.base.ClaraSubscriptions.GlobalSubscriptionBuilder: A subscription to the periodic alive message reported by the running DPEs with the given session.
allContainers() - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all containers in the CLARA cloud.
allDpes() - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all DPEs in the CLARA cloud.
allServices() - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all services in the CLARA cloud.
ARRAY_DOUBLE - Static variable in class org.jlab.clara.engine.EngineDataType: An array of doubles (64 bits floating-point numbers).
ARRAY_FLOAT - Static variable in class org.jlab.clara.engine.EngineDataType: An array of floats (32 bits floating-point numbers).
ARRAY_SFIXED32 - Static variable in class org.jlab.clara.engine.EngineDataType: An array of signed fixed integers of 32 bits.
ARRAY_SFIXED64 - Static variable in class org.jlab.clara.engine.EngineDataType: An array of signed fixed integers of 64 bits.
ARRAY_SINT32 - Static variable in class org.jlab.clara.engine.EngineDataType: An array of signed varints of 32 bits.
ARRAY_SINT64 - Static variable in class org.jlab.clara.engine.EngineDataType: An array of signed varints of 64 bits.
ARRAY_STRING - Static variable in class org.jlab.clara.engine.EngineDataType: An array of strings.
author() - Method in class org.jlab.clara.base.ServiceRegistrationData: Gets information about the developer(s) of the service class.
author() - Method in class org.jlab.clara.engine.EngineSpecification: Returns the name of the author of the engine.

B

BaseCommand - Class in org.jlab.clara.std.cli: A command that groups a list of subcommands that can be executed separately.
BaseCommand(Context, String, String) - Constructor for class org.jlab.clara.std.cli.BaseCommand: Creates a new base command to group subcommands.
BaseOrchestrator - Class in org.jlab.clara.base: Base class for orchestration of applications.
BaseOrchestrator() - Constructor for class org.jlab.clara.base.BaseOrchestrator: Creates a new orchestrator.
BaseOrchestrator(int) - Constructor for class org.jlab.clara.base.BaseOrchestrator: Creates a new orchestrator.
BaseOrchestrator(DpeName) - Constructor for class org.jlab.clara.base.BaseOrchestrator: Creates a new orchestrator.
BaseOrchestrator(DpeName, int) - Constructor for class org.jlab.clara.base.BaseOrchestrator: Creates a new orchestrator.
BaseOrchestrator(String, DpeName, int) - Constructor for class org.jlab.clara.base.BaseOrchestrator: Creates a new orchestrator.
build() - Method in class org.jlab.clara.std.cli.ClaraShell.Builder: Creates the user-interactive CLARA shell instance.
build() - Method in class org.jlab.clara.std.cli.Config.Builder: Creates the shell configuration.
build() - Method in class org.jlab.clara.std.cli.ConfigVariable.Builder: Creates the variable.
build() - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Creates the orchestrator.
build() - Method in class org.jlab.clara.sys.Dpe.Builder: Creates the DPE.
buildDataTypes(EngineDataType...) - Static method in class org.jlab.clara.base.ClaraUtil: Helps creating a set of engine data types.
Builder(TerminalBuilder) - Constructor for class org.jlab.clara.std.cli.ClaraShell.Builder: Creates a new builder.
Builder() - Constructor for class org.jlab.clara.std.cli.Config.Builder: Creates a new builder.
Builder(String, List<String>) - Constructor for class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Sets the required arguments for the generic data processing orchestrator.
Builder() - Constructor for class org.jlab.clara.sys.Dpe.Builder: Creates a builder for a front-end DPE.
Builder(String) - Constructor for class org.jlab.clara.sys.Dpe.Builder: Creates a builder for a worker DPE.
Builder(String, int) - Constructor for class org.jlab.clara.sys.Dpe.Builder: Creates a builder for a worker DPE.
BYTES - Static variable in class org.jlab.clara.engine.EngineDataType: Raw bytes.
bytesReceived() - Method in class org.jlab.clara.base.ServiceRuntimeData: Gets the total amount of bytes received by the service through the network.
bytesSent() - Method in class org.jlab.clara.base.ServiceRuntimeData: Gets the total amount of bytes sent by the service through the network.

C

callback(DpeRegistrationData, DpeRuntimeData) - Method in interface org.jlab.clara.base.DpeReportCallback: Processes the parsed JSON report published by a CLARA DPE.
callback(EngineData) - Method in interface org.jlab.clara.base.EngineCallback: Receives and process the data that a service has published.
callback(String) - Method in interface org.jlab.clara.base.GenericCallback: Receives and process the data that CLARA has published.
CANONICAL_NAME_PATTERN - Static variable in class org.jlab.clara.base.ClaraUtil: Regex to validate a full canonical name.
canonicalName() - Method in interface org.jlab.clara.base.ClaraName: Returns the canonical name of this CLARA component.
canonicalName() - Method in class org.jlab.clara.base.ContainerName
canonicalName() - Method in class org.jlab.clara.base.DpeName
canonicalName() - Method in class org.jlab.clara.base.ServiceName
canonicalNames(DpeFilter) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the names of the selected DPEs.
canonicalNames(ContainerFilter) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the names of the selected containers.
canonicalNames(ServiceFilter) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the names of the selected services.
checkProgram(String) - Static method in class org.jlab.clara.std.cli.CommandUtils: Checks if the given program exists in $PATH.
ClaraAddress - Class in org.jlab.clara.base: The address where a CLARA component is listening messages.
ClaraException - Exception in org.jlab.clara.base.error: Base class for CLARA exceptions.
ClaraException(String) - Constructor for exception org.jlab.clara.base.error.ClaraException: Constructs a new exception with the specified detail message.
ClaraException(String, Throwable) - Constructor for exception org.jlab.clara.base.error.ClaraException: Constructs a new exception with the specified detail message and cause.
ClaraFilters - Class in org.jlab.clara.base: The standard filters to select CLARA DPEs, containers or services.
claraHome() - Method in class org.jlab.clara.base.DpeRegistrationData: Gets the local value of the $CLARA_HOME environment variable used by the DPE.
claraHome() - Static method in class org.jlab.clara.std.cli.Config: Gets the value of the CLARA_HOME environment variable.
ClaraLang - Enum in org.jlab.clara.base: The supported languages for CLARA components.
ClaraName - Interface in org.jlab.clara.base: Identifier of a CLARA component.
ClaraQueries - Class in org.jlab.clara.base: Queries to the CLARA registration/runtime database.
ClaraQueries.CanonicalNameQuery<T> - Class in org.jlab.clara.base: A query to get the names of the registered CLARA components.
ClaraQueries.ClaraQueryBuilder - Class in org.jlab.clara.base: Builds a request to query the CLARA registration and runtime database.
ClaraQueries.DiscoveryQuery<T> - Class in org.jlab.clara.base: A query to check if a CLARA component is registered.
ClaraQueries.RegistrationData<T> - Class in org.jlab.clara.base: A query to get the registration data of a specific CLARA component.
ClaraQueries.RegistrationQuery<T> - Class in org.jlab.clara.base: A query to get the registration data of the registered CLARA components.
ClaraQueries.RuntimeData<T> - Class in org.jlab.clara.base: A query to get the runtime data of a specific CLARA component.
ClaraQueries.RuntimeQuery<T> - Class in org.jlab.clara.base: A query to get the runtime data of the registered CLARA components.
ClaraRequests - Class in org.jlab.clara.base: Requests to running CLARA components.
ClaraRequests.DeployContainerRequest - Class in org.jlab.clara.base: A request to start a container.
ClaraRequests.DeployServiceRequest - Class in org.jlab.clara.base: A request to start a service.
ClaraRequests.ExitRequest - Class in org.jlab.clara.base: A request to stop a running CLARA component.
ClaraRequests.ServiceConfigRequest - Class in org.jlab.clara.base: A request to configure a service.
ClaraRequests.ServiceConfigRequestBuilder - Class in org.jlab.clara.base: Builds a request to configure a service.
ClaraRequests.ServiceExecuteRequest - Class in org.jlab.clara.base: A request to execute a service composition.
ClaraRequests.ServiceExecuteRequestBuilder - Class in org.jlab.clara.base: Builds a request to execute a service or a composition.
ClaraRequests.ServiceReportRequest - Class in org.jlab.clara.base: A request to setup the reports of a service.
ClaraSerializer - Interface in org.jlab.clara.engine: Provides the custom serialization methods to send user defined data through the network.
ClaraShell - Class in org.jlab.clara.std.cli: An interactive shell to run CLARA DPEs and orchestrators.
ClaraShell.Builder - Class in org.jlab.clara.std.cli: Helps configuring and creating a new ClaraShell.
ClaraSubscriptions - Class in org.jlab.clara.base: Subscriptions for running CLARA components.
ClaraSubscriptions() - Constructor for class org.jlab.clara.base.ClaraSubscriptions
ClaraSubscriptions.BaseDpeReportSubscription - Class in org.jlab.clara.base: A subscription to listen for JSON reports from the DPEs.
ClaraSubscriptions.DpeReportSubscription - Class in org.jlab.clara.base: A subscription to listen for JSON reports from the DPEs.
ClaraSubscriptions.GlobalSubscriptionBuilder - Class in org.jlab.clara.base: Builds a subscription to listen the different CLARA DPE reports.
ClaraSubscriptions.JsonReportSubscription - Class in org.jlab.clara.base: A subscription to listen for JSON reports from the DPEs.
ClaraSubscriptions.ServiceSubscription - Class in org.jlab.clara.base: A subscription to listen for service reports (data, done, status).
ClaraSubscriptions.ServiceSubscriptionBuilder - Class in org.jlab.clara.base: Builds a subscription to listen the different CLARA service reports.
ClaraUtil - Class in org.jlab.clara.base: Extra helper methods for CLARA orchestrator and services.
className() - Method in class org.jlab.clara.base.ServiceRegistrationData: Gets the Java class, C++ library or Python module that contains the service.
close() - Method in class org.jlab.clara.base.BaseOrchestrator: Unsubscribes all running subscriptions, terminates all running callbacks and closes all connections.
close() - Method in class org.jlab.clara.std.cli.AbstractCommand
close() - Method in class org.jlab.clara.std.cli.BaseCommand
close() - Method in class org.jlab.clara.std.cli.ClaraShell
close() - Method in interface org.jlab.clara.std.orchestrators.DpeReportHandler
close() - Method in interface org.jlab.clara.std.orchestrators.EngineReportHandler
close() - Method in class org.jlab.clara.std.orchestrators.MonitorOrchestrator
closeReader() - Method in class org.jlab.clara.std.services.AbstractEventReaderService: Closes the reader and its input file.
closeWriter() - Method in class org.jlab.clara.std.services.AbstractEventWriterService: Closes the writer and its output file.
cloudMode() - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Uses a cloud of worker DPEs to process the set of input files.
collect(Stream<xMsgRegRecord>, long) - Method in class org.jlab.clara.base.ClaraQueries.CanonicalNameQuery
collect(Stream<xMsgRegRecord>, long) - Method in class org.jlab.clara.base.ClaraQueries.DiscoveryQuery
collect(Stream<xMsgRegRecord>, long) - Method in class org.jlab.clara.base.ClaraQueries.RegistrationData
collect(Stream<xMsgRegRecord>, long) - Method in class org.jlab.clara.base.ClaraQueries.RegistrationQuery
collect(Stream<xMsgRegRecord>, long) - Method in class org.jlab.clara.base.ClaraQueries.RuntimeData
collect(Stream<xMsgRegRecord>, long) - Method in class org.jlab.clara.base.ClaraQueries.RuntimeQuery
Command - Interface in org.jlab.clara.std.cli: A command that can be executed by the CLARA shell.
CommandFactory - Interface in org.jlab.clara.std.cli: A factory for new shell builtin commands.
CommandUtils - Class in org.jlab.clara.std.cli: Helpers to run CLI commands.
Composition - Class in org.jlab.clara.base: A CLARA composition of services.
Composition(String) - Constructor for class org.jlab.clara.base.Composition: Parses a composition from the given string.
config - Variable in class org.jlab.clara.std.cli.AbstractCommand: The configuration of the shell session.
Config - Class in org.jlab.clara.std.cli: Environment configuration for a CLARA shell session.
config() - Method in class org.jlab.clara.std.cli.Context: Gets the configuration variables for the shell session.
Config.Builder - Class in org.jlab.clara.std.cli: Helps creating the configuration for a shell session.
ConfigParsers - Class in org.jlab.clara.std.cli: Parsers to set the value of configuration variables.
configure(ServiceName) - Method in class org.jlab.clara.base.BaseOrchestrator: Returns a request builder to configure the given service.
configure(EngineData) - Method in interface org.jlab.clara.engine.Engine: Configures the engine with the given input data.
configure(EngineData) - Method in class org.jlab.clara.std.services.AbstractEventReaderService
configure(EngineData) - Method in class org.jlab.clara.std.services.AbstractEventWriterService
configure(EngineData) - Method in class org.jlab.clara.std.services.DataManager: Configures the engine with the given input data.
ConfigVariable - Class in org.jlab.clara.std.cli: A configuration variable for a CLARA shell session.
ConfigVariable.Builder - Class in org.jlab.clara.std.cli: Helps creating a new ConfigVariable.
container() - Method in class org.jlab.clara.base.ServiceName: Gets the canonical name of the container for this service.
ContainerFilter - Class in org.jlab.clara.base: A filter to select containers.
ContainerName - Class in org.jlab.clara.base: Unique identifier of a CLARA container.
ContainerName(String, ClaraLang, String) - Constructor for class org.jlab.clara.base.ContainerName: Identify a container with host and language of its DPE and name.
ContainerName(DpeName, String) - Constructor for class org.jlab.clara.base.ContainerName: Identify a container with its DPE and name.
ContainerName(String) - Constructor for class org.jlab.clara.base.ContainerName: Identify a container with its canonical name.
ContainerRegistrationData - Class in org.jlab.clara.base: The registration data of a running container.
ContainerRuntimeData - Class in org.jlab.clara.base: The runtime data of a running container.
containers() - Method in class org.jlab.clara.base.DpeRegistrationData: Gets all the containers running on the DPE.
containers() - Method in class org.jlab.clara.base.DpeRuntimeData: Gets the runtime report of all the containers running on the DPE.
containersByDpe(DpeName) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the containers of the given DPE.
containersByHost(String) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the containers of the given host.
containersByLanguage(ClaraLang) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the containers of the given language.
containersByName(String) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the containers of the given name.
Context - Class in org.jlab.clara.std.cli: The context for a shell session.
Context(Terminal, Config) - Constructor for class org.jlab.clara.std.cli.Context: Creates the context for a shell session.
cpuUsage() - Method in class org.jlab.clara.base.DpeRuntimeData: Gets the reported CPU usage of the DPE.
create(Context) - Method in interface org.jlab.clara.std.cli.CommandFactory: Creates a new builtin command.
createReader(Path, JSONObject) - Method in class org.jlab.clara.std.services.AbstractEventReaderService: Creates a new reader and opens the given input file.
createWriter(Path, JSONObject) - Method in class org.jlab.clara.std.services.AbstractEventWriterService: Creates a new writer and opens the given output file.

D

data() - Method in class org.jlab.clara.base.ClaraSubscriptions.ServiceSubscriptionBuilder: A subscription to the data reports of the selected service.
DataManager - Class in org.jlab.clara.std.services: A service to copy files between a mounted shared file-system and the local files-system.
DataManager() - Constructor for class org.jlab.clara.std.services.DataManager: Creates a new data manager service.
DataManager(String) - Constructor for class org.jlab.clara.std.services.DataManager: Creates a new data manager service.
dataRing() - Method in class org.jlab.clara.base.ClaraSubscriptions.GlobalSubscriptionBuilder: A subscription for all events published to the CLARA data-ring.
dataRing(DataRingTopic) - Method in class org.jlab.clara.base.ClaraSubscriptions.GlobalSubscriptionBuilder: A subscription for events published with the given topic to the CLARA data-ring.
DataRingAddress - Class in org.jlab.clara.base: The address of a CLARA data-ring.
DataRingAddress(String) - Constructor for class org.jlab.clara.base.DataRingAddress: Identify a CLARA data-ring.
DataRingAddress(String, int) - Constructor for class org.jlab.clara.base.DataRingAddress: Identify a CLARA data-ring.
DataRingAddress(DpeName) - Constructor for class org.jlab.clara.base.DataRingAddress: Identify a CLARA data-ring.
DataRingTopic - Class in org.jlab.clara.base: The address of a CLARA data-ring.
DataRingTopic(String) - Constructor for class org.jlab.clara.base.DataRingTopic: A topic to listen all events of the given state.
DataRingTopic(String, String) - Constructor for class org.jlab.clara.base.DataRingTopic: A topic to listen all events of the given state and session.
DataRingTopic(String, String, String) - Constructor for class org.jlab.clara.base.DataRingTopic: A topic to listen all events of the given state, session and engine.
dataTypes() - Method in interface org.jlab.clara.std.orchestrators.EngineReportHandler: Gets the set of output data types reported by the service.
deploy(ContainerName) - Method in class org.jlab.clara.base.BaseOrchestrator: Creates a request to start the given container.
deploy(ServiceName, String) - Method in class org.jlab.clara.base.BaseOrchestrator: Creates a request to start the given service engine.
description() - Method in class org.jlab.clara.base.ServiceRegistrationData: Gets the full description of the service class.
description() - Method in class org.jlab.clara.engine.EngineSpecification: Returns the description of the engine.
description - Variable in class org.jlab.clara.std.cli.AbstractCommand: The description of the command.
DESCRIPTION - Static variable in class org.jlab.clara.std.cli.Config: The variable for the data processing description keyword.
destroy() - Method in interface org.jlab.clara.engine.Engine: Destroy this engine, closing and cleaning up any opened resources.
destroy() - Method in class org.jlab.clara.std.services.AbstractEventReaderService
destroy() - Method in class org.jlab.clara.std.services.AbstractEventWriterService
destroy() - Method in class org.jlab.clara.std.services.DataManager
destroyProcess(Process) - Static method in class org.jlab.clara.std.cli.CommandUtils: Destroys the given subprocess.
discover(DpeName) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to check if the given DPE is registered.
discover(ContainerName) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to check if the given container is registered.
discover(ServiceName) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to check if the given service is registered.
done() - Method in class org.jlab.clara.base.ClaraSubscriptions.ServiceSubscriptionBuilder: A subscription to the "done" reports of the selected service.
DOUBLE - Static variable in class org.jlab.clara.engine.EngineDataType: A double (64 bits floating-point number).
dpe() - Method in class org.jlab.clara.base.ContainerName: Gets the canonical name of the DPE for this container.
dpe() - Method in class org.jlab.clara.base.ServiceName: Gets the canonical name of the DPE for this service.
Dpe - Class in org.jlab.clara.sys: CLARA data processing environment.
Dpe.Builder - Class in org.jlab.clara.sys: Helps constructing a DPE.
DpeFilter - Class in org.jlab.clara.base: A filter to select DPEs.
DpeName - Class in org.jlab.clara.base: The name of a CLARA DPE.
DpeName(String, ClaraLang) - Constructor for class org.jlab.clara.base.DpeName: Identify a DPE with host and language.
DpeName(String, int, ClaraLang) - Constructor for class org.jlab.clara.base.DpeName: Identify a DPE with host, port and language.
DpeName(String) - Constructor for class org.jlab.clara.base.DpeName: Identify a DPE with a canonical name.
DpeRegistrationData - Class in org.jlab.clara.base: The registration data of a running DPE.
dpeReport() - Method in class org.jlab.clara.base.ClaraSubscriptions.GlobalSubscriptionBuilder: A subscription to the periodic runtime and registration reports of all running DPEs.
dpeReport(String) - Method in class org.jlab.clara.base.ClaraSubscriptions.GlobalSubscriptionBuilder: A subscription to the periodic runtime and registration reports of the running DPEs with the given session.
DpeReportCallback - Interface in org.jlab.clara.base: An interface to handle the JSON reports published by CLARA.
DpeReportHandler - Interface in org.jlab.clara.std.orchestrators: Handles the reports published by CLARA DPEs.
DpeRuntimeData - Class in org.jlab.clara.base: The runtime data of a running DPE.
dpesByHost(String) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the DPEs of the given host.
dpesByLanguage(ClaraLang) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the DPEs of the given language.

E

editFile(String) - Static method in class org.jlab.clara.std.cli.CommandUtils: Opens the given file in the default text editor of the user.
email() - Method in class org.jlab.clara.engine.EngineSpecification: Returns the email of the author of the engine.
end() - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator
engine() - Method in class org.jlab.clara.base.DataRingTopic
Engine - Interface in org.jlab.clara.engine: Service engine interface.
engine() - Method in class org.jlab.clara.engine.EngineSpecification: Returns the classpath of the engine.
EngineCallback - Interface in org.jlab.clara.base: An interface to handle the reports published by CLARA services.
EngineData - Class in org.jlab.clara.engine: Engine data passed in/out to the service engine.
EngineData() - Constructor for class org.jlab.clara.engine.EngineData: Creates an empty engine data object.
EngineDataType - Class in org.jlab.clara.engine: Defines a data type used by a service engine.
EngineDataType(String, ClaraSerializer) - Constructor for class org.jlab.clara.engine.EngineDataType: Creates a new user data type.
EngineReportHandler - Interface in org.jlab.clara.std.orchestrators: Handles the reports published by CLARA services.
EngineSpecification - Class in org.jlab.clara.engine: Loads the service specification from a YAML file.
EngineSpecification(Class<?>) - Constructor for class org.jlab.clara.engine.EngineSpecification: Uses the service class to detect the YAML file.
EngineSpecification(String) - Constructor for class org.jlab.clara.engine.EngineSpecification: Uses the full service engine class name to detect the YAML file.
EngineSpecification.ParseException - Exception in org.jlab.clara.engine: Reports any problem parsing the service specification file.
EngineStatus - Enum in org.jlab.clara.engine: Data processing status.
equals(Object) - Method in class org.jlab.clara.base.ContainerName
equals(Object) - Method in class org.jlab.clara.base.DataRingTopic
equals(Object) - Method in class org.jlab.clara.base.DpeName
equals(Object) - Method in class org.jlab.clara.base.ServiceName
EventReaderException - Exception in org.jlab.clara.std.services: A problem in the event reader implementation.
EventReaderException(String) - Constructor for exception org.jlab.clara.std.services.EventReaderException: Constructs a new exception.
EventReaderException(Throwable) - Constructor for exception org.jlab.clara.std.services.EventReaderException: Constructs a new exception.
EventReaderException(String, Throwable) - Constructor for exception org.jlab.clara.std.services.EventReaderException: Constructs a new exception.
EventWriterException - Exception in org.jlab.clara.std.services: A problem in the event writer implementation.
EventWriterException(String) - Constructor for exception org.jlab.clara.std.services.EventWriterException: Constructs a new exception.
EventWriterException(Throwable) - Constructor for exception org.jlab.clara.std.services.EventWriterException: Constructs a new exception.
EventWriterException(String, Throwable) - Constructor for exception org.jlab.clara.std.services.EventWriterException: Constructs a new exception.
execute(ServiceName) - Method in class org.jlab.clara.base.BaseOrchestrator: Returns a request builder to execute the given service.
execute(Composition) - Method in class org.jlab.clara.base.BaseOrchestrator: Returns a request builder to execute the given composition.
execute(EngineData) - Method in interface org.jlab.clara.engine.Engine: Executes the engine with the given input data.
execute(String[]) - Method in class org.jlab.clara.std.cli.BaseCommand
execute(String[]) - Method in interface org.jlab.clara.std.cli.Command: Executes the command with the give arguments.
execute(EngineData) - Method in class org.jlab.clara.std.services.AbstractEventReaderService
execute(EngineData) - Method in class org.jlab.clara.std.services.AbstractEventWriterService
execute(EngineData) - Method in class org.jlab.clara.std.services.DataManager: Executes the engine with the given input data.
executeGroup(Set<EngineData>) - Method in interface org.jlab.clara.engine.Engine: Executes the engine with the given set of input data.
executeGroup(Set<EngineData>) - Method in class org.jlab.clara.std.services.AbstractEventReaderService
executeGroup(Set<EngineData>) - Method in class org.jlab.clara.std.services.AbstractEventWriterService
executeGroup(Set<EngineData>) - Method in class org.jlab.clara.std.services.AbstractService
executeGroup(Set<EngineData>) - Method in class org.jlab.clara.std.services.DataManager
executionTime() - Method in class org.jlab.clara.base.ServiceRuntimeData: Gets the total execution time of the service.
exit(DpeName) - Method in class org.jlab.clara.base.BaseOrchestrator: Creates a request to stop the given DPE.
exit(ContainerName) - Method in class org.jlab.clara.base.BaseOrchestrator: Creates a request to stop the given container.
exit(ServiceName) - Method in class org.jlab.clara.base.BaseOrchestrator: Creates a request to stop the given service.
EXIT_ERROR - Static variable in interface org.jlab.clara.std.cli.Command: Exit status for failed execution.
EXIT_SUCCESS - Static variable in interface org.jlab.clara.std.cli.Command: Exit status for successful execution.

F

FILES_LIST - Static variable in class org.jlab.clara.std.cli.Config: The variable for the list of input files.
firstService() - Method in class org.jlab.clara.base.Composition: Gets the first service of this composition.
FLOAT - Static variable in class org.jlab.clara.engine.EngineDataType: A float (32 bits floating-point number).
fromString(String) - Static method in enum org.jlab.clara.base.ClaraLang: Get the enum value for the given language string.
FRONTEND_HOST - Static variable in class org.jlab.clara.std.cli.Config: The variable for the address of the front-end DPE.
FRONTEND_PORT - Static variable in class org.jlab.clara.std.cli.Config: The variable for the port of the front-end DPE.

G

GenericCallback - Interface in org.jlab.clara.base: An interface to handle the JSON reports published by CLARA.
GenericOrchestrator - Class in org.jlab.clara.std.orchestrators: A generic orchestrator that runs a simple application loop over a set of input files.
GenericOrchestrator.Builder - Class in org.jlab.clara.std.orchestrators: Helps constructing a GenericOrchestrator with all default and required parameters.
getAuthor() - Method in interface org.jlab.clara.engine.Engine: Gets the author(s) of the engine.
getAuthor() - Method in class org.jlab.clara.std.services.AbstractService
getAuthor() - Method in class org.jlab.clara.std.services.DataManager
getCommunicationId() - Method in class org.jlab.clara.engine.EngineData: Gets the ID for the request this data is part of.
getCompleter() - Method in class org.jlab.clara.std.cli.AbstractCommand
getCompleter() - Method in class org.jlab.clara.std.cli.BaseCommand
getCompleter() - Method in interface org.jlab.clara.std.cli.Command: Gets a completer to generate tab-completion candidates of this command and its arguments.
getComposition() - Method in class org.jlab.clara.engine.EngineData: Gets the composition for the request this data is part of.
getContainerCanonicalName(String) - Static method in class org.jlab.clara.base.ClaraUtil: Gets the container canonical name from the given CLARA canonical name.
getContainerName(String) - Static method in class org.jlab.clara.base.ClaraUtil: Gets the container name from the given CLARA canonical name.
getCurrentTime() - Static method in class org.jlab.clara.base.ClaraUtil: Gets the current time and returns string representation of it.
getData() - Method in class org.jlab.clara.engine.EngineData: Gets the user-data.
getDataType() - Method in class org.jlab.clara.std.services.AbstractEventReaderService: Gets the CLARA engine data-type for the type of the events.
getDataType() - Method in class org.jlab.clara.std.services.AbstractEventWriterService: Gets the CLARA engine data-type for the type of the events.
getDefaultPort(ClaraLang) - Static method in class org.jlab.clara.base.ClaraUtil: Gets the default DPE port for the given language.
getDefaultPort(String) - Static method in class org.jlab.clara.base.ClaraUtil: Gets the default DPE port for the given language.
getDescription() - Method in interface org.jlab.clara.engine.Engine: Gets a description of the engine.
getDescription() - Method in class org.jlab.clara.engine.EngineData: Gets the description of the data and/or status.
getDescription() - Method in class org.jlab.clara.std.cli.AbstractCommand
getDescription() - Method in interface org.jlab.clara.std.cli.Command: Gets a brief explanation of what the command does.
getDescription() - Method in class org.jlab.clara.std.cli.ConfigVariable: Gets the description of this variable.
getDescription() - Method in class org.jlab.clara.std.services.AbstractService
getDescription() - Method in class org.jlab.clara.std.services.DataManager
getDpeHost(String) - Static method in class org.jlab.clara.base.ClaraUtil: Gets the DPE host address from the given CLARA canonical name.
getDpeLang(String) - Static method in class org.jlab.clara.base.ClaraUtil: Gets the DPE language from the given CLARA canonical name.
getDpeName(String) - Static method in class org.jlab.clara.base.ClaraUtil: Gets the DPE name from the given CLARA canonical name.
getDpePort(String) - Static method in class org.jlab.clara.base.ClaraUtil: Gets the DPE port from the given CLARA canonical name.
getEditor() - Static method in class org.jlab.clara.std.cli.CommandUtils: Gets the default text editor of the user.
getEngineName(String) - Static method in class org.jlab.clara.base.ClaraUtil: Gets the service engine name from the given CLARA canonical name.
getEngineName() - Method in class org.jlab.clara.engine.EngineData: Gets the canonical name of the engine that returned this data, if any.
getEngineVersion() - Method in class org.jlab.clara.engine.EngineData: Gets the version of the engine that returned this data, if any.
getenv() - Method in class org.jlab.clara.std.cli.Config: Returns an unmodifiable string map view of the custom environment variables set for the shell.
getExecutionState() - Method in class org.jlab.clara.engine.EngineData: Gets the state of the execution result set by the engine, if any.
getExecutionTime() - Method in class org.jlab.clara.engine.EngineData: Gets the time that took the engine to process a request and return this data.
getFrontEnd() - Method in class org.jlab.clara.base.BaseOrchestrator: Returns the front-end used by this orchestrator.
getInputDataTypes() - Method in interface org.jlab.clara.engine.Engine: Gets the set of input data types supported by the engine.
getInputDataTypes() - Method in class org.jlab.clara.std.services.AbstractEventReaderService
getInputDataTypes() - Method in class org.jlab.clara.std.services.AbstractEventWriterService
getInputDataTypes() - Method in class org.jlab.clara.std.services.DataManager
getMessage() - Method in exception org.jlab.clara.std.orchestrators.OrchestratorException
getMimeType() - Method in class org.jlab.clara.engine.EngineData: Gets the mime-type string for the user-data.
getName() - Method in class org.jlab.clara.base.BaseOrchestrator: Returns this orchestrator name.
getName() - Method in class org.jlab.clara.std.cli.AbstractCommand
getName() - Method in interface org.jlab.clara.std.cli.Command: Gets the name of the command.
getName() - Method in class org.jlab.clara.std.cli.ConfigVariable: Gets the name of this variable.
getName() - Method in class org.jlab.clara.std.services.AbstractService: Returns the name of the engine.
getOutputDataTypes() - Method in interface org.jlab.clara.engine.Engine: Gets the set of output data types supported by the engine.
getOutputDataTypes() - Method in class org.jlab.clara.std.services.AbstractEventReaderService
getOutputDataTypes() - Method in class org.jlab.clara.std.services.AbstractEventWriterService
getOutputDataTypes() - Method in class org.jlab.clara.std.services.DataManager
getPoolSize() - Method in class org.jlab.clara.base.BaseOrchestrator: Gets the size of the thread-pool that process subscription callbacks.
getRootCause(Throwable) - Static method in class org.jlab.clara.base.ClaraUtil: Obtains the root cause of the given the Throwable, if any.
getStates() - Method in interface org.jlab.clara.engine.Engine: Gets the set of possible states for the engine results.
getStates() - Method in class org.jlab.clara.std.services.AbstractService
getStates() - Method in class org.jlab.clara.std.services.DataManager
getStatus() - Method in class org.jlab.clara.engine.EngineData: Gets the status for the data.
getStatusSeverity() - Method in class org.jlab.clara.engine.EngineData: Gets the optional severity for the status of the data.
getThrowableList(Throwable) - Static method in class org.jlab.clara.base.ClaraUtil: Returns the list of Throwable objects in the exception chain.
getValue(String) - Method in class org.jlab.clara.std.cli.Config: Gets the value of the specified variable.
getValue() - Method in class org.jlab.clara.std.cli.ConfigVariable: Gets the current value of this variable.
getVersion() - Method in interface org.jlab.clara.engine.Engine: Gets the version of the engine.
getVersion() - Method in class org.jlab.clara.std.services.AbstractService
getVersion() - Method in class org.jlab.clara.std.services.DataManager

H

handleEvent(EngineData) - Method in interface org.jlab.clara.std.orchestrators.EngineReportHandler: Processes the reported output event.
handleReport(DpeRegistrationData, DpeRuntimeData) - Method in class org.jlab.clara.std.monitor.InfluxDbReporter
handleReport(DpeRegistrationData, DpeRuntimeData) - Method in interface org.jlab.clara.std.orchestrators.DpeReportHandler: Processes the DPE report.
hashCode() - Method in class org.jlab.clara.base.ContainerName
hashCode() - Method in class org.jlab.clara.base.DataRingTopic
hashCode() - Method in class org.jlab.clara.base.DpeName
hashCode() - Method in class org.jlab.clara.base.ServiceName
hasValue(String) - Method in class org.jlab.clara.std.cli.Config: Checks if the given variable has a value.
hasValue() - Method in class org.jlab.clara.std.cli.ConfigVariable: Checks if this variable has a value.
hasVariable(String) - Method in class org.jlab.clara.std.cli.Config: Checks if a variable of the given name exists.

I

InfluxDbReporter - Class in org.jlab.clara.std.monitor: Saves the DPE reports data into a time series database.
InfluxDbReporter() - Constructor for class org.jlab.clara.std.monitor.InfluxDbReporter: Create a reporter to the InfluxDB database on the default JLab host.
InfluxDbReporter(String) - Constructor for class org.jlab.clara.std.monitor.InfluxDbReporter: Create a reporter to the InfluxDB database on the given host.
INPUT_DIR - Static variable in class org.jlab.clara.std.cli.Config: The variable for the input directory.
isCanonicalName(String) - Static method in class org.jlab.clara.base.ClaraUtil: Checks if the given name is a proper CLARA canonical name.
isContainerName(String) - Static method in class org.jlab.clara.base.ClaraUtil: Checks if the given name is a proper container canonical name.
isDpeName(String) - Static method in class org.jlab.clara.base.ClaraUtil: Checks if the given name is a proper DPE canonical name.
isRemoteService(String) - Static method in class org.jlab.clara.base.ClaraUtil: Checks to see if the service is locally deployed.
isServiceName(String) - Static method in class org.jlab.clara.base.ClaraUtil: Checks if the given name is a proper service canonical name.

J

JAVA_MEMORY - Static variable in class org.jlab.clara.std.cli.Config: The variable for the the JVM heap size used by the DPE.
JAVA_OPTIONS - Static variable in class org.jlab.clara.std.cli.Config: The variable for the JVM options of the Java DPE (overrides Config.JAVA_MEMORY).
JSON - Static variable in class org.jlab.clara.engine.EngineDataType: JSON text.

L

language() - Method in interface org.jlab.clara.base.ClaraName: Returns the language of this CLARA component.
language() - Method in class org.jlab.clara.base.ContainerName
language() - Method in class org.jlab.clara.base.DpeName
language() - Method in class org.jlab.clara.base.ServiceName
listen(ClaraName) - Method in class org.jlab.clara.base.BaseOrchestrator: Returns a subscription builder to select what type of reports of the given service shall be listened, and what action should be called when a report is received.
listen() - Method in class org.jlab.clara.base.BaseOrchestrator: Returns a subscription builder to select what type of global reports by the front-end shall be listened, and what action should be called when a report is received.
listenDpeReports(DpeReportHandler) - Method in class org.jlab.clara.std.orchestrators.MonitorOrchestrator: Listen DPE reports.
listenDpeReports(String, DpeReportHandler) - Method in class org.jlab.clara.std.orchestrators.MonitorOrchestrator: Listen DPE reports.
listenEngineReports(EngineReportHandler) - Method in class org.jlab.clara.std.orchestrators.MonitorOrchestrator: Listen engine reports.
listenEngineReports(DataRingTopic, EngineReportHandler) - Method in class org.jlab.clara.std.orchestrators.MonitorOrchestrator: Listen engine reports.
localhost() - Static method in class org.jlab.clara.base.ClaraUtil: Gets the IPv4 value for the localhost address.
LOG_DIR - Static variable in class org.jlab.clara.std.cli.Config: The variable for the log directory.

M

main(String[]) - Static method in class org.jlab.clara.std.cli.ClaraShell
main(String[]) - Static method in class org.jlab.clara.std.monitor.InfluxDbReporter
main(String[]) - Static method in class org.jlab.clara.std.orchestrators.GenericOrchestrator
main(String[]) - Static method in class org.jlab.clara.std.orchestrators.MonitorOrchestrator
main(String[]) - Static method in class org.jlab.clara.sys.Dpe
MAX_EVENTS - Static variable in class org.jlab.clara.std.cli.Config: The variable for the number events to be processed from the input file.
MAX_THREADS - Static variable in class org.jlab.clara.std.cli.Config: The variable for the number of data processing threads.
memorySize() - Method in class org.jlab.clara.base.DpeRegistrationData: Gets the maximum amount of memory available to the DPE.
memoryUsage() - Method in class org.jlab.clara.base.DpeRuntimeData: Gets the amount of memory in use by the DPE.
mimeType() - Method in class org.jlab.clara.engine.EngineDataType: Returns the name of this data type.
MONITOR_HOST - Static variable in class org.jlab.clara.std.cli.Config: The variable for the address of the monitoring front-end.
MonitorOrchestrator - Class in org.jlab.clara.std.orchestrators: Listen to reports published to the CLARA data-ring.
MonitorOrchestrator() - Constructor for class org.jlab.clara.std.orchestrators.MonitorOrchestrator: Create a new monitor orchestrator to a default CLARA data-ring in the localhost.
MonitorOrchestrator(DataRingAddress) - Constructor for class org.jlab.clara.std.orchestrators.MonitorOrchestrator: Create a new monitor orchestrator to the given CLARA data-ring.

N

name() - Method in interface org.jlab.clara.base.ClaraName: Returns the specific name of this CLARA component.
name() - Method in class org.jlab.clara.base.ContainerName
name() - Method in class org.jlab.clara.base.ContainerRegistrationData
name() - Method in class org.jlab.clara.base.ContainerRuntimeData
name() - Method in class org.jlab.clara.base.DpeName
name() - Method in class org.jlab.clara.base.DpeRegistrationData
name() - Method in class org.jlab.clara.base.DpeRuntimeData
name() - Method in class org.jlab.clara.base.ServiceName
name() - Method in class org.jlab.clara.base.ServiceRegistrationData
name() - Method in class org.jlab.clara.base.ServiceRuntimeData
name() - Method in class org.jlab.clara.engine.EngineSpecification: Returns the name of the engine.
name - Variable in class org.jlab.clara.std.cli.AbstractCommand: The name of the command.
NATIVE_DATA - Static variable in class org.jlab.clara.engine.EngineDataType: A native xMsg data object.
NATIVE_PAYLOAD - Static variable in class org.jlab.clara.engine.EngineDataType: A native xMsg payload object.
newBuilder() - Static method in class org.jlab.clara.std.cli.ClaraShell: Creates a new builder of a CLARA shell instance.
newBuilder(String, String) - Static method in class org.jlab.clara.std.cli.ConfigVariable: Creates a new builder of a configuration variable.
numCores() - Method in class org.jlab.clara.base.DpeRegistrationData: Gets the maximum number of cores assigned to the DPE.
numFailures() - Method in class org.jlab.clara.base.ServiceRuntimeData: Gets the total number of failed requests processed by the service.
numRequests() - Method in class org.jlab.clara.base.ContainerRuntimeData: Gets the sum of all requests received by all the services running in the container.
numRequests() - Method in class org.jlab.clara.base.ServiceRuntimeData: Gets the total number of requests received by the service.

O

OrchestratorConfigException - Exception in org.jlab.clara.std.orchestrators: An error configuring the orchestrator.
OrchestratorConfigException(String) - Constructor for exception org.jlab.clara.std.orchestrators.OrchestratorConfigException: Constructs a new exception.
OrchestratorConfigException(Throwable) - Constructor for exception org.jlab.clara.std.orchestrators.OrchestratorConfigException: Constructs a new exception.
OrchestratorConfigException(String, Throwable) - Constructor for exception org.jlab.clara.std.orchestrators.OrchestratorConfigException: Constructs a new exception.
OrchestratorConfigParser - Class in org.jlab.clara.std.orchestrators: Helper class to read configuration for the standard orchestrators.
OrchestratorConfigParser(String) - Constructor for class org.jlab.clara.std.orchestrators.OrchestratorConfigParser: Creates a parser for the given configuration file.
OrchestratorException - Exception in org.jlab.clara.std.orchestrators: An error in the orchestrator.
OrchestratorException(String) - Constructor for exception org.jlab.clara.std.orchestrators.OrchestratorException: Constructs a new exception.
OrchestratorException(Throwable) - Constructor for exception org.jlab.clara.std.orchestrators.OrchestratorException: Constructs a new exception.
OrchestratorException(String, Throwable) - Constructor for exception org.jlab.clara.std.orchestrators.OrchestratorException: Constructs a new exception.
org.jlab.clara.base - package org.jlab.clara.base
org.jlab.clara.base.error - package org.jlab.clara.base.error
org.jlab.clara.engine - package org.jlab.clara.engine
org.jlab.clara.std.cli - package org.jlab.clara.std.cli
org.jlab.clara.std.monitor - package org.jlab.clara.std.monitor
org.jlab.clara.std.orchestrators - package org.jlab.clara.std.orchestrators
org.jlab.clara.std.services - package org.jlab.clara.std.services
org.jlab.clara.sys - package org.jlab.clara.sys
OUTPUT_DIR - Static variable in class org.jlab.clara.std.cli.Config: The variable for the output directory.

P

parseDataTypes() - Method in class org.jlab.clara.std.orchestrators.OrchestratorConfigParser: Returns the mime-types required to receive messages from the services.
ParseException() - Constructor for exception org.jlab.clara.engine.EngineSpecification.ParseException
ParseException(String) - Constructor for exception org.jlab.clara.engine.EngineSpecification.ParseException
ParseException(Throwable) - Constructor for exception org.jlab.clara.engine.EngineSpecification.ParseException
ParseException(String, Throwable) - Constructor for exception org.jlab.clara.engine.EngineSpecification.ParseException
parseJson() - Method in class org.jlab.clara.base.ClaraSubscriptions.BaseDpeReportSubscription: Parse the JSON report as DpeRegistrationData and DpeRuntimeData objects.
parseLanguages() - Method in class org.jlab.clara.std.orchestrators.OrchestratorConfigParser: Returns the languages of all services defined in the application.
poolSize() - Method in class org.jlab.clara.base.ServiceRegistrationData: Gets the maximum number of parallel threads assigned to the service.
printHelp(PrintWriter) - Method in class org.jlab.clara.std.cli.AbstractCommand
printHelp(PrintWriter) - Method in class org.jlab.clara.std.cli.BaseCommand
printHelp(PrintWriter) - Method in interface org.jlab.clara.std.cli.Command: Prints a detailed description of what the command does.
printStartup() - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator: Prints a startup message when the orchestrator starts to run.

Q

query() - Method in class org.jlab.clara.base.BaseOrchestrator: Returns a query builder to query the registration/runtime database to discover registered components or obtain the registration/runtime information.

R

read(ByteBuffer) - Method in interface org.jlab.clara.engine.ClaraSerializer: De-serializes the byte buffer into the user object and returns it.
readByteOrder() - Method in class org.jlab.clara.std.services.AbstractEventReaderService: Gets the byte order of the events stored in the input file.
reader - Variable in class org.jlab.clara.std.services.AbstractEventReaderService: The reader object.
readEvent(int) - Method in class org.jlab.clara.std.services.AbstractEventReaderService: Reads an event from the input file.
readEventCount() - Method in class org.jlab.clara.std.services.AbstractEventReaderService: Gets the total number of events that can be read from the input file.
registerDataTypes(EngineDataType...) - Method in class org.jlab.clara.base.BaseOrchestrator: Registers the necessary data-types to communicate data to services.
registerDataTypes(Set<EngineDataType>) - Method in class org.jlab.clara.base.BaseOrchestrator: Registers the necessary data-types to communicate data to services.
registrationData(DpeFilter) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the registration data of the selected DPEs.
registrationData(ContainerFilter) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the registration data of the selected containers.
registrationData(ServiceFilter) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the registration data of the selected services.
registrationData(DpeName) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the registration data of a specific DPE.
registrationData(ContainerName) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the registration data of a specific container.
registrationData(ServiceName) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the registration data of a specific service.
REPORT_EVENTS - Static variable in class org.jlab.clara.std.cli.Config: The variable for the report frequency of completed events.
reportException(Throwable) - Static method in class org.jlab.clara.base.ClaraUtil: Returns the stack trace of a exception as a string.
reset() - Method in interface org.jlab.clara.engine.Engine: Resets this engine to its initial setup.
reset() - Method in class org.jlab.clara.std.services.AbstractEventReaderService
reset() - Method in class org.jlab.clara.std.services.AbstractEventWriterService
reset() - Method in class org.jlab.clara.std.services.DataManager
run() - Method in class org.jlab.clara.std.cli.ClaraShell: Runs the shell accepting user commands.
runProcess(String...) - Static method in class org.jlab.clara.std.cli.CommandUtils: Runs the given CLI program as a subprocess, and waits until it is finished.
runProcess(ProcessBuilder) - Static method in class org.jlab.clara.std.cli.CommandUtils: Starts the subprocess defined by the given subprocess builder, and waits until it is finished.
runtimeData(DpeFilter) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the runtime data of the selected DPEs.
runtimeData(ContainerFilter) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the runtime data of the selected containers.
runtimeData(ServiceFilter) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the runtime data of the selected services.
runtimeData(DpeName) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the runtime data of a specific DPE.
runtimeData(ContainerName) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the runtime data of a specific container.
runtimeData(ServiceName) - Method in class org.jlab.clara.base.ClaraQueries.ClaraQueryBuilder: Creates a query to get the runtime data of a specific service.

S

serializer() - Method in class org.jlab.clara.engine.EngineDataType: Returns the serializer of this data type.
ServiceFilter - Class in org.jlab.clara.base: A filter to select services.
ServiceName - Class in org.jlab.clara.base: Unique identifier of a CLARA service.
ServiceName(ContainerName, String) - Constructor for class org.jlab.clara.base.ServiceName: Identify a service with its container and engine name.
ServiceName(DpeName, String, String) - Constructor for class org.jlab.clara.base.ServiceName: Identify a service with its DPE, container name and engine name.
ServiceName(String, ClaraLang, String, String) - Constructor for class org.jlab.clara.base.ServiceName: Identify a service with its host, language, container and engine name.
ServiceName(String) - Constructor for class org.jlab.clara.base.ServiceName: Identify a service with its canonical name.
ServiceRegistrationData - Class in org.jlab.clara.base: The registration data of a running service.
ServiceRuntimeData - Class in org.jlab.clara.base: The runtime data of a running service.
services() - Method in class org.jlab.clara.base.ContainerRegistrationData: Gets all the services running on the container.
services() - Method in class org.jlab.clara.base.ContainerRuntimeData: Gets the runtime report of all the services running on the container.
SERVICES_FILE - Static variable in class org.jlab.clara.std.cli.Config: The variable for the orchestrator configuration file.
servicesByAuthor(String) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the services of the given author.
servicesByContainer(ContainerName) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the services of the given container.
servicesByDescription(String) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the services of the given description.
servicesByDpe(DpeName) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the services of the given DPE.
servicesByHost(String) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the services of the given host.
servicesByLanguage(ClaraLang) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the services of the given language.
servicesByName(String) - Static method in class org.jlab.clara.base.ClaraFilters: Returns a filter to select all the services of the given name.
ServiceUtils - Class in org.jlab.clara.std.services: A collection of utilities to write services.
session() - Method in class org.jlab.clara.base.DataRingTopic
session() - Method in class org.jlab.clara.base.DpeRegistrationData: Gets the session used by the DPE to publish reports.
SESSION - Static variable in class org.jlab.clara.std.cli.Config: The variable for the session of the CLARA DPE.
setCommunicationId(int) - Method in class org.jlab.clara.engine.EngineData: Sets an ID for the request this data is part of.
setData(String) - Method in class org.jlab.clara.engine.EngineData: Sets a new string data for this object.
setData(EngineDataType, Object) - Method in class org.jlab.clara.engine.EngineData: Sets a new user-data for this object.
setData(String, Object) - Method in class org.jlab.clara.engine.EngineData: Sets a new user-data for this object.
setDescription(String) - Method in class org.jlab.clara.engine.EngineData: Sets a description for the data.
setError(EngineData, String) - Static method in class org.jlab.clara.std.services.ServiceUtils: Sets the given engine data with an error status.
setError(EngineData, String, int) - Static method in class org.jlab.clara.std.services.ServiceUtils: Sets the given engine data with an error status.
setError(EngineData, String, Object...) - Static method in class org.jlab.clara.std.services.ServiceUtils: Sets the given engine data with an error status.
setExecutionState(String) - Method in class org.jlab.clara.engine.EngineData: Sets an execution state for this data.
setStatus(EngineStatus) - Method in class org.jlab.clara.engine.EngineData: Sets a new status for this data.
setStatus(EngineStatus, int) - Method in class org.jlab.clara.engine.EngineData: Sets a new status for this data, with custom severity.
setValue(Object) - Method in class org.jlab.clara.std.cli.ConfigVariable: Sets this variable with a new value.
SFIXED32 - Static variable in class org.jlab.clara.engine.EngineDataType: Signed fixed integer of 32 bits.
SFIXED64 - Static variable in class org.jlab.clara.engine.EngineDataType: Signed fixed integer of 64 bits.
sharedMemoryReads() - Method in class org.jlab.clara.base.ServiceRuntimeData: Gets the total number of requests received by the service through the shared memory of the DPE.
sharedMemoryWrites() - Method in class org.jlab.clara.base.ServiceRuntimeData: Gets the total number of requests sent by the service through the shared memory of the DPE.
SINT32 - Static variable in class org.jlab.clara.engine.EngineDataType: Signed int of 32 bits.
SINT64 - Static variable in class org.jlab.clara.engine.EngineDataType: Signed int of 64 bits.
SKIP_EVENTS - Static variable in class org.jlab.clara.std.cli.Config: The variable for the number events to skip from the input file.
sleep(long) - Static method in class org.jlab.clara.base.ClaraUtil: Causes the currently executing thread to sleep for the given number of milliseconds.
sleep(long, TimeUnit) - Static method in class org.jlab.clara.base.ClaraUtil: Causes the currently executing thread to sleep for the given duration of time.
snapshotTime() - Method in class org.jlab.clara.base.ContainerRuntimeData: Gets the local time when the runtime data was collected.
snapshotTime() - Method in class org.jlab.clara.base.DpeRuntimeData: Gets the local time when the runtime data was collected.
snapshotTime() - Method in class org.jlab.clara.base.ServiceRuntimeData: Gets the local time when the runtime data was collected.
splitIntoLines(String, String, int) - Static method in class org.jlab.clara.base.ClaraUtil: Splits the input string into lines of the given maximum length.
stack2str(Exception) - Static method in class org.jlab.clara.base.ClaraUtil: Converts exception stack trace to a string.
start() - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator
start() - Method in class org.jlab.clara.sys.Dpe: Starts this DPE.
startDataReporting(int) - Method in class org.jlab.clara.base.ClaraRequests.ServiceConfigRequestBuilder: Creates a request to start reporting the output data on executions of the specified service.
startDoneReporting(int) - Method in class org.jlab.clara.base.ClaraRequests.ServiceConfigRequestBuilder: Creates a request to start reporting "done" on executions of the specified service.
startedBy() - Method in class org.jlab.clara.base.ContainerRegistrationData: Gets an identification of who started the container.
startedBy() - Method in class org.jlab.clara.base.DpeRegistrationData: Gets an identification of who started the DPE.
startedBy() - Method in class org.jlab.clara.base.ServiceRegistrationData: Gets an identification of who deployed the service.
startTime() - Method in class org.jlab.clara.base.ContainerRegistrationData: Gets the local time when the container was started.
startTime() - Method in class org.jlab.clara.base.DpeRegistrationData: Gets the local time when the DPE was started.
startTime() - Method in class org.jlab.clara.base.ServiceRegistrationData: Gets the local time when the service was started.
state() - Method in class org.jlab.clara.base.DataRingTopic
status(EngineStatus) - Method in class org.jlab.clara.base.ClaraSubscriptions.ServiceSubscriptionBuilder: A subscription to the specified status reports of the selected service.
stop() - Method in class org.jlab.clara.sys.Dpe: Shuts down this DPE.
stopDataReporting() - Method in class org.jlab.clara.base.ClaraRequests.ServiceConfigRequestBuilder: Creates a request to stop reporting the output data on executions of the specified service.
stopDoneReporting() - Method in class org.jlab.clara.base.ClaraRequests.ServiceConfigRequestBuilder: Creates a request to stop reporting "done" on executions of the specified service.
STRING - Static variable in class org.jlab.clara.engine.EngineDataType: A string.
subCommands - Variable in class org.jlab.clara.std.cli.BaseCommand: The supported subcommands.
systemLoad() - Method in class org.jlab.clara.base.DpeRuntimeData: Gets the system load average of the node where the DPE is running.

T

terminal - Variable in class org.jlab.clara.std.cli.AbstractCommand: The virtual terminal used by the shell.
terminal() - Method in class org.jlab.clara.std.cli.Context: Gets the virtual terminal used by the shell.
toAlphaNum(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a single alphanumeric word.
toAlphaNumOrEmpty(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a single alphanumeric word.
toBoolean(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a boolean.
toDirectory(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a directory path string.
toDouble(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a double.
toExistingDirectory(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into an existing directory path string.
toExistingFile(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into an existing file path string.
toFile(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a file path string.
toFloat(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a float.
toHostAddress(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into an IPv4 address.
toInteger(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into an integer.
toLong(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a long.
toNonNegativeInteger(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a non negative integer.
toPositiveInteger(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a positive integer.
toPositiveLong(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a positive long.
toString() - Method in enum org.jlab.clara.base.ClaraLang
toString() - Method in class org.jlab.clara.base.Composition
toString() - Method in class org.jlab.clara.base.ContainerName
toString() - Method in class org.jlab.clara.base.DataRingTopic
toString() - Method in class org.jlab.clara.base.DpeName
toString() - Method in class org.jlab.clara.base.ServiceName
toString() - Method in class org.jlab.clara.engine.EngineData
toString() - Method in class org.jlab.clara.engine.EngineDataType
toString() - Method in class org.jlab.clara.engine.EngineSpecification
toString(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a string.
toStringOrEmpty(String...) - Static method in class org.jlab.clara.std.cli.ConfigParsers: Parses the set command arguments into a string.
type() - Method in class org.jlab.clara.engine.EngineSpecification: Returns the type of the engine (java, cpp, python).

U

uninterruptibleCommand(String...) - Static method in class org.jlab.clara.std.cli.CommandUtils: Wraps the given CLI program into a script that ignores when the user presses CTRL-C.
uninterruptibleCommand(String[], String) - Static method in class org.jlab.clara.std.cli.CommandUtils: Wraps the given CLI program into a script that ignores when the user presses CTRL-C.
useFrontEnd() - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Uses the front-end for data processing.
user() - Static method in class org.jlab.clara.std.cli.Config: Gets the user name.
useStageDirectory() - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Stages the input file on the node for local access.

V

valueOf(String) - Static method in enum org.jlab.clara.base.ClaraLang: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jlab.clara.engine.EngineStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jlab.clara.base.ClaraLang: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jlab.clara.engine.EngineStatus: Returns an array containing the constants of this enum type, in the order they are declared.
version() - Method in class org.jlab.clara.base.ServiceRegistrationData: Gets the version string of the deployed service class.
version() - Method in class org.jlab.clara.engine.EngineSpecification: Returns the version of the engine.

W

withBuiltinCommand(String, String, List<String>) - Method in class org.jlab.clara.std.cli.ClaraShell.Builder: Adds a new builtin command to the CLARA shell session.
withBuiltinCommand(String, String, String...) - Method in class org.jlab.clara.std.cli.ClaraShell.Builder: Adds a new builtin command to the CLARA shell session.
withBuiltinCommand(CommandFactory) - Method in class org.jlab.clara.std.cli.ClaraShell.Builder: Adds a new builtin command to the CLARA shell session.
withCompleter(Completer) - Method in class org.jlab.clara.std.cli.ConfigVariable.Builder: Sets the shell completer to show the tab-completion candidates when setting the variable to a new value.
withConfiguration(Consumer<Config.Builder>) - Method in class org.jlab.clara.std.cli.ClaraShell.Builder: Customizes the configuration variables of the shell session.
withConfigVariable(String, Object) - Method in class org.jlab.clara.std.cli.Config.Builder: Sets a configuration variable with the given initial value.
withConfigVariable(ConfigVariable.Builder) - Method in class org.jlab.clara.std.cli.Config.Builder: Adds a configuration variable.
withData(EngineData) - Method in class org.jlab.clara.base.ClaraRequests.ServiceConfigRequestBuilder: Creates a request to configure the specified service with the given data.
withData(EngineData) - Method in class org.jlab.clara.base.ClaraRequests.ServiceExecuteRequestBuilder: Creates a request to execute the specified service/composition with the given data.
withDataTypes(Set<EngineDataType>) - Method in class org.jlab.clara.base.ClaraSubscriptions.ServiceSubscription: Overwrites the data types used for deserializing the data from the service.
withDataTypes(EngineDataType...) - Method in class org.jlab.clara.base.ClaraSubscriptions.ServiceSubscription: Overwrites the data types used for deserializing the data from the service.
withDescription(String) - Method in class org.jlab.clara.sys.Dpe.Builder: Sets a description for this DPE.
withEditSubCommand(String, String, Function<Config, String>) - Method in class org.jlab.clara.std.cli.ClaraShell.Builder: Adds a new subcommand to the edit builtin command.
withEnvironmentVariable(String, String) - Method in class org.jlab.clara.std.cli.Config.Builder: Sets an environment variable for commands.
withExpectedValues(Object...) - Method in class org.jlab.clara.std.cli.ConfigVariable.Builder: Sets the expected values for the variable.
withFrontEnd(DpeName) - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Sets the name of the front-end.
withHost(String) - Method in class org.jlab.clara.sys.Dpe.Builder: Uses the given host for the local address.
withInitialState(String) - Method in class org.jlab.clara.base.ClaraRequests.DeployServiceRequest: Defines an initial state for the started service.
withInitialValue(Object) - Method in class org.jlab.clara.std.cli.ConfigVariable.Builder: Sets the default value for the variable.
withInputDirectory(String) - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Changes the path of the shared input directory.
withMaxCores(int) - Method in class org.jlab.clara.sys.Dpe.Builder: Sets the number of cores that a service can use in parallel.
withMaxEvents(int) - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Sets the maximum number of events to read.
withMaxNodes(int) - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Sets the maximum number of nodes to be used for data processing.
withMaxThreads(int) - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Sets the maximum number of threads to be used for data processing on every node.
withOutputDirectory(String) - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Changes the path of the shared output directory.
withParser(Function<String[], Object>) - Method in class org.jlab.clara.std.cli.ConfigVariable.Builder: Sets the function to transform the shell arguments into the value stored in the variable.
withPoolSize(int) - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Sets the size of the thread-pool that will process reports from services and nodes.
withPoolSize(int) - Method in class org.jlab.clara.sys.Dpe.Builder: Sets the size of the thread-pool that will process requests.
withPort(int) - Method in class org.jlab.clara.sys.Dpe.Builder: Uses the given port for the local address.
withReportFrequency(int) - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Sets the frequency of the "done" event reports.
withReportPeriod(long, TimeUnit) - Method in class org.jlab.clara.sys.Dpe.Builder: Sets the interval of time between publishing reports.
withRunSubCommand(CommandFactory) - Method in class org.jlab.clara.std.cli.ClaraShell.Builder: Adds a new subcommand to the run builtin command.
withScript(Path) - Method in class org.jlab.clara.std.cli.ClaraShell.Builder: Sets the script to be executed by the shell in non-interactive mode.
withSession(String) - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Sets the session used by the DPEs of interest.
withSession(String) - Method in class org.jlab.clara.sys.Dpe.Builder: Sets a session for this DPE.
withSkipEvents(int) - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Sets the number of events to skip.
withStageDirectory(String) - Method in class org.jlab.clara.std.orchestrators.GenericOrchestrator.Builder: Changes the path of the local staging directory.
write(Object) - Method in interface org.jlab.clara.engine.ClaraSerializer: Serializes the user object into a byte buffer and returns it.
writeEvent(Object) - Method in class org.jlab.clara.std.services.AbstractEventWriterService: Writes an event to the output file.
writer - Variable in class org.jlab.clara.std.cli.AbstractCommand: The text-output stream of the terminal.
writer - Variable in class org.jlab.clara.std.services.AbstractEventWriterService: The writer object.

A B C D E F G H I J L M N O P Q R S T U V W