51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

fiftyone.pipeline.cloudrequestengine.flowelements.CloudRequestEngineDefault Class Reference

Detailed Description

Engine that makes requests to the 51Degrees cloud service based on the details passed at creation and the evidence in the FlowData instance.

The unprocessed JSON response is stored in the FlowData for other engines to make use of.

Inheritance diagram for fiftyone.pipeline.cloudrequestengine.flowelements.CloudRequestEngineDefault:

[legend]

Collaboration diagram for fiftyone.pipeline.cloudrequestengine.flowelements.CloudRequestEngineDefault:

[legend]

Public Member Functions

 CloudRequestEngineDefault (Logger logger, ElementDataFactory< CloudRequestData > aspectDataFactory, HttpClient httpClient, String endPoint, String resourceKey, String propertiesEndpoint, String evidenceKeysEndpoint, int timeoutMillis)
 CloudRequestEngineDefault (Logger logger, ElementDataFactory< CloudRequestData > aspectDataFactory, HttpClient httpClient, String endPoint, String resourceKey, String licenseKey, String propertiesEndpoint, String evidenceKeysEndpoint, int timeoutMillis)
List< AspectPropertyMetaData >  getProperties ()
Get details of the properties that this element can populate. More...
String  getDataSourceTier ()
Get the tier to which the current data source belongs. More...
String  getElementDataKey ()
Get the string name of the key used to access the data populated by this element in the FlowData. More...
EvidenceKeyFilter  getEvidenceKeyFilter ()
Get a filter that will only include the evidence keys that this element can make use of. More...
Map< String, AccessiblePropertyMetaData.ProductMetaData >  getPublicProperties ()
A collection of the properties that the cloud service can populate in the JSON response. More...

Public Member Functions inherited from fiftyone.pipeline.engines.flowelements.AspectEngineBase< TData extends AspectData, TProperty extends AspectPropertyMetaData >

 AspectEngineBase (Logger logger, ElementDataFactory< TData > aspectDataFactory)
Construct a new instance of the AspectEngine. More...
TypedKey< TData >  getTypedDataKey ()
abstract List< TProperty >  getProperties ()
abstract String  getDataSourceTier ()
void  setCache (FlowCache cache)
void  setLazyLoading (LazyLoadingConfiguration configuration)
LazyLoadingConfiguration  getLazyLoadingConfiguration ()
ExecutorService  getExecutor ()

Public Member Functions inherited from fiftyone.pipeline.core.flowelements.FlowElementBase< TData extends ElementData, TProperty extends ElementPropertyMetaData >

 FlowElementBase (Logger logger, ElementDataFactory< TData > elementDataFactory)
Construct a new instance of the FlowElement. More...
void  addPipeline (Pipeline pipeline)
List< Pipeline >  getPipelines ()
Get a unmodifiable list of the Pipelines that this element has been added to. More...
abstract String  getElementDataKey ()
abstract EvidenceKeyFilter  getEvidenceKeyFilter ()
abstract List< TProperty >  getProperties ()
TProperty  getProperty (String name)
TypedKey< TData >  getTypedDataKey ()
void  process (FlowData data) throws Exception
DataFactory< TData >  getDataFactory ()
boolean  isConcurrent ()
boolean  isClosed ()
void  close () throws Exception

Public Member Functions inherited from fiftyone.pipeline.core.flowelements.FlowElement< TData, TProperty >

void  process (FlowData data) throws Exception
Carry out whatever operations this element is designed to do using the FlowData passed. More...
void  addPipeline (Pipeline pipeline)
Called when this element is added to a pipeline. More...
EvidenceKeyFilter  getEvidenceKeyFilter ()
Get a filter that will only include the evidence keys that this element can make use of. More...
String  getElementDataKey ()
Get the string name of the key used to access the data populated by this element in the FlowData. More...
TypedKey< TData >  getTypedDataKey ()
Get the typed data key used for retrieving strongly typed element data. More...
List< TProperty >  getProperties ()
Get details of the properties that this element can populate. More...
TProperty  getProperty (String name)
Get a property from the properties that this element can populate using its name. More...
boolean  isConcurrent ()
if true, requires that the Pipeline guards against concurrent access to FlowData structures More...
boolean  isClosed ()
Indicates whether the element has been closed using the close() method, either explicitly or as a result of a 'try with resource'. More...
DataFactory< TData >  getDataFactory ()
Get the factory used to create the element data instances that are populated by this flow element. More...

