com.clearlydecoded.commander.rest

Class SpringRestCommander

java.lang.Object

com.clearlydecoded.commander.rest.SpringRestCommander

public class SpringRestCommander
extends Object

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.

Author:

Yaakov Chaikin (yaakov@ClearlyDecoded.com)

Constructor Summary

Constructors

Constructor and Description
SpringRestCommander(org.springframework.context.ApplicationContext springContext) Constructor.
SpringRestCommander(CommandHandlerRegistry commandHandlerRegistry) Constructor.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpringRestCommander

public SpringRestCommander(org.springframework.context.ApplicationContext springContext)

Constructor.

Use this constructor unless your application needs direct access to the CommandHandlerRegistry. (Hint: in majority of cases, you don't need CommandHandlerRegistry to be available directly in Spring Context.

Parameters:

springContext - Spring Application Context.

SpringRestCommander

public SpringRestCommander(CommandHandlerRegistry commandHandlerRegistry)

Constructor.

Use this constructor if you manually created CommandHandlerRegistry. Usually, you would want to do this if you manually injected CommandHandlerRegistry into Spring Context for some reason (e.g., you want to look up registered command handlers in your own code, outside of SpringRestCommander). To create CommandHandlerRegistry populated with automatically discovered command handlers, use SpringCommandHandlerRegistryFactory class.

Parameters:

commandHandlerRegistry - Command handler registry used to look up command handlers based on the type identifier of a command received through the REST call.