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 java.lang.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 and Description
static class	ConnectorPlugin.Builder A simple Builder for a ConnectorPlugin.
static class	ConnectorPlugin.ComponentDefinition<T extends java.lang.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 and Description
static java.lang.String	PLUGIN_TYPE_SUFFIX_KEY

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_TYPE_SUFFIX_KEY

public static final java.lang.String PLUGIN_TYPE_SUFFIX_KEY

See Also:

Constant Field Values

Method Detail

getConfigClass

public java.lang.Class getConfigClass()

getFetcherDefByName

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

getFetcherDefs

public java.util.List<ConnectorPlugin.FetcherDef> getFetcherDefs()

concurrentFetchers

public boolean concurrentFetchers()

getSecuritySpec

public java.util.Optional<SecuritySpec> getSecuritySpec()

getValidatorComponentDef

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

getPluginTypeSuffix

public java.lang.String getPluginTypeSuffix()

builder

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