Skip navigation links
A C D E G R S V 

A

addHandler(CommandHandler<? extends Command<? extends CommandResponse>, ? extends CommandResponse>) - Method in interface com.clearlydecoded.commander.CommandHandlerRegistry
Adds commandHandler to the commandHandler registry.
addHandler(CommandHandler<? extends Command<? extends CommandResponse>, ? extends CommandResponse>) - Method in class com.clearlydecoded.commander.DefaultCommandHandlerRegistry
 
addHandlers(List<? extends CommandHandler<? extends Command<? extends CommandResponse>, ? extends CommandResponse>>) - Method in interface com.clearlydecoded.commander.CommandHandlerRegistry
Adds commandHandlers to the handler registry.
addHandlers(List<? extends CommandHandler<? extends Command<? extends CommandResponse>, ? extends CommandResponse>>) - Method in class com.clearlydecoded.commander.DefaultCommandHandlerRegistry
 

C

com.clearlydecoded.commander - package com.clearlydecoded.commander
 
com.clearlydecoded.commander.discovery - package com.clearlydecoded.commander.discovery
 
com.clearlydecoded.commander.documentation - package com.clearlydecoded.commander.documentation
 
com.clearlydecoded.commander.rest - package com.clearlydecoded.commander.rest
 
Command<T extends CommandResponse> - Interface in com.clearlydecoded.commander
Command interface represents a command the client can execute.
CommandHandler<CommandT extends Command<CommandResponseT>,CommandResponseT extends CommandResponse> - Interface in com.clearlydecoded.commander
CommandHandler interface defines methods which allow its implementations to do the actual work of processing a concrete type of Command implementation and produce a response that is a concerete implementation of CommandResponse.
CommandHandlerDiscoverer - Interface in com.clearlydecoded.commander.discovery
CommandHandlerDiscoverer interface defines a method that discovers all command handlers within the system (however that's done), which implement CommandHandler interface.
CommandHandlerRegistry - Interface in com.clearlydecoded.commander
CommandHandlerRegistry interface defines methods for adding, removing, and retrieving CommandHandlers based on the type of the Command.
CommandHandlerVerifier - Class in com.clearlydecoded.commander.discovery
CommandHandlerVerifier class is a helper class that makes sure that a CommandHandler is coded properly such that its string-based command type matches the string-based type of the Java Command class that the handler is typed with.
CommandHandlerVerifier() - Constructor for class com.clearlydecoded.commander.discovery.CommandHandlerVerifier
 
CommandResponse - Interface in com.clearlydecoded.commander
CommandResponse interface represents the response returned from executing a Command.
CommandWithJustType - Class in com.clearlydecoded.commander.rest
CommandWithJustType class represents a command, which contains only the type property, to be used to deserialize the command string coming as payload of the REST request.
CommandWithJustType() - Constructor for class com.clearlydecoded.commander.rest.CommandWithJustType
 

D

DefaultCommandHandlerRegistry - Class in com.clearlydecoded.commander
DefaultCommandHandlerRegistry class is the default implementation of the CommandHandlerRegistry interface.
DefaultCommandHandlerRegistry() - Constructor for class com.clearlydecoded.commander.DefaultCommandHandlerRegistry
 
discoverCommandHandlersAndCreateRegistry(ApplicationContext) - Static method in class com.clearlydecoded.commander.discovery.SpringCommandHandlerRegistryFactory
 
discoverHandlers() - Method in interface com.clearlydecoded.commander.discovery.CommandHandlerDiscoverer
This method scans the system for concrete command handler implementations of CommandHandler interface.
discoverHandlers() - Method in class com.clearlydecoded.commander.discovery.SpringCommandHandlerDiscoverer
 

E

execute(CommandT) - Method in interface com.clearlydecoded.commander.CommandHandler
Executes the command, producing command response of class type which is embedded in the type of command.

G

generateDocumentation(CommandHandler) - Static method in class com.clearlydecoded.commander.documentation.RestCommandHandlerDocumentationGenerator
Generates REST friendly documentation for the provided commandHandler.
getCompatibleCommandClassType() - Method in interface com.clearlydecoded.commander.CommandHandler
Retrieves class type of the command this handler is to able to process.
getCompatibleCommandResponseClassType() - Method in interface com.clearlydecoded.commander.CommandHandler
Retrieves class type of the command response this handler is set to return.
getCompatibleCommandType() - Method in interface com.clearlydecoded.commander.CommandHandler
Retrieves command type identifier that this handler is able to process.
getHandlerFor(String) - Method in interface com.clearlydecoded.commander.CommandHandlerRegistry
Retrieves concrete CommandHandler for the type of the command.
getHandlerFor(String) - Method in class com.clearlydecoded.commander.DefaultCommandHandlerRegistry
 
getHandlers() - Method in interface com.clearlydecoded.commander.CommandHandlerRegistry
Retrieve all handlers successfully registered in the command handler registry.
getHandlers() - Method in class com.clearlydecoded.commander.DefaultCommandHandlerRegistry
 
getType() - Method in interface com.clearlydecoded.commander.Command
Getter for string-based command type identifier.
getType() - Method in class com.clearlydecoded.commander.rest.CommandWithJustType
 

R

removeHandler(String) - Method in interface com.clearlydecoded.commander.CommandHandlerRegistry
Removes command handler which handles commandtype type of Command from the handler registry.
removeHandler(String) - Method in class com.clearlydecoded.commander.DefaultCommandHandlerRegistry
 
RestCommandHandlerDocumentation - Class in com.clearlydecoded.commander.documentation
RestCommandHandlerDocumentation class represents REST JSON documentation for a CommandHandler.
RestCommandHandlerDocumentation() - Constructor for class com.clearlydecoded.commander.documentation.RestCommandHandlerDocumentation
 
RestCommandHandlerDocumentationGenerator - Class in com.clearlydecoded.commander.documentation
RestCommandHandlerDocumentationGenerator is a utility class that produces JSON-based documentation for CommandHandlers.
RestCommandHandlerDocumentationGenerator() - Constructor for class com.clearlydecoded.commander.documentation.RestCommandHandlerDocumentationGenerator
 

S

SpringCommandHandlerDiscoverer - Class in com.clearlydecoded.commander.discovery
SpringCommandHandlerDiscoverer class is a Spring Framework implementation of the CommandHandlerDiscoverer interface.
SpringCommandHandlerDiscoverer(ApplicationContext) - Constructor for class com.clearlydecoded.commander.discovery.SpringCommandHandlerDiscoverer
Constructor.
SpringCommandHandlerRegistryFactory - Class in com.clearlydecoded.commander.discovery
SpringCommandHandlerRegistryFactory class creates a registry that contains automatically discovered classes that implement CommandHandlers.
SpringCommandHandlerRegistryFactory() - Constructor for class com.clearlydecoded.commander.discovery.SpringCommandHandlerRegistryFactory
 
SpringRestCommander - Class in com.clearlydecoded.commander.rest
SpringRestCommander class is a REST controller which wires itself to listen on '/execute' URI, or a custom configured URI (through 'com.clearlydecoded.commander.endpoint.uri' property) and execute auto-discovered command handlers which implemente the CommandHandler interface and are injected into the Spring Context either manually or by using Spring annotations such as Service, Component, etc.
SpringRestCommander(ApplicationContext) - Constructor for class com.clearlydecoded.commander.rest.SpringRestCommander
Constructor.
SpringRestCommander(CommandHandlerRegistry) - Constructor for class com.clearlydecoded.commander.rest.SpringRestCommander
Constructor.

V

verifyCommandHandlerCompatibility(CommandHandler<? extends Command<? extends CommandResponse>, ? extends CommandResponse>) - Static method in class com.clearlydecoded.commander.discovery.CommandHandlerVerifier
Verifies that the commandHandler is associated with a concrete Command class that is implemented with the exact same string command type identifier as the commandHandler type safe concrete Command implementation.
A C D E G R S V 
Skip navigation links

Copyright © 2018. All rights reserved.