Public Member Functions inherited from fiftyone.pipeline.engines.flowelements.AspectEngine< TData, TProperty >

void  setCache (FlowCache cache)
Set the results cache. More...
String  getDataSourceTier ()
Get the tier to which the current data source belongs. More...
void  setLazyLoading (LazyLoadingConfiguration configuration)
Configure lazy loading of results. More...
LazyLoadingConfiguration  getLazyLoadingConfiguration ()
Get the lazy loading configuration used for loading of results. More...
ExecutorService  getExecutor ()
Get the executor service to use when starting processing threads which are lazily loaded. More...

Public Member Functions inherited from fiftyone.pipeline.engines.flowelements.AspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >

void  setCache (FlowCache cache)
Set the results cache. More...
void  setLazyLoading (LazyLoadingConfiguration configuration)
Configure lazy loading of results. More...
LazyLoadingConfiguration  getLazyLoadingConfiguration ()
Get the lazy loading configuration used for loading of results. More...
ExecutorService  getExecutor ()
Get the executor service to use when starting processing threads which are lazily loaded. More...

Public Member Functions inherited from fiftyone.pipeline.core.flowelements.FlowElement< TData extends ElementData, TProperty extends ElementPropertyMetaData >

void  process (FlowData data) throws Exception
Carry out whatever operations this element is designed to do using the FlowData passed. More...
void  addPipeline (Pipeline pipeline)
Called when this element is added to a pipeline. More...
TypedKey< TData >  getTypedDataKey ()
Get the typed data key used for retrieving strongly typed element data. More...
TProperty  getProperty (String name)
Get a property from the properties that this element can populate using its name. More...
boolean  isConcurrent ()
if true, requires that the Pipeline guards against concurrent access to FlowData structures More...
boolean  isClosed ()
Indicates whether the element has been closed using the close() method, either explicitly or as a result of a 'try with resource'. More...
DataFactory< TData >  getDataFactory ()
Get the factory used to create the element data instances that are populated by this flow element. More...

Protected Member Functions

void  processEngine (FlowData data, CloudRequestData aspectData) throws IOException
void  unmanagedResourcesCleanup ()

Protected Member Functions inherited from fiftyone.pipeline.engines.flowelements.AspectEngineBase< TData extends AspectData, TProperty extends AspectPropertyMetaData >

abstract void  processEngine (FlowData flowData, TData aspectData) throws Exception
Extending classes must implement this method. More...
final void  processInternal (FlowData flowData) throws Exception
Implementation of method from the base class FlowElementBase. More...
void  managedResourcesCleanup ()

Protected Member Functions inherited from fiftyone.pipeline.core.flowelements.FlowElementBase< TData extends ElementData, TProperty extends ElementPropertyMetaData >

abstract void  processInternal (FlowData data) throws Exception
Abstract method to be overridden by a FlowElement author. More...
abstract void  managedResourcesCleanup ()
Cleanup any managed resources that the element is using.
abstract void  unmanagedResourcesCleanup ()
Cleanup any unmanaged resources that the element is using.
void  close (boolean closing)
void  finalize () throws Throwable

Member Function Documentation

◆ getDataSourceTier()

String fift2bfcb2469840eddf36d9fb4 inherit pro_methods_classfiftyone_1_1pipeline_1_1core_1_1flowelements_1_1_flow_element_base"> abstract void  managedResourcesCleanup ()
Cleanup any managed resources that the element is using.
abstract void  unmanagedResourcesCleanup ()
Cleanup any unmanaged resources that the element is using.
void  close (boolean closing)
void  finalize () throws Throwable

Member Function Documentation

◆ getPublicProperties()

Map<String, AccessiblePropertyMetaData.ProductMetaData> fiftyone.pipeline.cloudrequestengine.flowelements.CloudRequestEngineDefault.getPublicProperties ( )

A collection of the properties that the cloud service can populate in the JSON response.

Keyed on property name.

Returns
public properties

Implements fiftyone.pipeline.cloudrequestengine.flowelements.CloudRequestEngine.