com.alipay.sofa.runtime.spi.component

Class AbstractComponent

java.lang.Object

com.alipay.sofa.runtime.spi.component.AbstractComponent

All Implemented Interfaces:

Component, ComponentInfo

Direct Known Subclasses:

ExtensionComponent, ExtensionPointComponent, ReferenceComponent, ServiceComponent, SpringContextComponent

public abstract class AbstractComponent
extends Object
implements ComponentInfo

abstract component implementation

Author:

xuanbei 18/3/1

Field Summary

Fields

Modifier and Type	Field and Description
protected ComponentName	componentName
protected ComponentStatus	componentStatus component status
protected Exception	e
protected Implementation	implementation
protected SofaRuntimeContext	sofaRuntimeContext

Constructor Summary

Constructors

Constructor and Description
AbstractComponent()

Method Summary

Modifier and Type	Method and Description
void	activate() activate component
protected String	aggregateBindingHealth(Collection<Binding> bindings)
boolean	canBeDuplicate() whether component can be duplicated defined, default is true
void	deactivate() deactivate component
String	dump() get component information
void	exception(Exception e) create an exception to describe error
SofaRuntimeContext	getContext() get sofa runtime context
Implementation	getImplementation() get component implementation
ComponentName	getName() get component name
ComponentStatus	getState() get component status
boolean	isActivated() check component is activated or not
HealthResult	isHealthy() check component is health or not
boolean	isResolved() check component is resolved or not
void	register() register component
boolean	resolve() resolve component
void	unregister() unregister component
void	unresolve() unresolve component

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.alipay.sofa.runtime.spi.component.ComponentInfo

getProperties, getType

Field Detail

componentStatus

protected ComponentStatus componentStatus

component status

implementation

protected Implementation implementation

componentName

protected ComponentName componentName

sofaRuntimeContext

protected SofaRuntimeContext sofaRuntimeContext

e

protected Exception e

Constructor Detail

AbstractComponent

public AbstractComponent()

Method Detail

getContext

public SofaRuntimeContext getContext()

Description copied from interface: ComponentInfo

get sofa runtime context

Specified by:

getContext in interface ComponentInfo

Returns:

SofaRuntimeContext

getState

public ComponentStatus getState()

Description copied from interface: ComponentInfo

get component status

Specified by:

getState in interface ComponentInfo

Returns:

component status

getName

public ComponentName getName()

Description copied from interface: ComponentInfo

get component name

Specified by:

getName in interface ComponentInfo

Returns:

component name

getImplementation

public Implementation getImplementation()

Description copied from interface: ComponentInfo

get component implementation

Specified by:

getImplementation in interface ComponentInfo

Returns:

component implementation

isActivated

public boolean isActivated()

Description copied from interface: ComponentInfo

check component is activated or not

Specified by:

isActivated in interface ComponentInfo

Returns:

true or false

isResolved

public boolean isResolved()

Description copied from interface: ComponentInfo

check component is resolved or not

Specified by:

isResolved in interface ComponentInfo

Returns:

true or false

register

public void register()

Description copied from interface: Component

register component

Specified by:

register in interface Component

unregister

public void unregister()
                throws ServiceRuntimeException

Description copied from interface: Component

unregister component

Specified by:

unregister in interface Component

Throws:

ServiceRuntimeException

unresolve

public void unresolve()
               throws ServiceRuntimeException

Description copied from interface: Component

unresolve component

Specified by:

unresolve in interface Component

Throws:

ServiceRuntimeException

resolve

public boolean resolve()

Description copied from interface: Component

resolve component

Specified by:

resolve in interface Component

Returns:

success or not

activate

public void activate()
              throws ServiceRuntimeException

Description copied from interface: Component

activate component

Specified by:

activate in interface Component

Throws:

ServiceRuntimeException

exception

public void exception(Exception e)
               throws ServiceRuntimeException

Description copied from interface: Component

create an exception to describe error

Specified by:

exception in interface Component

Throws:

ServiceRuntimeException

deactivate

public void deactivate()
                throws ServiceRuntimeException

Description copied from interface: Component

deactivate component

Specified by:

deactivate in interface Component

Throws:

ServiceRuntimeException

dump

public String dump()

Description copied from interface: ComponentInfo

get component information

Specified by:

dump in interface ComponentInfo

Returns:

isHealthy

public HealthResult isHealthy()

Description copied from interface: ComponentInfo

check component is health or not

Specified by:

isHealthy in interface ComponentInfo

Returns:

health result

aggregateBindingHealth

protected String aggregateBindingHealth(Collection<Binding> bindings)

canBeDuplicate

public boolean canBeDuplicate()

Description copied from interface: ComponentInfo

whether component can be duplicated defined, default is true

Specified by:

canBeDuplicate in interface ComponentInfo

Returns: