@Internal public class CoreModuleFactory extends Object implements ModuleFactory
CoreModule
.ModuleFactory.Context
Modifier and Type | Field and Description |
---|---|
static String |
IDENTIFIER |
Constructor and Description |
---|
CoreModuleFactory() |
Modifier and Type | Method and Description |
---|---|
Module |
createModule(ModuleFactory.Context context)
Creates and configures a
Module . |
String |
factoryIdentifier()
Returns a unique identifier among same factory interfaces.
|
Set<ConfigOption<?>> |
optionalOptions()
Returns a set of
ConfigOption that an implementation of this factory consumes in
addition to Factory.requiredOptions() . |
Set<ConfigOption<?>> |
requiredOptions()
Returns a set of
ConfigOption that an implementation of this factory requires in
addition to Factory.optionalOptions() . |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createModule, requiredContext, supportedProperties
public static final String IDENTIFIER
public String factoryIdentifier()
Factory
For consistency, an identifier should be declared as one lower case word (e.g. kafka
). If multiple factories exist for different versions, a version should be appended
using "-" (e.g. elasticsearch-7
).
factoryIdentifier
in interface Factory
factoryIdentifier
in interface ModuleFactory
public Set<ConfigOption<?>> requiredOptions()
Factory
ConfigOption
that an implementation of this factory requires in
addition to Factory.optionalOptions()
.
See the documentation of Factory
for more information.
requiredOptions
in interface Factory
requiredOptions
in interface ModuleFactory
public Set<ConfigOption<?>> optionalOptions()
Factory
ConfigOption
that an implementation of this factory consumes in
addition to Factory.requiredOptions()
.
See the documentation of Factory
for more information.
optionalOptions
in interface Factory
optionalOptions
in interface ModuleFactory
public Module createModule(ModuleFactory.Context context)
ModuleFactory
Module
.createModule
in interface ModuleFactory
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.