public class RemoteControlModule extends AbstractModule implements HandlerDecoratingModule
To use it one has to register the module.
By default the endpoint is registered under /remote-control
. This can be configured using setPath(String)
or
other.remoteControl.path
configuration property.
The endpoint is not registered unless other.remoteControl.enabled
configuration property is set to true
or reloading
is enabled. This is so that you have to explicitly enable it, for example when integration testing the application, and it's harder
to make a mistake of keeping it on for production. Securing the endpoint when used in production is left for the users to implement if desired.
Command context is populated with the registry of the remote application which is available as registry
variable.
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_REMOTE_CONTROL_PATH |
Constructor and Description |
---|
RemoteControlModule() |
Modifier and Type | Method and Description |
---|---|
protected void |
configure() |
Handler |
decorate(Injector injector,
Handler handler)
Decorate the given handler with any global logic.
|
String |
getPath() |
void |
setPath(String path) |
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding
public static final String DEFAULT_REMOTE_CONTROL_PATH
public String getPath()
public void setPath(String path)
protected void configure()
configure
in class AbstractModule
public Handler decorate(Injector injector, Handler handler)
HandlerDecoratingModule
decorate
in interface HandlerDecoratingModule
injector
- The injector created from all the application moduleshandler
- The application handler