org.adroitlogic.x.base.util

Class XBaseUtils

java.lang.Object

org.adroitlogic.x.base.util.XBaseUtils

public class XBaseUtils
extends Object

This class contains all the project-x specific utility methods which can be accessed anywhere in the framework. Since this is a utility class, all the public methods of this class expected to be static.

Since:

17.01

Author:

Manjula Piyumal

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_DATETIME_PATTERN
protected static Map<String,org.apache.commons.lang3.time.FastDateFormat>	FAST_DATE_FORMATS

Constructor Summary

Constructors

Constructor and Description
XBaseUtils()

Method Summary

Modifier and Type	Method and Description
static String	extractStringByReplacingPlaceHolders(XMessageContext xMessageContext, String inputString) This method will replaces all the place holders of the inputString from the correct values which will be extracted from the xMessageContext.
static <T> Function<XMessageContext,Optional<T>>	getExtractionFunction(ValueExtractionType extractionType, Class<T> cls, String value) This method abstracts out logic of extracting out data from message context and returns the extraction logic as a Function.
static URI	getResource(String resourcePath, XServerConfig serverConfig, XProject project) 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 Methods inherited from class java.lang.Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Field Detail FAST_DATE_FORMATS protected static final Map<String,org.apache.commons.lang3.time.FastDateFormat> FAST_DATE_FORMATS DEFAULT_DATETIME_PATTERN protected static final String DEFAULT_DATETIME_PATTERN See Also: Constant Field Values Constructor Detail XBaseUtils public XBaseUtils() Method Detail extractStringByReplacingPlaceHolders public static String extractStringByReplacingPlaceHolders(XMessageContext xMessageContext, String inputString) This method will replaces all the place holders of the inputString from the correct values which will be extracted from the xMessageContext. Valid placeholders are as follows. @{message.headers.<header_name>} - message header given by header_name @{message.headers} - all message headers @{message.properties.<property_name>} - message property given by property_name @{message.properties} - all message properties @{message.payload} - payload @{message.id} - message id @{mc.id} - message context id @{mc.properties.<property_name>} - message context property given by property_name @{mc.properties} - all message context properties @{last.exception.message} - last exception message @{variable.<variable_name>} - variable @{current.timestamp.<timestamp_pattern>} - current timestamp formatted to given pattern @{current.timestamp} - current timestamp formatted to default yyMMddHHmmssZ pattern Note that timestamp pattern should be a compatible with SimpleDateFormat. Parameters: xMessageContext - current message context to extract out required properties, headers, payload and variables inputString - string which contains the input string which can contains place holders for message properties, headers and variables etc. Returns: the final string which is constructed by replacing all the place holders from the correct values extracted from the message context. If inputString doesn't have a place holder notation, input string will be returned as it's. If inputString is null, null will be returned. If there isn't any matching values for the given place holder inputString, then empty String will be returned. getExtractionFunction public static <T> Function<XMessageContext,Optional<T>> getExtractionFunction(ValueExtractionType extractionType, Class<T> cls, String value) This method abstracts out logic of extracting out data from message context and returns the extraction logic as a Function. Type Parameters: T - type of the data Parameters: extractionType - ValueExtractionType enum value cls - the class of the value type value - value for the variable if extraction type is NO_EXTRACTION else the name of the data to be extracted from message context Returns: a composed Function with the relevant extraction logic. It accepts a XMessageContext as the argument getResource public static URI getResource(String resourcePath, XServerConfig serverConfig, XProject project) 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 serverConfig - a XServerConfig representing the current Project-X runtime project - the XProject context from which the resource is being requested 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 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.