Replacing standard actions from a Java plugin

andreasch · October 8, 2012, 6:56pm

I created a plugin that tries to replace the standard index action with my
own implementation. In my plugin, I have the following method:
@Override
public void processModule(Module module) {

            logger.info("Processing module");

if (module instanceof ActionModule) {
ActionModule actionModule = (ActionModule) module;
logger.info("Found action module");
actionModule.registerAction(IndexAction.INSTANCE, CustomIndexAction.class);
logger.info("Registered custom index action in
place of standard index action");
}
}
I can see all the log statements during startup. However, the custom action
never gets executed. I debugged the custom plugin and action in an embedded
ElasticSearch and I noticed that the processModule() of my custom plugin
gets called first and then the configure() method of the ActionModule is
called overriding my custom action.

Is this intentional or is this a defect?

Thanks,
Andreas

--

Ivan · October 8, 2012, 8:10pm

I cannot say if it is intentional or not, but it definitely seems like your
custom action is getting added to the action map first, and then
getting overridden later.

I wonder if the flow would be different if you used the onModule method
instead of processModule:

public void onModule(ActionModule  actionModule ) {
    actionModule.registerAction(IndexAction.INSTANCE,

CustomIndexAction.class);
}

Probably not, but worth a try.

--
Ivan

On Mon, Oct 8, 2012 at 11:56 AM, Andreas Christoforides <
andreas.christoforides@gmail.com> wrote:

I created a plugin that tries to replace the standard index action with my
own implementation. In my plugin, I have the following method:
@Override
public void processModule(Module module) {
            logger.info("Processing module");
if (module instanceof ActionModule) {
ActionModule actionModule = (ActionModule) module;
logger.info("Found action module");
actionModule.registerAction(IndexAction.INSTANCE, CustomIndexAction.class);
logger.info("Registered custom index action in
place of standard index action");
}
}
I can see all the log statements during startup. However, the custom
action never gets executed. I debugged the custom plugin and action in an
embedded Elasticsearch and I noticed that the processModule() of my custom
plugin gets called first and then the configure() method of the
ActionModule is called overriding my custom action.

Is this intentional or is this a defect?

Thanks,
Andreas

--

--

andreasch · October 8, 2012, 8:24pm

Ivan,

I cannot find onModule() anywhere in the Elasticsearch API.

Andreas

On Monday, October 8, 2012 1:10:37 PM UTC-7, Ivan Brusic wrote:

I cannot say if it is intentional or not, but it definitely seems like
your custom action is getting added to the action map first, and then
getting overridden later.

I wonder if the flow would be different if you used the onModule method
instead of processModule:
public void onModule(ActionModule  actionModule ) {
    actionModule.registerAction(IndexAction.INSTANCE, 
CustomIndexAction.class);
}

Probably not, but worth a try.

--
Ivan

On Mon, Oct 8, 2012 at 11:56 AM, Andreas Christoforides <
andreas.chr...@gmail.com <javascript:>> wrote:
I created a plugin that tries to replace the standard index action with
my own implementation. In my plugin, I have the following method:
@Override
public void processModule(Module module) {
            logger.info("Processing module");
if (module instanceof ActionModule) {
ActionModule actionModule = (ActionModule) module;
logger.info("Found action module");

actionModule.registerAction(IndexAction.INSTANCE, CustomIndexAction.class);
logger.info("Registered custom index action in
place of standard index action");
}
}
I can see all the log statements during startup. However, the custom
action never gets executed. I debugged the custom plugin and action in an
embedded Elasticsearch and I noticed that the processModule() of my custom
plugin gets called first and then the configure() method of the
ActionModule is called overriding my custom action.

Is this intentional or is this a defect?

Thanks,
Andreas

--

--

Ivan · October 8, 2012, 8:43pm

The method is called via reflection, so it is not overridden from the base
class. See more info here:

github.com/elastic/elasticsearch

Plugins: Allow for plugins to implement onModule method that will be automatically injected with the relevant module type

opened 02:42PM - 15 Jan 12 UTC

closed 02:42PM - 15 Jan 12 UTC

kimchy

>feature v0.19.0.RC1

Currently, to add custom injections to different modules, plugins need to implem…ent `processModule` method and then do instanceof checks. Allow for plugins to implement an `onModule` method that will be injected automatically with the parameter module type. For example: `onModule(AnalyzerModule module) {...}`.

All of the official plugins should no longer use processModule. For
example, this is the RabbitMQ plugin:

github.com

elastic/elasticsearch-river-rabbitmq/blob/master/src/main/java/org/elasticsearch/plugin/river/rabbitmq/RabbitmqRiverPlugin.java

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.plugin.river.rabbitmq;

This file has been truncated. show original

--
Ivan

On Mon, Oct 8, 2012 at 1:24 PM, Andreas Christoforides <
andreas.christoforides@gmail.com> wrote:

Ivan,

I cannot find onModule() anywhere in the Elasticsearch API.

Andreas

On Monday, October 8, 2012 1:10:37 PM UTC-7, Ivan Brusic wrote:
I cannot say if it is intentional or not, but it definitely seems like
your custom action is getting added to the action map first, and then
getting overridden later.

I wonder if the flow would be different if you used the onModule method
instead of processModule:
public void onModule(ActionModule  actionModule ) {
    actionModule.registerAction(**IndexAction.INSTANCE,
CustomIndexAction.class);
}

Probably not, but worth a try.

--
Ivan

On Mon, Oct 8, 2012 at 11:56 AM, Andreas Christoforides <
andreas.chr...@gmail.**com> wrote:
I created a plugin that tries to replace the standard index action with
my own implementation. In my plugin, I have the following method:
@Override
public void processModule(Module module) {
            logger.info("Processing module");
if (module instanceof ActionModule) {
ActionModule actionModule = (ActionModule) module;
logger.info("Found action module");
actionModule.registerAction(**IndexAction.INSTANCE, **
CustomIndexAction.class);
logger.info("Registered custom index action in
place of standard index action");
}
}
I can see all the log statements during startup. However, the custom
action never gets executed. I debugged the custom plugin and action in an
embedded Elasticsearch and I noticed that the processModule() of my custom
plugin gets called first and then the configure() method of the
ActionModule is called overriding my custom action.

Is this intentional or is this a defect?

Thanks,
Andreas

--
--

--

andreasch · October 8, 2012, 8:50pm

I added the onModule method in the plugin. Both methods are called before
the initialization of the ActionModule.

I am trying to change the way the index action executes Specifically, I
would like to change the routing before the index action executes.

Any other way I can accomplish that besides using a plugin that registers a
custom action?

Andreas

On Monday, October 8, 2012 1:24:44 PM UTC-7, Andreas Christoforides wrote:

Ivan,

I cannot find onModule() anywhere in the Elasticsearch API.

Andreas

On Monday, October 8, 2012 1:10:37 PM UTC-7, Ivan Brusic wrote:
I cannot say if it is intentional or not, but it definitely seems like
your custom action is getting added to the action map first, and then
getting overridden later.

I wonder if the flow would be different if you used the onModule method
instead of processModule:
public void onModule(ActionModule  actionModule ) {
    actionModule.registerAction(IndexAction.INSTANCE, 
CustomIndexAction.class);
}

Probably not, but worth a try.

--
Ivan

On Mon, Oct 8, 2012 at 11:56 AM, Andreas Christoforides <
andreas.chr...@gmail.com> wrote:
I created a plugin that tries to replace the standard index action with
my own implementation. In my plugin, I have the following method:
@Override
public void processModule(Module module) {
            logger.info("Processing module");
if (module instanceof ActionModule) {
ActionModule actionModule = (ActionModule) module;
logger.info("Found action module");

actionModule.registerAction(IndexAction.INSTANCE, CustomIndexAction.class);
logger.info("Registered custom index action in
place of standard index action");
}
}
I can see all the log statements during startup. However, the custom
action never gets executed. I debugged the custom plugin and action in an
embedded Elasticsearch and I noticed that the processModule() of my custom
plugin gets called first and then the configure() method of the
ActionModule is called overriding my custom action.

Is this intentional or is this a defect?

Thanks,
Andreas

--

--

andreasch · October 9, 2012, 4:22pm

Should I submit a feature request/issue for this?

On Monday, October 8, 2012 1:50:18 PM UTC-7, Andreas Christoforides wrote:

I added the onModule method in the plugin. Both methods are called before
the initialization of the ActionModule.

I am trying to change the way the index action executes Specifically, I
would like to change the routing before the index action executes.

Any other way I can accomplish that besides using a plugin that registers
a custom action?

Andreas

On Monday, October 8, 2012 1:24:44 PM UTC-7, Andreas Christoforides wrote:
Ivan,

I cannot find onModule() anywhere in the Elasticsearch API.

Andreas

On Monday, October 8, 2012 1:10:37 PM UTC-7, Ivan Brusic wrote:
I cannot say if it is intentional or not, but it definitely seems like
your custom action is getting added to the action map first, and then
getting overridden later.

I wonder if the flow would be different if you used the onModule method
instead of processModule:
public void onModule(ActionModule  actionModule ) {
    actionModule.registerAction(IndexAction.INSTANCE, 
CustomIndexAction.class);
}

Probably not, but worth a try.

--
Ivan

On Mon, Oct 8, 2012 at 11:56 AM, Andreas Christoforides <
andreas.chr...@gmail.com> wrote:
I created a plugin that tries to replace the standard index action with
my own implementation. In my plugin, I have the following method:
@Override
public void processModule(Module module) {
            logger.info("Processing module");
if (module instanceof ActionModule) {
ActionModule actionModule = (ActionModule) module;
logger.info("Found action module");

actionModule.registerAction(IndexAction.INSTANCE, CustomIndexAction.class);
logger.info("Registered custom index action in
place of standard index action");
}
}
I can see all the log statements during startup. However, the custom
action never gets executed. I debugged the custom plugin and action in an
embedded Elasticsearch and I noticed that the processModule() of my custom
plugin gets called first and then the configure() method of the
ActionModule is called overriding my custom action.

Is this intentional or is this a defect?

Thanks,
Andreas

--

--

andreasch · October 9, 2012, 4:39pm

I submitted an issue about this:

On Tuesday, October 9, 2012 9:22:06 AM UTC-7, Andreas Christoforides wrote:

Should I submit a feature request/issue for this?

On Monday, October 8, 2012 1:50:18 PM UTC-7, Andreas Christoforides wrote:
I added the onModule method in the plugin. Both methods are called before
the initialization of the ActionModule.

I am trying to change the way the index action executes Specifically, I
would like to change the routing before the index action executes.

Any other way I can accomplish that besides using a plugin that registers
a custom action?

Andreas

On Monday, October 8, 2012 1:24:44 PM UTC-7, Andreas Christoforides wrote:
Ivan,

I cannot find onModule() anywhere in the Elasticsearch API.

Andreas

On Monday, October 8, 2012 1:10:37 PM UTC-7, Ivan Brusic wrote:
I cannot say if it is intentional or not, but it definitely seems like
your custom action is getting added to the action map first, and then
getting overridden later.

I wonder if the flow would be different if you used the onModule method
instead of processModule:
public void onModule(ActionModule  actionModule ) {
    actionModule.registerAction(IndexAction.INSTANCE, 
CustomIndexAction.class);
}

Probably not, but worth a try.

--
Ivan

On Mon, Oct 8, 2012 at 11:56 AM, Andreas Christoforides <
andreas.chr...@gmail.com> wrote:
I created a plugin that tries to replace the standard index action
with my own implementation. In my plugin, I have the following method:
@Override
public void processModule(Module module) {
            logger.info("Processing module");
if (module instanceof ActionModule) {
ActionModule actionModule = (ActionModule) module;
logger.info("Found action module");

actionModule.registerAction(IndexAction.INSTANCE, CustomIndexAction.class);
logger.info("Registered custom index action
in place of standard index action");
}
}
I can see all the log statements during startup. However, the custom
action never gets executed. I debugged the custom plugin and action in an
embedded Elasticsearch and I noticed that the processModule() of my custom
plugin gets called first and then the configure() method of the
ActionModule is called overriding my custom action.

Is this intentional or is this a defect?

Thanks,
Andreas

--

--