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

Class ConnectorPlugin.Builder

java.lang.Object

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

Enclosing class:

ConnectorPlugin

public static class ConnectorPlugin.Builder
extends java.lang.Object

A simple Builder for a ConnectorPlugin. Note that while the withFetcher(Class, Module...) can be omitted, it is expected that all Connectors MUST register a Fetcher component.

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.Class<? extends ConnectorConfig<?>> configClass)

Method Summary

Modifier and Type	Method and Description
ConnectorPlugin	build()
ConnectorPlugin.Builder	withConcurrentFetchers()
ConnectorPlugin.Builder	withFetcher(java.lang.Class<? extends Fetcher> klass, com.google.inject.Module... modules) Deprecated. use withFetcher(String, Class, Module...)
ConnectorPlugin.Builder	withFetcher(ConnectorPlugin.FetcherDef fetcherDef)
ConnectorPlugin.Builder	withFetcher(java.lang.String name, java.lang.Class<? extends Fetcher> klass, com.google.inject.Module... modules) Creates new ConnectorPlugin.FetcherDef and adds it to fetcherDefs
ConnectorPlugin.Builder	withSecuritySpec(java.util.function.Function<SecuritySpecContext,SecuritySpec> consumer)
ConnectorPlugin.Builder	withValidator(java.lang.Class<? extends ValidationComponent> klass, com.google.inject.Module... modules)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

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

Method Detail

withConcurrentFetchers

public ConnectorPlugin.Builder withConcurrentFetchers()

withFetcher

@Deprecated
public ConnectorPlugin.Builder withFetcher(java.lang.Class<? extends Fetcher> klass,
                                                       com.google.inject.Module... modules)

Deprecated. use withFetcher(String, Class, Module...)

Works just like withFetcher(String, Class, Module...) except the default phase name is always 'default'

Parameters:

klass - fetcher class

modules - juice modules

Returns:

Builder ConnectorPlugin builder

withFetcher

public ConnectorPlugin.Builder withFetcher(java.lang.String name,
                                           java.lang.Class<? extends Fetcher> klass,
                                           com.google.inject.Module... modules)

Creates new ConnectorPlugin.FetcherDef and adds it to fetcherDefs

Parameters:

name - phase name

klass - fetcher class

modules - juice modules

Returns:

Builder ConnectorPlugin builder

withFetcher

public ConnectorPlugin.Builder withFetcher(ConnectorPlugin.FetcherDef fetcherDef)

withSecuritySpec

public ConnectorPlugin.Builder withSecuritySpec(java.util.function.Function<SecuritySpecContext,SecuritySpec> consumer)

withValidator

public ConnectorPlugin.Builder withValidator(java.lang.Class<? extends ValidationComponent> klass,
                                             com.google.inject.Module... modules)

build

public ConnectorPlugin build()