\r\n

51Degrees Pipeline Java  4.4

51Degrees Pipeline for Java

Search

Documentation

• fiftyone
• pipeline
• engines
• fiftyone
• flowelements
• FiftyOneOnPremiseAspectEngineBuilderBase

fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder extends FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine > Class Template Reference abstract

Detailed Description

Abstract base class that exposes the common options that all 51Degrees on-premise engine builders using a single data file 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.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder extends FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >:

Collaboration diagram for fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder extends FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >:

Public Member Functions

	FiftyOneOnPremiseAspectEngineBuilderBase () Default constructor which uses the ILoggerFactory implementation returned by LoggerFactory#getILoggerFactory().
	FiftyOneOnPremiseAspectEngineBuilderBase (ILoggerFactory loggerFactory) Construct a new instance using the ILoggerFactory supplied. More...
	FiftyOneOnPremiseAspectEngineBuilderBase (ILoggerFactory loggerFactory, DataUpdateService dataUpdateService) Construct a new instance using the ILoggerFactory and DataUpdateService supplied. More...
abstract TBuilder	setConcurrency (int concurrency) Set the expected number of concurrent operations using the engine. More...
Public Member Functions inherited from fiftyone.pipeline.engines.flowelements.SingleFileAspectEngineBuilderBase< TBuilder extends OnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends OnPremiseAspectEngine >
	SingleFileAspectEngineBuilderBase () Default constructor which uses the ILoggerFactory implementation returned by LoggerFactory#getILoggerFactory().
	SingleFileAspectEngineBuilderBase (ILoggerFactory loggerFactory) Construct a new instance using the ILoggerFactory supplied. More...
	SingleFileAspectEngineBuilderBase (ILoggerFactory loggerFactory, DataUpdateService dataUpdateService) Construct a new instance using the ILoggerFactory and DataUpdateService supplied. More...
TEngine	build ( @BuildArg("dataFile") String dataFile, @BuildArg("createTempDataCopy") boolean createTempDataCopy) throws Exception Build an engine using the current options and the specified data file. More...
TEngine	build (byte[] data) throws Exception Build an engine using the current options and the specified byte array. More...
TBuilder	setDataUpdateUrl (String url) Configure the engine to use the specified URL when looking for an updated data file. More...
TBuilder	setDataUpdateUrlFormatter (DataUpdateUrlFormatter formatter) Specify a DataUpdateUrlFormatter to be used by the DataUpdateService when building the complete URL to query for updated data. More...
TBuilder	setDataUpdateVerifyMd5 (boolean verify) Set a value indicating if the DataUpdateService should expect the response from the data update URL to contain a 'content-md5' HTTP header that can be used to verify the integrity of the content. More...
TBuilder	setDataUpdateDecompress (boolean decompress) Set a value indicating if the DataUpdateService should expect content from the configured data update URL to be compressed or not. More...
TBuilder	setAutoUpdate (boolean enabled) Enable or disable automatic updates for this engine. More...
TBuilder	setDataFileSystemWatcher (boolean enabled) The DataUpdateService has the ability to watch a data file on disk and automatically refresh the engine as soon as the file is updated. More...
TBuilder	setUpdatePollingInterval (int pollingIntervalSeconds) Set the time between checks for a new data file made by the DataUpdateService in seconds. More...
TBuilder	setUpdatePollingIntervalSeconds (int pollingIntervalSeconds) Set the time between checks for a new data file made by the DataUpdateService in seconds. More...
TBuilder	setUpdatePollingInterval (long pollingIntervalMillis) Set the time between checks for a new data file made by the DataUpdateService in milliseconds. More...
TBuilder	setUpdatePollingIntervalMillis (long pollingIntervalMillis) Set the time between checks for a new data file made by the DataUpdateService in milliseconds. More...
TBuilder	setUpdateRandomisationMax (long maximumDeviationMillis) A random element can be added to the DataUpdateService polling interval. More...
TBuilder	setUpdateRandomisationMaxMillis (long maximumDeviationMillis) A random element can be added to the DataUpdateService polling interval. More...
TBuilder	setVerifyIfModifiedSince (boolean enabled) Set if DataUpdateService sends the If-Modified-Since header in the request for a new data file. More...
TBuilder	setDataUpdateLicenseKey (String key) Set the license key to use when updating the Engine's data file. More...
TBuilder	setDataUpdateLicenseKeys (String[] keys) Set the license keys to use when updating the Engine's data file. More...
TBuilder	setDataUpdateOnStartup (boolean enabled) Configure the data file to update on startup or not. More...
Public Member Functions inherited from fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >
	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...

Static Public Attributes

static final String

DATA_UPDATE_URL

Protected Member Functions

AspectEngineDataFile	newAspectEngineDataFile () Create a new empty data file instance to be populated with the details of the data file to be used. More...
abstract String	getDefaultDataDownloadType () The default value to use for the 'Type' parameter when sending a request to the Distributor. More...
TBuilder	setDefaultDataDownloadType (String typeName) Set the 'type' string that will be sent to the 'distributor' service when downloading a new data file. More...
Protected Member Functions inherited from fiftyone.pipeline.engines.flowelements.SingleFileAspectEngineBuilderBase< TBuilder extends OnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends OnPremiseAspectEngine >
TEngine	build () throws Exception Build an engine using the configured options. More...
Protected Member Functions inherited from fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >
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...

Constructor & Destructor Documentation

◆ FiftyOneOnPremiseAspectEngineBuilderBase() [1/2]

fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder extends FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >.FiftyOneOnPremiseAspectEngineBuilderBase

(

ILoggerFactory

loggerFactory

)

Construct a new instance using the ILoggerFactory supplied.

Parameters

loggerFactory - the logger factory to use

◆ FiftyOneOnPremiseAspectEngineBuilderBase() [2/2]

fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder extends FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >.FiftyOneOnPremiseAspectEngineBuilderBase	(	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

◆ getDefaultDataDownloadType()

abstract String fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder extends FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >.getDefaultDataDownloadType

(

)

abstract protected

The default value to use for the 'Type' parameter when sending a request to the Distributor.

Returns

default data download type;

◆ newAspectEngineDataFile()

AspectEngineDataFile fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder extends FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >.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

◆ setConcurrency()

abstract TBuilder fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder extends FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >.setConcurrency

(

int

concurrency

)

abstract

Set the expected number of concurrent operations using the engine.

This sets the concurrency of the internal caches to avoid excessive locking.

Parameters

concurrency - expected concurrent accesses

Returns

this builder

◆ setDefaultDataDownloadType()

TBuilder fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder extends FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >.setDefaultDataDownloadType

(

String

typeName

)

protected

Set the 'type' string that will be sent to the 'distributor' service when downloading a new data file.

Note that this is only needed if using UpdateOnStartup. Otherwise, the update service will use the type name from the existing data file. The default value is provided by the specific engine builder implementation.

Parameters

typeName - The download type to use. For example 'HashV4'.

Returns

This builder.

Member Data Documentation

◆ DATA_UPDATE_URL

final String fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder extends FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >.DATA_UPDATE_URL

static

Initial value:

=

"https://distributor.51degrees.com/api/v2/download"

On This Page

• Public Member Functions
• Static Public Attributes
• Protected Member Functions
• List of all members

Generated by doxygen 1.8.15