\r\n

51Degrees Pipeline Java  4.4

51Degrees Pipeline for Java

fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBuilderBase< TBuilder extends OnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends OnPremiseAspectEngine > Class Template Reference abstract

Detailed Description

Abstract base class that exposes the common options that all 51Degrees on-premise engine builders should make use of.

Parameters
<TBuilder> - the specific builder type to use as the return type from the fluent builder methods
<TEngine> - the type of the engine that this builder will build

Inheritance diagram for fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBuilderBase< TBuilder extends OnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends OnPremiseAspectEngine >:

[legend]

Collaboration diagram for fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBuilderBase< TBuilder extends OnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends OnPremiseAspectEngine >:

[legend]

Public Member Functions

 OnPremiseAspectEngineBuilderBase ()
Default constructor which uses the ILoggerFactory implementation returned by LoggerFactory#getILoggerFactory().
 OnPremiseAspectEngineBuilderBase (ILoggerFactory loggerFactory)
Construct a new instance using the ILoggerFactory supplied. More...
 OnPremiseAspectEngineBuilderBase (ILoggerFactory loggerFactory, DataUpdateService dataUpdateService)
Construct a new instance using the ILoggerFactory and DataUpdateService supplied. More...
void  createAndVerifyTempDir (Path pathToCreate)
TBuilder  addDataFile (DataFileConfiguration configuration)
Add a data file for this engine to use. More...
TBuilder  setTempDirPath (String dirPath)
Set the temporary path to use when the engine needs to create temporary files. More...
abstract TBuilder  setPerformanceProfile (Constants.PerformanceProfiles profile)
Set the performance profile that the engine should use. More...

Public Member Functions inherited from fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder, TEngine >

 AspectEngineBuilderBase ()
Default constructor which uses the ILoggerFactory implementation returned by LoggerFactory#getILoggerFactory().
 AspectEngineBuilderBase (ILoggerFactory loggerFactory)
Construct a new instance using the ILoggerFactory supplied. More...
TBuilder  setProperties (Set< AspectPropertyMetaData > set)
Configure the properties that the engine will populate in the response. More...
TBuilder  setProperties (List< String > properties)
Configure the properties that the engine will populate in the response. More...
TBuilder  setProperties (String properties)
Configure the properties that the engine will populate in the response. More...
TBuilder  setProperty (String s)
Add a property to the list of properties that the engine will populate in the response. More...
TBuilder  setProperty (AspectPropertyMetaData aspectProperty)
Add a property to the list of properties that the engine will populate in the response. More...
TBuilder  setLazyLoading (LazyLoadingConfiguration configuration)
Configure lazy loading of results. More...
TBuilder  setCache (CacheConfiguration cacheConfiguration)
Configure the results cache that will be used by the Pipeline to cache results from this engine. More...

Protected Member Functions

void  preCreateEngine ()
void  configureEngine (TEngine engine) throws Exception
AspectEngineDataFile  newAspectEngineDataFile ()
Create a new empty data file instance to be populated with the details of the data file to be used. More...

Protected Member Functions inherited from fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder, TEngine >

List< String >  getProperties ()
Get the list of properties that have been added to the builder. More...
void  configureEngine (TEngine engine) throws Exception
Called by the buildEngine() method to handle configuration of the engine after it is built. More...
void  preCreateEngine ()
Called by the buildEngine() method to handle anything that needs doing before the engine is built. More...
abstract TEngine  newEngine (List< String > properties) throws Exception
Called by the buildEngine() method to handle creation of the engine instance. More...
TEngine  buildEngine () throws Exception
Build an engine using the configured options. More...

Protected Attributes

final List< DataFileConfiguration >  dataFileConfigs = new ArrayList<>()
final List< AspectEngineDataFile >  dataFiles = new ArrayList<>()
String  tempDir Logger  logger = LoggerFactory.getLogger(OnPremiseAspectEngineBuilderBase.class)

Protected Attributes inherited from fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder, TEngine >

final ILoggerFactory  loggerFactory CacheConfiguration  cacheConfig

Constructor & Destructor Documentation

◆ OnPremiseAspectEngineBuilderBase() [1/2]

fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBuilderBase< TBuilder extends OnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends OnPremiseAspectEngine >.OnPremiseAspectEngineBuilderBase ( ILoggerFactory   loggerFactory )

Construct a new instance using the ILoggerFactory supplied.

Parameters
loggerFactory - the logger factory to use

◆ OnPremiseAspectEngineBuilderBase() [2/2]

fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBuilderBase< TBuilder extends OnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends OnPremiseAspectEngine >.OnPremiseAspectEngineBuilderBase ( ILoggerFactory   loggerFactory,
DataUpdateService   dataUpdateService  
)

Construct a new instance using the ILoggerFactory and DataUpdateService supplied.

Parameters
loggerFactory - the logger factory to use
dataUpdateService - the DataUpdateService to use when automatic updates happen on the data file

Member Function Documentation

◆ addDataFile()

TBuilder fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBuilderBase< TBuilder extends OnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends OnPremiseAspectEngine >.addDataFile ( DataFileConfiguration   configuration )

Add a data file for this engine to use.

Parameters
configuration - the data file configuration to add to this engine
Returns
this engine builder instance

◆ newAspectEngineDataFile()

AspectEngineDataFile fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBuilderBase< TBuilder extends OnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends OnPremiseAspectEngine >.newAspectEngineDataFile ( )
protected

Create a new empty data file instance to be populated with the details of the data file to be used.

Returns
new AspectEngineDataFile instance

◆ setPerformanceProfile()

abstract TBuilder fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBuilderBase< TBuilder extends OnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends OnPremiseAspectEngine >.setPerformanceProfile ( Constants.PerformanceProfiles   profile )
abstract

Set the performance profile that the engine should use.

Parameters
profile - the performance profile for the engine to use
Returns
this engine builder instance

◆ setTempDirPath()

TBuilder fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBuilderBase< TBuilder extends OnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends OnPremiseAspectEngine >.setTempDirPath ( String   dirPath )

Set the temporary path to use when the engine needs to create temporary files.

(e.g. when downloading data updates)

By default, this is set to System.getProperty(java.io.tmpdir)+"/fiftyone.tempfiles"

Parameters
dirPath - the full path to the temporary directory
Returns
this engine builder instance

Member Data Documentation

◆ tempDir

String fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBuilderBase< TBuilder extends OnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends OnPremiseAspectEngine >.tempDir
protected
Initial value:
= Paths.get(
System.getProperty("java.io.tmpdir"),"fiftyone.tempfiles").toString()
On This Page

Generated by doxygen 1.8.15