51Degrees Java classes. These contain the interfaces and logic of the Pipeline API.
| Pfiftyone | |
| Pcaching | |
| CCache | Base cache interface which declares only the get method and the types of key and value stored in the cache |
| CCacheBuilder | Builder interface used to build caches |
| CLoadingCache | Extension of general cache contract to provide for getting a value with a particular value loaded |
| CLoadingCacheBuilder | Provides a method to build caches that implement LoadingCache |
| CLruCacheBase | This is a Least Recently Used (LRU) cache with multiple linked lists in place of the usual single linked list |
| CLruLoadingCache | Uses the LruCacheBase to implement the LoadingCache interface |
| CBuilder | Implementation of CacheBuilder for LruLoadingCache caches |
| CLruPutCache | Uses the LruCacheBase to implement the PutCache interface |
| CBuilder | Implementation of CacheBuilder for LruPutCache caches |
| CNoCache | |
| CPutCache | A cache that supports a thread safe put method for inserting to cache |
| CPutCacheBuilder | |
| CValueLoader | Interface that provides a method to load a value for a key |
| Pcommon | |
| Ptesthelpers | |
| CLogbackHelper | Helpers to configure logback directly (in the course of a test, possibly) and other helpers |
| CWarnEvaluator | |
| Pwrappers | |
| Pdata | |
| Pdirect | |
| CSourceMemory | |
| Pindirect | |
| CSourceFile | |
| CBinaryReader | |
| CBinaryWriter | |
| CWritableSeekable | |
| CFile | |
| CMemory | |
| CReaderPool | |
| CSource | |
| Pio | |
| CFileWrapper | Interface for a data file |
| CFileWrapperDefault | Default implementation of FileWrapper using basic file operations |
| CFileWrapperFactory | Factory interface for FileWrappers |
| CFileWrapperFactoryDefault | Default implementation of the FileWrapperFactory interface |
| CFileWrapperMemory | In memory implementation of the FileWrapperFactory |
| Ppipeline | |
| Pannotations | |
| CAlternateName | Defines an alternate name for a set method in a ElementBuilder implementation |
| CBuildArg | Annotation used to define the name of build method arguments in implementations of ElementBuilder |
| CDefaultValue | |
| CElementBuilder | Annotation used to identify ElementBuilder implementations to the PipelineBuilder |
| Pcloudrequestengine | |
| Pdata | |
| CCloudRequestData | |
| Pflowelements | |
| CCloudAspectEngineBase | Base class for 51Degrees Cloud Aspect Engines |
| CRequestEngineAccessor | Internal class that is used to retrieve the CloudRequestEngine that will be making requests of behalf of this engine |
| CCloudRequestDataInternal | |
| CCloudRequestEngine | Engine that makes requests to the 51Degrees cloud service based on the details passed at creation and the evidence in the FlowData instance |
| CCloudRequestEngineBuilder | Builder for the CloudRequestEngine |
| CCloudRequestEngineDefault | Engine that makes requests to the 51Degrees cloud service |
| CConstants | |
| CPropertyKeyedCloudEngineBase | A specialised type of CloudAspectEngineBase that has the functionality to support returning a list of matching AspectData profiles rather than a single item |
| CCloudRequestException | Exception that can be thrown by the Cloud Engines |
| CConstants | |
| CMessages | |
| CNotImplementedException | |
| Pcore | |
| Pconfiguration | |
| CElementOptions | Configuration object that describes how to build a FlowElement |
| CMapAdapter | XML adapter used to unmarshal XML elements to a Map |
| CPipelineOptions | Configuration object that describes how to build a Pipeline using a PipelineBuilder |
| CPipelineOptionsFactory | Instantiate pipeline options from an XML config file |
| Pdata | |
| Pfactories | |
| CElementDataFactory | Factory class used to create a new ElementData instance for a FlowElement |
| CFlowDataFactory | Factory class used to create a FlowData instance for a Pipeline |
| Ptypes | |
| CJavaScript | A string containing JavaScript intended to be run on a client browser |
| CAccessiblePropertyMetaData | Contains classes which deserialise JSON property definitions |
| CLicencedProducts | Class containing a list of ProductMetaDatas |
| CProductMetaData | Licenced properties class used to deserialise accessible property information from cloud services |
| CPropertyMetaData | Standalone instance of ElementPropertyMetaData, used to serialise element or aspect properties |
| CData | Represents a collection of property values |
| CDataBase | This implementation of Data stores data values as key/value pairs in a Map where the key is a string and the value can be any type |
| CDataKey | Data key class containing a number of objects which are used for equality |
| CDataKeyBuilder | Public builder for the DataKey class |
| CDataKeyBuilderDefault | The default implementation of DataKeyBuilder |
| CElementData | Represents property values that have be determined by a specific FlowElement based on the supplied evidence |
| CElementDataBase | Base implementation of ElementData |
| CElementPropertyMetaData | Defines details of a property that can be returned by a FlowElement |
| CElementPropertyMetaDataDefault | Default implementation of the ElementPropertyMetaData interface |
| CEvidence | Evidence used by a FlowElement when processing |
| CEvidenceKeyFilter | Represents an object that filters evidence key names based on some criteria |
| CEvidenceKeyFilterAggregator | This implementation of EvidenceKeyFilter aggregates multiple other filters using a logical OR approach |
| CEvidenceKeyFilterWhitelist | This evidence filter will only include keys that are on a whitelist that is specified at construction time |
| CFlowData | A closeable structure to contain the inputs and outputs of Pipeline processing |
| CFlowError | An error that occurred during the processing of an element |
| CDefault | Default class for FlowError |
| CIWeightedValue | The value with associated weighting |
| CPropertyMatcher | Matcher interface used primarily by the FlowData#getWhere(PropertyMatcher) method to filter properties |
| CTryGetResult | Return value of a 'try get' method |
| CWeightedValue | The value with associated weighting |
| CWktString | Well-known text representation of geometry |
| Pexceptions | |
| CEngineRefreshException | Exception that can be thrown when an on-premise aspect engine fails to reload from one or more of it's data sources |
| CPipelineConfigurationException | Exception that is thrown when the configuration options provided to PipelineBuilder are invalid |
| CPipelineDataException | Exception that can be thrown when the available data does not match that which is expected |
| CPropertyNotLoadedException | Thrown to indicate that properties are not available yet but MAY(!) be re-requested later |
| Pflowelements | |
| CFlowDataFactoryDefault | Default implementation of the FlowDataFactory interface |
| CFlowElement | A component that processes a FlowData (by examining its evidence, or by examining data processed by other FlowElements) |
| CDataFactory | Data factory interface which needs an implementation specific to a FlowElement implementation in order to construct element data when calling the FlowData#getOrAdd(String, FlowElement.DataFactory) method |
| CFlowElementBase | Provides a base class from which authors may create new FlowElements |
| CDataFactoryInternal | Default implementation of the FlowElement.DataFactory interface |
| CDataFactorySimple | FlowElement.DataFactory implementation which should be used temporarily with a single ElementData instance |
| CPipeline | The Pipeline groups together FlowElements and is a factory for FlowData which serves as the evidence, results, and a means to access the Pipeline's processing capabilities |
| CPipelineBuilder | The PipelineBuilder follows the fluent builder pattern |
| CPipelineBuilderBase | Abstract base class for all Pipeline builders |
| CPipelineBuilderFromConfiguration | Pipeline builders implementing this interface are capable of building a Pipeline based on a supplied PipelineOptions instance |
| CPipelineInternal | Internal interface for a pipeline |
| Pservices | |
| CPipelineService | Service interface used by PipelineBuilder to hand out services to elements which required them |
| Ptyped | |
| CTypedKey | Holds a name and a type to allow for type safe operations on named values |
| CTypedKeyDefault | Default implementation of TypedKey |
| CTypedKeyMap | Provides access to a type safe collection of data |
| CTypedKeyMapBuilder | Public builder for instances of TypedKeyMap |
| CConstants | |
| Pengines | |
| Pcaching | |
| CDataKeyedCache | Represents a put cache where the key is a FlowData instance |
| CDataKeyedCacheBase | Abstract base class for caches that use FlowData as the key |
| CFlowCache | Used to cache results from individual flow elements in the pipeline |
| CFlowCacheDefault | Default implementation of FlowCache using the DataKeyedCacheBase |
| Pconfiguration | |
| CCacheConfiguration | Contains everything needed to build a cache |
| CDataFileConfiguration | Interface representing the configuration parameters controlling the automatic update checks for a specific data file |
| CDataFileConfigurationBuilder | Builder class for DataFileConfiguration instances |
| CDataFileConfigurationBuilderBase | Builder class that is used to create instances of DataFileConfiguration objects |
| CDataFileConfigurationDefault | This class contains the automatic update configuration parameters that can be supplied to an engine for a particular data file that the engine uses |
| CExecutorServiceFactory | Factory used to create instances of ExecutorServices for use when processing property values which are configured to be lazily loaded |
| CExecutorServiceFactoryDefault | Default implementation of ExecutorServiceFactory |
| CLazyLoadingConfiguration | Used to store configuration values relating to lazy loading |
| Pdata | |
| CAspectData | Represents a specialized ElementData instance that is generated by an AspectEngine |
| CAspectDataBase | Abstract base class for AspectData which overrides the |
| CAspectEngineDataFile | Interface for the details of a data file used by an Aspect engine |
| CAspectEngineDataFileDefault | Default implementation of the AspectEngineDataFile interface |
| CAspectPropertyMetaData | Holds details about a property that can be returned by an AspectEngine |
| CAspectPropertyMetaDataDefault | Basic implementation of the AspectPropertyMetaData interface |
| CAspectPropertyValue | This interface can be used where engines have a property that may be populated and may not |
| CAspectPropertyValueDefault | This class can be used where engines have a property that may be populated and may not |
| CDataLoader | Used to load data from either a file or byte array into the format 'T' |
| CDataUpdateUrlFormatter | Interface defining a URL formatter which is used by the AspectEngineDataFile#getFormattedUrl() method to get the data update URL |
| CJsonLoader | JSON implementation of IDataLoader |
| CMultiProfileData | Specialised implementation of AspectData where the instance contains a list of profiles |
| CProcessCallable | A Callable implementation which stores an AspectEngine to be used by the Callable#call() method |
| Pexceptions | |
| CLazyLoadTimeoutException | Timeout exception thrown if the lazy loading of a property value from an ElementData times out |
| CNoValueException | Exception that can be thrown when an AspectPropertyValue does not have a value |
| CPropertyMissingException | A property missing exception is thrown by the missing property service if an attempt is made to access a property that does not exist in the FlowData |
| Pfiftyone | |
| Pconfiguration | |
| CFiftyOneDataFileConfiguration | Data file configuration class for 51Degrees data files |
| Pdata | |
| CCloseableIterable | An iterable class which also implements auto-closable |
| CCloseableIterableDefault | Default implementation of CloseableIterable |
| CCollectionIterableBase | |
| CCollectionIterableCachedBase | |
| CComponentMetaData | Meta data relating to a component of an Engine's results e.g |
| CEvidenceKeyFilterShareUsage | This filter is used by the ShareUsageElement |
| CEvidenceKeyFilterShareUsageTracker | Wrapper for EvidenceKeyFilter for Share Usage, to be used with the ShareUsageTracker to excluded specific evidence keys from the filter |
| CFiftyOneAspectPropertyMetaData | 51Degrees specific meta data |
| CFiftyOneAspectPropertyMetaDataDefault | |
| CFiftyOneDataFile | 51Degrees specific data file |
| CFiftyOneDataFileDefault | Default implementation of the FiftyOneDataFile interface |
| CFiftyOneUrlFormatter | |
| CProfileMetaData | Meta data relating to a profile within the data set |
| CSetHeadersData | Data containing the result of SetHeadersElement |
| CValueMetaData | Meta data relating to a specific value within a data set |
| CValueMetaDataDefault | |
| Pexceptions | |
| CHttpException | HTTP exception which can be thrown by a cloud aspect engine |
| CMessages | |
| Pflowelements | |
| Pinterop | |
| CLibLoader | Native library loader class used to load the correct compiled library for an AspectEngine |
| COS | Enumeration of supported Operating System groups |
| CConstants | Constants used by 51Degrees aspect engines |
| CFiftyOneAspectEngine | 51Degrees specific Engine interface |
| CFiftyOneOnPremiseAspectEngineBase | 51Degrees specific engine base class |
| CFiftyOneOnPremiseAspectEngineBuilderBase | Abstract base class that exposes the common options that all 51Degrees on-premise engine builders using a single data file should make use of |
| CFiftyOnePipelineBuilder | Pipeline builder class that allows the 51Degrees share usage element to be enabled/disabled |
| CSequenceElement | Sequence element establishes session and sequence evidence in the pipeline |
| CSequenceElementBuilder | Builder for the SequenceElement |
| CSetHeadersElement | SetHeadersElement constructs the header values to be set in the HTTP response |
| CPipelineConfig | Internal class to hold 'SetHeader' properties available per pipeline |
| CPropertyDetails | Internal class to hold a list of property metadata and its response header to set |
| CSetHeadersElementBuilder | Builder for SetHeadersElement |
| CShareUsageBase | Abstract base class for ShareUsage elements |
| CShareUsageData | Inner class that is used to store details of data in memory prior to it being sent to 51Degrees |
| CShareUsageBuilder | Builder class that is used to create ShareUsageElement |
| CShareUsageBuilderBase | Abstract base class for ShareUsageElement builders |
| CShareUsageElement | Flow element that sends usage data to 51Degrees for analysis |
| CReplacedString | Replace characters that cause problems in XML with the "Replacement character" |
| Ptrackers | |
| CShareUsageTracker | A tracker used by share usage to attempt to avoid repeatedly sending data relating to the same user session |
| Pflowelements | |
| CAspectEngine | AspectEngines are a subset of FlowElements |
| CAspectEngineBase | Base class for AspectEngines to extend |
| CAspectEngineBuilder | Builder interface specific to AspectEngines |
| CAspectEngineBuilderBase | Abstract base class that exposes the common options that all 51Degrees engine builders should make use of |
| CCloudAspectEngine | Aspect engine interface which is specific to a cloud engine |
| CCloudAspectEngineBuilderBase | Abstract base class for all cloud engine builders |
| CCloudPipelineBuilderBase | Base class for pipeline builders that will produce a pipeline with specific flow elements |
| CConstants | |
| COnPremiseAspectEngine | Aspect engine interface which processes data internally using a data file and populates the results |
| COnPremiseAspectEngineBase | Base class for on-premise aspect engines |
| COnPremiseAspectEngineBuilderBase | Abstract base class that exposes the common options that all 51Degrees on-premise engine builders should make use of |
| CPrePackagedPipelineBuilderBase | Base class for pipeline builders that will produce a pipeline with specific flow elements |
| CSingleFileAspectEngineBuilderBase | Abstract base class that exposes the common options that all on-premise engine builders using a single data file should make use of |
| Pservices | |
| Pupdate | |
| CFutureFactory | |
| CFutureFactoryDefault | |
| CDataUpdateService | The data update service keeps AspectEngine’s data files up to date |
| CAutoUpdateStatus | Status code indicating the result of an update |
| CDataUpdateCompleteArgs | |
| CDataUpdateServiceDefault | Default singleton implementation of the DataUpdateService |
| CDataUploader | OutputStream to share usage |
| CDataUploaderHttp | |
| CHttpClient | Interface used by the DataUpdateService to process HTTP requests |
| CHttpClientDefault | |
| CMissingPropertyReason | Enumeration of reasons why a property may be missing from the results of an AspectEngine's processing |
| CMissingPropertyResult | Encapsulates the reason and explanation of why a property was missing from a set of results |
| CMissingPropertyService | Service used by AspectEngines to report the reason for a property not being present in the results |
| CMissingPropertyServiceDefault | Default implementation of the MissingPropertyService interface |
| COnUpdateComplete | Event class called by the DataUpdateService when an update has been completed |
| Ptrackers | |
| CTracker | Represents a 'tracker' |
| CTrackerBase | The abstract base class for trackers |
| CConstants | |
| CPerformanceProfiles | |
| CMissingPropertyMessages | |
| Pexceptions | |
| CAggregateException | Aggregation of multiple exceptions |
| Pjavascriptbuilder | |
| Pdata | |
| CJavaScriptBuilderData | Data containing the result of a JavaScriptBuilderElements processing |
| Pflowelements | |
| CJavaScriptBuilderDataInternal | [class] |
| CJavaScriptBuilderElement | [class] |
| CJavaScriptBuilderElementBuilder | [class] |
| Ptemplates | |
| CJavaScriptResource | [class] |
| CConstants | |
| Pjsonbuilder | |
| Pdata | |
| CJsonBuilderData | Data containing the result of a JsonBuilderElements processing |
| Pflowelements | |
| CJsonBuilder | The JsonBuilderElement takes accessible properties and adds the property key:values to the Json object |
| CJsonBuilderDataInternal | [class] |
| CJsonBuilderElement | The JsonBuilderElement takes accessible properties and adds the property key:values to the Json object |
| CPipelineConfig | [constructor] |
| CJsonBuilderElementBuilder | [class] |
| CConstants | |
| Putil | |
| CBuilders | Utility to find and document all Builders available on the classpath, the classpath being defined in the project POM |
| CCheck | Helper to guard that an argument fulfills its contract |
| CFiftyOneLookup | Used for Interpolation of ${variable} in PipelineOptions and elsewhere |
| CFiftyOneStringSubstitutor | Subclass to obtain variable resolution behaviour that we want, which is that if no key is specified then we want to run envsys: |
| CFileFinder | |
| CStringManipulation | Static helper methods for manipulating strings |
| CTypes | Static type methods |
| Pweb | |
| Pmvc | |
| Pcomponents | |
| CFiftyOneInterceptor | The 51Degrees middleware component |
| CFlowDataProvider | Spring framework component for the FlowDataProviderCore |
| CDefault | |
| Pconfiguration | |
| CFiftyOneInterceptorConfig | Configuration class for the FiftyOneInterceptor |
| CFiftyOneInterceptorConfigDefault | Default implementation of the FiftyOneInterceptorConfig interface |
| Pservices | |
| CClientsidePropertyService | Spring framework service for the ClientsidePropertyServiceCore |
| CDefault | |
| CFiftyOneJSService | Spring framework service for the FiftyOneJSServiceCore |
| CDefault | |
| CPipelineResultService | Spring framework service for the PipelineResultServiceCore |
| CDefault | |
| CUACHService | Spring framework service for the UACHServiceCore |
| CDefault | |
| CWebRequestEvidenceService | Spring framework service for the WebRequestEvidenceServiceCore |
| CDefault | |
| Pservices | |
| CClientsidePropertyServiceCore | Class that provides functionality for the 'Client side overrides' feature |
| CDefault | Default implementation of the ClientsidePropertyServiceCore interface |
| CContentTypes | |
| CFiftyOneJSServiceCore | Service that provides the 51Degrees javascript when requested |
| CDefault | Default implementation of the FiftyOneJSServiceCore service |
| CFlowDataProviderCore | Provider to be injected into controllers to get the pre-processed FlowData for the request being serviced |
| CDefault | Default implementation of the FlowDataProviderCore service |
| CPipelineResultServiceCore | Service used to process web requests through the Pipeline |
| CDefault | Default implementation of the PipelineResultServiceCore service |
| CUACHServiceCore | Service to set HTTP headers in the response |
| CDefault | Default implementation of the UACHServiceCore service |
| CWebRequestEvidenceServiceCore | Service used to populate the Evidence from a HttpServletRequest ready for it to be processed by the Pipeline |
| CDefault | Default implementation of the WebRequestEvidenceServiceCore service |
| Pshared | |
| CConstants | |
| CConstants | |
| CPipelineFilter | Servlet filter used to intercept HTTP requests and process them using the 51Degrees Pipeline |
| CStartupHelpers | Static methods used on server startup to configure and build the Pipeline and services needed |
| Ppipeline | |
| Pdeveloperexamples | |
| Pusagesharing | |
| CMain | |
| CExample |