51Degrees .NET classes. These contain the interfaces and logic of the Pipeline API.
| NFiftyOne | |
| NPipeline | |
| NCloudRequestEngine | |
| NData | |
| CCloudJsonConverter | Custom JsonConverter for use when deserialising data from 51Degrees cloud service |
| CCloudRequestData | The IElementData class for FlowElements.CloudRequestEngine |
| NFlowElements | |
| CCloudAspectEngineBase< T > | Base class for 51Degrees cloud aspect engines |
| CRequestEngineAccessor | Internal class that is used to retrieve the CloudRequestEngine instance that will be making requests on behalf of this engine |
| CCloudAspectEngineBuilderBase< TBuilder, TEngine > | Abstract base class that exposes the common options that all 51Degrees cloud engine builders should make use of |
| CCloudPipelineBuilderBase< TBuilder > | Base class for cloud pipeline builders |
| CCloudRequestEngine | Engine that makes requests to the 51Degrees cloud service |
| CEndpointsAndKeys | Raw string properties that describe server destinations and query parameters |
| CCloudRequestEngineBuilder | A fluent builder for CloudRequestEngine instances |
| CICloudRequestEngine | The interface for CloudRequestEngine See the Specification |
| CPropertyKeyedCloudEngineBase< TData, TProfile > | A specialised type of CloudAspectEngineBase<T> that has functionality to support returning a list of matching IAspectData profiles rather than a single item |
| NServices | |
| CMissingPropertyServiceCloud | Cloud-aware missing-property service |
| CCloudRequestEngineTemporarilyUnavailableException | Indicates that cloud request engine can not currently send a request to the remote cloud server |
| CCloudRequestException | Contains details about exceptions that occur when making requests to the cloud service |
| CConstants | Cloud request engine constants |
| NCore | |
| NAttributes | |
| CAlternateNameAttribute | This attribute can be applied to classes and methods to specify an alternative name that can be used for that class/method in Pipeline configuration files |
| CCodeConfigOnlyAttribute | This attribute can be applied to methods to specify that they can only be used when configuring a fluent builder in code |
| CDefaultValueAttribute | This attribute can be applied to methods and parameters to specify what the default value is for that setting |
| NConfiguration | |
| CElementOptions | Configuration object that describes how to build an IFlowElement |
| CPipelineOptions | Configuration object that describes how to build a Pipeline using a PipelineBuilder See the Specification |
| NData | |
| NTypes | |
| CJavaScript | JavaScript type which can be returned as a value by an ElementData |
| CDataBase | This class stores data values as key/value pairs where the key is a string and the value can be any type |
| CDataKey | A DataKey is a multi-field key intended for use in caching and similar scenarios |
| CDataKeyBuilder | Class to assist with the creation of DataKey instances |
| CElementDataBase | This class stores property values that have been determined by a specific FlowElement based on the supplied evidence |
| CElementPropertyMetaData | Meta-data relating to properties that are populated by Flow Elements |
| CEvidence | This class contains the evidence that is passed in to a Pipeline as part of a FlowData object See the Specification |
| CEvidenceKeyFilterAggregator | This implementation of IEvidenceKeyFilter aggregates multiple other filters using a logical OR approach |
| CEvidenceKeyFilterWhitelist | This evidence filter will only include keys that are in a list that is specified at construction time |
| CFlowData | The FlowData class contains the data that is used within a pipeline |
| CFlowDataExtensions | Extension methods for IFlowData |
| CFlowError | This class contains details about errors that occur during processing |
| CFlowWarning | Default IFlowWarning implementation |
| CIData | Represents property values |
| CIDataKeyBuilder | Represents a class that can create new DataKey instances |
| CIElementData | Represents property values that have been determined by a specific FlowElement based on the supplied evidence |
| CIElementPropertyMetaData | Represents meta-data relating to a property that is populated by a IFlowElement instance |
| CIEvidence | Interface to the evidence that is passed in to a Pipeline as part of a FlowData object See the Specification |
| CIEvidenceKeyFilter | Represents an object that filters evidence key names based on some criteria |
| CIFlowData | The IFlowData represents the data that is used within a pipeline |
| CIFlowError | Represents an error that occurred during processing |
| CIFlowWarning | Represents something the caller should know about the request that did not stop it being served |
| CIWeightedValue< T > | The value with associated weighting |
| CLicencedProducts | Used by the CloudRequestEngine to store details of accessible products and properties based on the currently configured resource key |
| CProductMetaData | Licensed properties class used to deserialize accessible property information from cloud services |
| CPropertyMetaData | Standalone instance of ElementPropertyMetaData, used to serialize element or aspect properties |
| CWeightedValue< T > | The value with associated weighting |
| CWeightedValueExtensions | Extensions for IWeightedValue<T> |
| CWktString | |
| NExceptions | |
| CEngineRefreshException | Exception that can be thrown when an IOnPremiseAspectEngine fails to reload from one or more of it's data sources |
| CMaskedException | Stands in for an exception whose message held a license key, and holds the message with each key masked |
| CPipelineConfigurationException | Exception that is thrown when the configuration options provided to PipelineBuilder are invalid See the Specification |
| CPipelineDataException | Exception that can be thrown when the available data does not match that which is expected |
| CPipelineException | Base class for all exceptions thrown by Pipeline API components |
| CPipelineTemporarilyUnavailableException | Indicates that pipeline refused to process Data.IFlowData based on the internal state of some flow elements |
| CPropertiesNotYetLoadedException | Thrown by FlowElements.IFlowElement.Properties to indicate that properties are not available yet but MAY(!) be re-requested later |
| NFailHandling | |
| NExceptionCaching | |
| CCachedException | Links the exception and the timestamp |
| NFacade | |
| CIFailHandler | Tracks failures and throttles requests |
| CSimpleFailHandler | Tracks failures and throttles requests |
| CWindowedFailHandler | Tracks failures and throttles requests |
| NRecovery | |
| CExponentialBackoffRecoveryStrategy | Implements exponential backoff where delay doubles after each consecutive failure |
| CInstantRecoveryStrategy | Always allows to make new server call regardless of previous failures |
| CIRecoveryStrategy | Controls when to suspend requests due to recent query failures |
| CNoRecoveryStrategy | Drops all server calls after first failure |
| CRecoveryStrategyFactory | Factory for creating recovery strategy instances |
| CSimpleRecoveryStrategy | Disallows calling the server for RecoverySeconds |
| NScope | |
| CAttemptScope | A scope within which an attempt will be made |
| CIAttemptScope | A scope within which an attempt will be made |
| NFlowElements | |
| CFlowElementBase< T, TMeta > | Abstract base class for Flow Elements |
| CIDeclaresUpstreamDependencies | Implemented by an element that needs properties from other elements |
| CIFlowElement | IFlowElement is the basic building block of a pipeline |
| CIFlowElement< T, TMeta > | Generic interface that extends IFlowElement with the ability to return a ITypedKey<T> that will allow type-safe access to the data that this element populates in IFlowData |
| CIPipeline | The public interface for a Pipeline |
| CIPipelineBuilderFromConfiguration | Pipeline builders implementing this interface are capable of building a IPipeline based on a supplied PipelineOptions instance |
| CPipeline | A pipeline is used to create IFlowData instances which then automatically use the pipeline when their Process method is called |
| CPipelineBuilder | Default pipeline builder |
| CPipelineBuilderBase< T > | Abstract pipeline builder base class See the Specification |
| CPipelineCancellationExtensions | Extension methods for IPipeline |
| CUpstreamDependencyExtensions | Helpers for working with upstream property dependencies |
| NServices | |
| CFiftyOneServiceProvider | Basic implementation of IServiceProvider |
| CLicenseKeyMask | Masks license keys in text, so a log entry or an error message never holds one in full |
| NTypedMap | |
| CITypedKey< T > | Represents a key to a ITypedKeyMap data store |
| CTypedKey< T > | A key to a ITypedKeyMap data store |
| NUtils | |
| CTypeNameHelper | Provides helper methods to get a human-readable description of Types including the names of nested type parameters |
| CConstants | Class containing values for commonly used evidence keys |
| NEngines | |
| NCaching | |
| CDataKeyedCacheBase< TValue > | Abstract base class for caches that use IFlowData as the key |
| CDefaultFlowCache | The default 'flow cache' implementation |
| CIDataKeyedCache< TValue > | Represents a put cache where the key is a IFlowData instance |
| CIFlowCache | Represents a 'flow cache' See the Specification |
| NConfiguration | |
| CCacheConfiguration | Contains everything needed to build a cache |
| CDataFileConfiguration | This class contains the automatic update configuration parameters that can be supplied to an engine for a particular data file that the engine uses |
| CDataFileConfigurationBuilder | Builder class for DataFileConfiguration instances |
| CDataFileConfigurationBuilderBase< TBuilder, TConfig > | Builder class that is used to create instances of DataFileConfiguration objects |
| CIDataFileConfiguration | Interface representing the configuration parameters controlling the automatic update checks for a specific data file |
| CLazyLoadingConfiguration | Used to store configuration values relating to lazy loading See the Specification |
| NData | |
| NReaders | |
| CIDataLoader< T > | Used to load data from either a file or byte array into the format 'T' |
| CJsonLoader< T > | JSON implementation of IDataLoader |
| CAspectDataBase | Base class for element data instances that are generated by an IAspectEngine |
| CAspectEngineDataFile | This class contains all configuration and run-time state information that is associated with a particular data file used by an aspect engine |
| CAspectPropertyMetaData | Meta-data relating to properties that are populated by Aspect Engines |
| CAspectPropertyValue< T > | This class can be used where engines have a property that may be populated and may not |
| CAspectPropertyValueExtensions | Safe accessors for IAspectPropertyValue<T> that return a fallback instead of throwing when a value cannot be provided |
| CIAspectData | Represents an ElementData instance that is generated by an IAspectEngine |
| CIAspectEngineDataFile | Interface for the details of a data file used by an Aspect engine |
| CIAspectPropertyMetaData | Represents meta-data relating to a property that is populated by an IAspectEngine instance |
| CIAspectPropertyValue | See the Specification |
| CIAspectPropertyValue< T > | Represents a property of an IAspectEngine for which we may not know the value |
| CIDataUpdateUrlFormatter | Represents an class that can build a complete update URL from a supplied IAspectEngineDataFile instance |
| CIMultiProfileData< T > | Represents a specific type of IAspectData that contains multiple IAspectData instances |
| CIProvidesValuesAsString | Element data that can hand back a property's value as the string it was stored as, rather than as the type the property declares |
| NExceptions | |
| CDataUpdateException | Exception that can be thrown when a DataUpdateService fails to successfully complete an update |
| CNoValueException | Exception that can be thrown when an AspectPropertyValue<T> does not have a value |
| NFiftyOne | |
| NConfiguration | |
| CFiftyOneDataFileConfiguration | Data file configuration class for 51Degrees data files |
| CFiftyOneDataFileConfigurationBuilder | Builder class for 51Degrees specific data file configuration instances |
| NData | |
| CComponentMetaDataDefault | Data class that contains meta-data relating to a specific component |
| CEvidenceKeyFilterShareUsage | Decides which of the evidence the ShareUsageElement finds is shared |
| CEvidenceKeyFilterShareUsageTracker | Wrapper for EvidenceKeyFilter for Share Usage, to be used with the ShareUsageTracker to exclude specific evidence keys from the filter |
| CFiftyOneAspectPropertyMetaDataDefault | Data class that contains meta-data relating to a specific property |
| CFiftyOneDataFile | Class that stores meta-data relating to a data file associated with a 51Degrees engine |
| CFiftyOneUrlFormatter | 51Degrees specific URL formatter |
| CIComponentMetaData | Meta data relating to a component of an Engine's results e.g |
| CIFiftyOneAspectPropertyMetaData | 51Degrees specific meta data |
| CIFiftyOneDataFile | A specialized can of IAspectEngineDataFile for files that will be distributed by the 51Degrees 'Distributor' web service |
| CIProfileMetaData | Meta data relating to a profile within the data set |
| CISetHeadersData | The IElementData interface for SetHeadersElement |
| CIValueMetaData | Meta data relating to a specific value within a data set |
| CPropertyKeyedIndex | Index of values and profile ids for a single property |
| CSequenceData | Element data instance for SequenceElement |
| CSetHeadersData | Element data instance for SetHeadersElement See the Specification |
| CValueMetaDataDefault | Data class that contains meta-data relating to a specific value |
| NFlowElements | |
| CFiftyOneOnPremiseAspectEngineBase< T > | 51Degrees specific Engine base class |
| CFiftyOneOnPremiseAspectEngineBuilderBase< TBuilder, TEngine > | A base class for engine builders for on-premise engines that use a single data file and use the 51Degrees Distributor web service to check for and download data updates |
| CFiftyOnePipelineBuilder | Pipeline builder class that allows the 51Degrees share usage element to be enabled/disabled |
| CIFiftyOneAspectEngine | 51Degrees specific Engine interface |
| CISetHeadersElement | An IFlowElement that collates responses from all engines that want to set headers in the HTTP response in order to gather additional data |
| CPropertyKeyedDataSet | Contains the property indexes, pipeline, and inner engine used by PropertyKeyedEngine<TData, TProfile> to look up profile ids from property values |
| CPropertyKeyedEngine< TData, TProfile > | Base class for engines that use an index of property values to profile ids to populate one or more profile instances if a valid value for a specific configured property is provided in the evidence |
| CPropertyKeyedEngineBuilderBase< TBuilder, TEngine > | Builder for engines derived from PropertyKeyedEngine<TData, TProfile> |
| CSequenceElement | Sequence element establishes session and sequence evidence in the pipeline, and holds the same two values as element data |
| CSequenceElementBuilder | Builder for SequenceElement instances |
| CSetHeadersElement | This element is used to determine the values for HTTP headers that other elements in the pipeline want to be sent to the client |
| CPipelineConfig | Contains configuration information relating to a particular pipeline |
| CPropertyDetails | Used to store details of SetHeader* properties |
| CSetHeadersElementBuilder | Fluent builder for SetHeadersElement instances |
| 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 instances |
| CShareUsageBuilderBase< T > | Abstract base class for ShareUsageElement builders |
| CShareUsageElement | Flow element that sends usage data to 51Degrees for analysis |
| NTrackers | |
| CShareUsageTracker | A tracker used by share usage to attempt to avoid repeatedly sending data relating to the same user session |
| CConstants | Constants used by 51Degrees Aspect Engines |
| NFlowElements | |
| CAspectEngineBase< T, TMeta > | Base class for 51Degrees aspect engines |
| CAspectEngineBuilderBase< TBuilder, TEngine > | Abstract base class that exposes the common options that all 51Degrees engine builders should make use of |
| CIAspectEngine | Interface representing 51Degrees on-premise aspect engines |
| CIAspectEngine< T, TMeta > | Interface representing 51Degrees on-premise aspect engines |
| CICloudAspectEngine | An interface for aspect engines that process responses from a cloud service |
| CIOnPremiseAspectEngine | Interface for an AspectEngine that processes evidence using one or more local data files |
| COnPremiseAspectEngineBase< T, TMeta > | Base class for 51Degrees on-premise aspect engines |
| COnPremiseAspectEngineBuilderBase< TBuilder, TEngine > | Abstract base class that exposes the common options that all 51Degrees on-premise engine builders should make use of |
| CPrePackagedPipelineBuilderBase< TBuilder > | Base class for pipeline builders that will produce a pipeline with specific flow elements |
| CSingleFileAspectEngineBuilderBase< TBuilder, TEngine > | Abstract base class that exposes the common options that all on-premise engine builders using a single data file should make use of |
| NServices | |
| CDataUpdateCompleteArgs | Event arguments used when an 'UpdteComplete' event is fired by an IDataUpdateService |
| CDataUpdateEventArgs | Event arguments used when events are fired by an IDataUpdateService |
| CDataUpdateService | Service that manages updates to data files that are used by IAspectEngine instances |
| CIDataUpdateService | Service that manages updates to data files that are used by IOnPremiseAspectEngine instances |
| CIMissingPropertyService | Service that determines the reason for a property not being populated by an engine |
| CMissingPropertyResult | Details of why a property is not populated by an engine |
| CMissingPropertyService | Service that determines the reason for a property not being populated by an engine |
| CMissingPropertyServiceOnPremise | On-premise missing-property service |
| NTrackers | |
| CITracker | |
| CTrackerBase< TValue > | The abstract base class for trackers |
| CConstants | Static class containing various constants that are used by the Pipeline and/or are helpful to callers |
| CPropertyMissingException | Exception thrown when a user requests a property that is not present in the IFlowData |
| CUtils | Static utility methods |
| NJavaScriptBuilder | |
| NData | |
| CIJavaScriptBuilderElementData | The IElementData interface for JavaScriptBuilderElement |
| CJavaScriptBuilderElementData | The IElementData class for JavaScriptBuilderElement |
| NFlowElement | |
| CJavaScriptBuilderElement | JavaScript Builder Element generates a JavaScript include to be run on the client device |
| CJavaScriptBuilderElementBuilder | Builder for the JavaScriptBuilderElement See the Specification |
| NTemplateData | |
| CJavaScriptResource | A helper class that packages the parameters required by the JavaScript mustache template into the required format |
| CConstants | Static class containing various constants that are used by the Pipeline and/or are helpful to callers |
| NJsonBuilder | |
| NConverters | |
| CAspectPropertyValueConverter | A JsonConverter that converts IAspectPropertyValue instances into JSON data |
| CIPAddressValueConverter | A JsonConverter that converts IPAddress instances into JSON data |
| CJavaScriptConverter | A JsonConverter that converts JavaScript instances into JSON data |
| CLazyValueConverter | A JsonConverter that converts Lazy<T> instances into JSON data |
| CWeightedValueConverter | A JsonConverter that converts IWeightedValue<T> instances into JSON data |
| NData | |
| CIJsonBuilderElementData | The IElementData interface for JsonBuilderElement |
| CJsonBuilderElementData | JsonBuilderElement data class |
| NFlowElement | |
| CIJsonBuilderElement | The Interface for the JsonBuilderElement See the Specification |
| CJsonBuilderElement | The JsonBuilderElement takes accessible properties and adds the property key:values to the Json object |
| CPipelineConfig | Contains configuration information relating to a particular pipeline |
| CJsonBuilderElementBuilder | Fluent builder class for constructing JsonBuilderElement instances |
| CConstants | Static class containing various constants that are used by the Pipeline and/or are helpful to callers |
| NWeb | |
| NAdapters | |
| CContextAdapter | Adapter class that is used to translate requests from common services into the appropriate calls for the ASP.NET Core HttpContext implementation |
| CRequestAdapter | Adapter class that is used to translate requests from common services into the appropriate calls for the ASP.NET Core HttpRequest implementation |
| CResponseAdapter | Adapter class that is used to translate requests from common services into the appropriate calls for the ASP.NET Core HttpResponse implementation |
| NServices | |
| CFiftyOneJSService | Service that provides the 51Degrees JavaScript when requested See the Specification |
| CFlowDataProvider | This class provides easy access to the results of IPipeline processing |
| CIFiftyOneJSService | Interface for FiftyOneJSService |
| CIFlowDataProvider | Interface for FlowDataProvider |
| CIPipelineResultService | The interface for the PipelineResultService |
| CISetHeadersService | This service handles setting HTTP headers in the response for properties in the results from the pipeline that start with 'SetHeader' See the Specification |
| CIWebRequestEvidenceService | Interface for WebRequestEvidenceService See the Specification |
| CPipelineResultService | The PipelineResultService passes the current request to the IPipeline and makes the results accessible through the HttpContext |
| CSetHeaderService | |
| CWebRequestEvidenceService | A helper service that is used to add evidence from a web request to a IFlowData instance |
| NShared | |
| NAdapters | |
| CIContextAdapter | Interface for an adapter class that can be used to translate requests from common services into the appropriate calls for a specific HttpContext implementation |
| CIRequestAdapter | Interface for an adapter class that can be used to translate requests from common services into the appropriate calls for a specific HttpRequest implementation |
| CIResponseAdapter | Interface for an adapter class that can be used to translate requests from common services into the appropriate calls for a specific HttpResponse implementation |
| NData | |
| CIAspSession | Generic interface allowing access to a session instance |
| NServices | |
| CClientsidePropertyService | Class that provides functionality for the 'Client side Overrides' feature |
| CIClientsidePropertyService | Interface for ClientsidePropertyService See the Specification |
| CConstants | Static class containing various constants that are used by the Pipeline web integration and/or are helpful to callers |
| CMessages | A strongly-typed resource class, for looking up localized strings, etc |
| CPipelineWebIntegrationOptions | Extends the PipelineOptions class to add web specific options |
| CRequestEvidenceView | A read only view of a web request, keyed as its values would be as evidence, for example 'header.user-agent', which a web integration adds to evidence as Core.Constants.EVIDENCE_HTTPREQUEST_KEY |
| CConstants | Static class containing various constants that are used by the Pipeline web integration and/or are helpful to callers |
| CFiftyOneJSViewComponent | View component that injects some JavaScript into the page in order to determine more details about the device |
| CFiftyOneMiddleware | The 51Degrees middleware component |
| CFiftyOneStartup | Static class used to setup services, configure DI, etc |
| CFiftyOneExtensions | Class that holds the static extension methods that are added to various MVC classes |
