@InterfaceAudience.Public @InterfaceStability.Evolving public abstract class BasicSourceSemantics extends Object implements Source, Configurable
| Constructor and Description |
|---|
BasicSourceSemantics() |
| Modifier and Type | Method and Description |
|---|---|
void |
configure(Context context)
Request the implementing class to (re)configure itself.
|
protected abstract void |
doConfigure(Context context) |
protected abstract void |
doStart() |
protected abstract void |
doStop() |
ChannelProcessor |
getChannelProcessor()
Returns the channel processor that will handle this source's events.
|
LifecycleState |
getLifecycleState()
Return the current state of the service or component.
|
String |
getName() |
protected Exception |
getStartException() |
protected boolean |
isStarted() |
void |
setChannelProcessor(ChannelProcessor cp)
Specifies which channel processor will handle this source's events.
|
protected void |
setLifecycleState(LifecycleState lifecycleState) |
void |
setName(String name) |
void |
start()
Starts a service or component.
|
void |
stop()
Stops a service or component.
|
String |
toString() |
public void configure(Context context)
ConfigurableRequest the implementing class to (re)configure itself.
When configuration parameters are changed, they must be reflected by the component asap.
There are no thread safety guarantees on when configure might be called.
configure in interface Configurablepublic void start()
LifecycleAwareStarts a service or component.
Implementations should determine the result of any start logic and effect
the return value of LifecycleAware.getLifecycleState() accordingly.
start in interface LifecycleAwarepublic void stop()
LifecycleAwareStops a service or component.
Implementations should determine the result of any stop logic and effect
the return value of LifecycleAware.getLifecycleState() accordingly.
stop in interface LifecycleAwarepublic void setChannelProcessor(ChannelProcessor cp)
SourcesetChannelProcessor in interface Sourcepublic ChannelProcessor getChannelProcessor()
SourcegetChannelProcessor in interface Sourcepublic void setName(String name)
setName in interface NamedComponentpublic String getName()
getName in interface NamedComponentpublic LifecycleState getLifecycleState()
LifecycleAwareReturn the current state of the service or component.
getLifecycleState in interface LifecycleAwareprotected boolean isStarted()
protected Exception getStartException()
protected void setLifecycleState(LifecycleState lifecycleState)
protected abstract void doConfigure(Context context) throws FlumeException
FlumeExceptionprotected abstract void doStart()
throws FlumeException
FlumeExceptionprotected abstract void doStop()
throws FlumeException
FlumeExceptionCopyright © 2009-2022 Apache Software Foundation. All Rights Reserved.