-
Notifications
You must be signed in to change notification settings - Fork 551
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
539 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| /* | ||
| * Licensed to CRATE Technology GmbH ("Crate") under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with this work for | ||
| * additional information regarding copyright ownership. Crate 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. | ||
| * | ||
| * However, if you have executed another commercial license agreement | ||
| * with Crate these terms will supersede the license and you may use the | ||
| * software solely pursuant to the terms of the relevant commercial agreement. | ||
| */ | ||
|
|
||
| package io.crate; | ||
|
|
||
| import org.elasticsearch.common.component.LifecycleComponent; | ||
| import org.elasticsearch.common.inject.Module; | ||
| import org.elasticsearch.common.settings.Settings; | ||
| import org.elasticsearch.index.CloseableIndexComponent; | ||
|
|
||
| import java.util.Collection; | ||
|
|
||
| /** | ||
| * An extension point allowing to plug in custom functionality. | ||
| * <p/> | ||
| * A plugin may implement a constructor with a {@link Settings} argument, which will be called | ||
| * preferred to an empty one. | ||
| */ | ||
| public interface Plugin { | ||
|
|
||
| /** | ||
| * The name of the plugin. | ||
| */ | ||
| public String name(); | ||
|
|
||
| /** | ||
| * The description of the plugin. | ||
| */ | ||
| public String description(); | ||
|
|
||
| /** | ||
| * Node level modules (classes, will automatically be created). | ||
| */ | ||
| public Collection<Class<? extends Module>> modules(); | ||
|
|
||
| /** | ||
| * Node level modules (instances) | ||
| * | ||
| * @param settings The node level settings. | ||
| */ | ||
| public Collection<? extends Module> modules(Settings settings); | ||
|
|
||
| /** | ||
| * Node level services that will be automatically started/stopped/closed. | ||
| */ | ||
| public Collection<Class<? extends LifecycleComponent>> services(); | ||
|
|
||
| /** | ||
| * Per index modules. | ||
| */ | ||
| public Collection<Class<? extends Module>> indexModules(); | ||
|
|
||
| /** | ||
| * Per index modules. | ||
| */ | ||
| public Collection<? extends Module> indexModules(Settings settings); | ||
|
|
||
| /** | ||
| * Per index services that will be automatically closed. | ||
| */ | ||
| public Collection<Class<? extends CloseableIndexComponent>> indexServices(); | ||
|
|
||
| /** | ||
| * Per index shard module. | ||
| */ | ||
| public Collection<Class<? extends Module>> shardModules(); | ||
|
|
||
| /** | ||
| * Per index shard module. | ||
| */ | ||
| public Collection<? extends Module> shardModules(Settings settings); | ||
|
|
||
| /** | ||
| * Per index shard service that will be automatically closed. | ||
| */ | ||
| public Collection<Class<? extends CloseableIndexComponent>> shardServices(); | ||
|
|
||
| /** | ||
| * Process a specific module. Note, its simpler to implement a custom <tt>onModule(AnyModule module)</tt> | ||
| * method, which will be automatically be called by the relevant type. | ||
| */ | ||
| public void processModule(Module module); | ||
|
|
||
| /** | ||
| * Additional node settings loaded by the plugin | ||
| */ | ||
| public Settings additionalSettings(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| /* | ||
| * Licensed to CRATE Technology GmbH ("Crate") under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with this work for | ||
| * additional information regarding copyright ownership. Crate 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. | ||
| * | ||
| * However, if you have executed another commercial license agreement | ||
| * with Crate these terms will supersede the license and you may use the | ||
| * software solely pursuant to the terms of the relevant commercial agreement. | ||
| */ | ||
|
|
||
| package io.crate.plugin; | ||
|
|
||
| import com.google.common.collect.ImmutableList; | ||
| import io.crate.Plugin; | ||
| import org.elasticsearch.common.component.LifecycleComponent; | ||
| import org.elasticsearch.common.inject.Module; | ||
| import org.elasticsearch.common.settings.ImmutableSettings; | ||
| import org.elasticsearch.common.settings.Settings; | ||
| import org.elasticsearch.index.CloseableIndexComponent; | ||
|
|
||
| import java.util.Collection; | ||
|
|
||
| /** | ||
| * A base class for a plugin. | ||
| */ | ||
| public abstract class AbstractPlugin implements Plugin { | ||
|
|
||
| /** | ||
| * Defaults to return an empty list. | ||
| */ | ||
| @Override | ||
| public Collection<Class<? extends Module>> modules() { | ||
| return ImmutableList.of(); | ||
| } | ||
|
|
||
| /** | ||
| * Defaults to return an empty list. | ||
| */ | ||
| @Override | ||
| public Collection<Module> modules(Settings settings) { | ||
| return ImmutableList.of(); | ||
| } | ||
|
|
||
| /** | ||
| * Defaults to return an empty list. | ||
| */ | ||
| @Override | ||
| public Collection<Class<? extends LifecycleComponent>> services() { | ||
| return ImmutableList.of(); | ||
| } | ||
|
|
||
| /** | ||
| * Defaults to return an empty list. | ||
| */ | ||
| @Override | ||
| public Collection<Class<? extends Module>> indexModules() { | ||
| return ImmutableList.of(); | ||
| } | ||
|
|
||
| /** | ||
| * Defaults to return an empty list. | ||
| */ | ||
| @Override | ||
| public Collection<Module> indexModules(Settings settings) { | ||
| return ImmutableList.of(); | ||
| } | ||
|
|
||
| /** | ||
| * Defaults to return an empty list. | ||
| */ | ||
| @Override | ||
| public Collection<Class<? extends CloseableIndexComponent>> indexServices() { | ||
| return ImmutableList.of(); | ||
| } | ||
|
|
||
| /** | ||
| * Defaults to return an empty list. | ||
| */ | ||
| @Override | ||
| public Collection<Class<? extends Module>> shardModules() { | ||
| return ImmutableList.of(); | ||
| } | ||
|
|
||
| /** | ||
| * Defaults to return an empty list. | ||
| */ | ||
| @Override | ||
| public Collection<Module> shardModules(Settings settings) { | ||
| return ImmutableList.of(); | ||
| } | ||
|
|
||
| /** | ||
| * Defaults to return an empty list. | ||
| */ | ||
| @Override | ||
| public Collection<Class<? extends CloseableIndexComponent>> shardServices() { | ||
| return ImmutableList.of(); | ||
| } | ||
|
|
||
| @Override | ||
| public void processModule(Module module) { | ||
| // nothing to do here | ||
| } | ||
|
|
||
| @Override | ||
| public Settings additionalSettings() { | ||
| return ImmutableSettings.Builder.EMPTY_SETTINGS; | ||
| } | ||
|
|
||
|
|
||
| } |
Oops, something went wrong.