org.adroitlogic.x.base.processor

Class AbstractProcessingElement

java.lang.Object

org.adroitlogic.x.base.processor.AbstractProcessingElement

All Implemented Interfaces:

Initializable, MetricsReportable, XProcessingElement, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

Direct Known Subclasses:

AbstractFlowEndProcessingElement, AbstractScopeEndElement, AbstractScopeStartElement, AbstractSequencedProcessingElement, EgressConnectorElement, IngressConnectorElement, MockProcessingElement, SubFlowEnd, SubFlowReference, SubFlowStart

@MetricsReporter
public abstract class AbstractProcessingElement
extends Object
implements XProcessingElement, MetricsReportable

The base abstract class for all Processor implementations

Since:

17.01

Author:

Udith Gunaratna, Ruwan Linton

Field Summary

Fields

Modifier and Type	Field and Description
protected String	beanName
protected org.springframework.context.ApplicationContext	context
protected String	flowId
protected Logger	logger
protected XProject	project
protected Status	status

Constructor Summary

Constructors

Constructor and Description
AbstractProcessingElement()

Method Summary

Modifier and Type	Method and Description
void	destroy()
protected void	destroyElement()
Map<String,String>	getAdditionalProperties() Returns a map of additional properties to be set in the metrics records
String	getBeanName()
String	getEntityId() Returns the entity ID to be used for metrics streams
XProcessingElement	getErrorHandler()
String	getFlowId() Returns the flow ID to be used for metrics streams
XMetricsEngine	getMetricsEngine() Retrieves the metrics engine to be used for this class
XProject	getProject()
String	getProjectId() Returns the project name to be used for metrics streams
String	getProjectVersion() Returns the project version to be used for metrics streams
protected URI	getResource(String resourcePath) This method gives the resource locations for processing elements and connectors the lookup takes place in the following order unless the specified path is an absolute path; A file at "$conf/projects/$projectID/$projectVersion/$mode/$resourcePath A file at "$conf/projects/$projectID/$projectVersion/$resourcePath A file at "$conf/projects/$projectID/$mode/$resourcePath A file at "$conf/projects/$projectID/$resourcePath A file at $conf/$mode/$resourcePath A file at $conf/$resourcePath If environment mode is IDE, src/main/resources/$resourcePath file relative to project dir A $mode/$resourcePath file in the classpath A $resourcePath file in the classpath where the following notation is used for the resource location $resourcePath The path that needs to be fetched $mode The lowercase string representation of the server environment mode as specified in XEnvironment.Mode $conf The configuration directory of the server runtime $projectName The name of the project as per the project.xpml contained in the project archive .xpr file protected XServerConfig getServerConfig() Status getStatus() void init(org.springframework.context.ApplicationContext context) protected void initElement(org.springframework.context.ApplicationContext context) protected abstract ExecutionResult process(XMessageContext messageContext) ExecutionResult processMessage(XMessageContext messageContext) Executes the processing element specific processing of the message void setBeanName(String beanName) void setErrorHandler(XProcessingElement errorHandler) void setFlowId(String flowID) void setProject(XProject project) Methods inherited from class java.lang.Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Methods inherited from interface org.adroitlogic.x.api.processor.XProcessingElement cast Field Detail logger protected Logger logger beanName protected String beanName flowId protected String flowId project protected XProject project context protected org.springframework.context.ApplicationContext context status protected Status status Constructor Detail AbstractProcessingElement public AbstractProcessingElement() Method Detail init public final void init(org.springframework.context.ApplicationContext context) Specified by: init in interface Initializable processMessage public final ExecutionResult processMessage(XMessageContext messageContext) Description copied from interface: XProcessingElement Executes the processing element specific processing of the message Specified by: processMessage in interface XProcessingElement Parameters: messageContext - XMessageContext with the message to be processed Returns: the execution result of the processing of the message destroy public final void destroy() Specified by: destroy in interface Initializable initElement protected void initElement(org.springframework.context.ApplicationContext context) process protected abstract ExecutionResult process(XMessageContext messageContext) destroyElement protected void destroyElement() setBeanName public void setBeanName(String beanName) Specified by: setBeanName in interface org.springframework.beans.factory.BeanNameAware getBeanName public String getBeanName() Specified by: getBeanName in interface XProcessingElement getFlowId public String getFlowId() Description copied from interface: MetricsReportable Returns the flow ID to be used for metrics streams Specified by: getFlowId in interface MetricsReportable Specified by: getFlowId in interface XProcessingElement Returns: flow ID setFlowId public void setFlowId(String flowID) Specified by: setFlowId in interface XProcessingElement getProject public XProject getProject() Specified by: getProject in interface XProcessingElement setProject public void setProject(XProject project) Specified by: setProject in interface XProcessingElement setErrorHandler public void setErrorHandler(XProcessingElement errorHandler) getErrorHandler public XProcessingElement getErrorHandler() getServerConfig protected XServerConfig getServerConfig() getResource protected final URI getResource(String resourcePath) This method gives the resource locations for processing elements and connectors the lookup takes place in the following order unless the specified path is an absolute path; A file at "$conf/projects/$projectID/$projectVersion/$mode/$resourcePath A file at "$conf/projects/$projectID/$projectVersion/$resourcePath A file at "$conf/projects/$projectID/$mode/$resourcePath A file at "$conf/projects/$projectID/$resourcePath A file at $conf/$mode/$resourcePath A file at $conf/$resourcePath If environment mode is IDE, src/main/resources/$resourcePath file relative to project dir A $mode/$resourcePath file in the classpath A $resourcePath file in the classpath where the following notation is used for the resource location $resourcePath The path that needs to be fetched $mode The lowercase string representation of the server environment mode as specified in XEnvironment.Mode $conf The configuration directory of the server runtime $projectName The name of the project as per the project.xpml contained in the project archive .xpr file Parameters: resourcePath - the path that needs to be looked up Returns: the URI representing the resource path from which the resource can be loaded which may change based on the environment and the project to which the relevant artifact belongs to getStatus public final Status getStatus() Specified by: getStatus in interface XProcessingElement getMetricsEngine public XMetricsEngine getMetricsEngine() Description copied from interface: MetricsReportable Retrieves the metrics engine to be used for this class Specified by: getMetricsEngine in interface MetricsReportable Returns: instance of XMetricsEngine getEntityId public String getEntityId() Description copied from interface: MetricsReportable Returns the entity ID to be used for metrics streams Specified by: getEntityId in interface MetricsReportable Returns: entity ID getProjectId public String getProjectId() Description copied from interface: MetricsReportable Returns the project name to be used for metrics streams Specified by: getProjectId in interface MetricsReportable Returns: project name getProjectVersion public String getProjectVersion() Description copied from interface: MetricsReportable Returns the project version to be used for metrics streams Specified by: getProjectVersion in interface MetricsReportable Returns: project version getAdditionalProperties public Map<String,String> getAdditionalProperties() Description copied from interface: MetricsReportable Returns a map of additional properties to be set in the metrics records Specified by: getAdditionalProperties in interface MetricsReportable Returns: additional properties Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method Copyright © 2016–2019 AdroitLogic. All rights reserved.