Package com.lucidworks.fusion.connector.plugin.api.plugin

Class ConnectorPlugin

java.lang.Object

com.lucidworks.fusion.connector.plugin.api.plugin.ConnectorPlugin

public abstract class ConnectorPlugin
extends Object

This class represents a connector plugin, including its configuration (schema) and related components. Use the #builder(Class) to create an instance, for example:

 public class MyConnectorPluginProvider extends ConnectorPluginProvider {

   public ConnectorPlugin get(){
     return ConnectorPlugin.build(MyConnectorConfig.class)
       .withFetcher("default", MyFetcher.class)
       .build();
   }

 }
 

See Also:

• ConnectorConfig
• ConnectorPluginProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConnectorPlugin.Builder	A simple Builder for a ConnectorPlugin.
static class	ConnectorPlugin.ComponentDefinition<T extends Class<? extends Component>>	This class represents a "component", which is really just a primary interface supported by our plugin SDK.
static class	ConnectorPlugin.FetcherDef

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PLUGIN_TYPE_SUFFIX_KEY

Method Summary

Modifier and Type	Method	Description
static ConnectorPlugin.Builder	builder(Class<? extends ConnectorConfig<?>> configClass)
boolean	concurrentFetchers()
Class	getConfigClass()
Optional<ConnectorPlugin.FetcherDef>	getFetcherDefByName(String phaseName)
List<ConnectorPlugin.FetcherDef>	getFetcherDefs()
String	getPluginTypeSuffix()
Optional<SecuritySpec>	getSecuritySpec()
ConnectorPlugin.ComponentDefinition<Class<? extends ValidationComponent>>	getValidatorComponentDef()

Methods inherited from class java.lang.Object

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

Field Details

PLUGIN_TYPE_SUFFIX_KEY

public static final String PLUGIN_TYPE_SUFFIX_KEY

See Also:

• Constant Field Values

Method Details

getConfigClass

public Class getConfigClass()

getFetcherDefByName

public Optional<ConnectorPlugin.FetcherDef> getFetcherDefByName(String phaseName)

getFetcherDefs

public List<ConnectorPlugin.FetcherDef> getFetcherDefs()

concurrentFetchers

public boolean concurrentFetchers()

getSecuritySpec

public Optional<SecuritySpec> getSecuritySpec()

getValidatorComponentDef

public ConnectorPlugin.ComponentDefinition<Class<? extends ValidationComponent>> getValidatorComponentDef()

getPluginTypeSuffix

public String getPluginTypeSuffix()

builder

public static ConnectorPlugin.Builder builder(Class<? extends ConnectorConfig<?>> configClass)