51Degrees Pipeline for .NET

Classes

51Degrees .NET classes. These contain the interfaces and logic of the Pipeline API.
 NFiftyOne
 NPipeline
 NCloudRequestEngine
 NData
 CCloudJsonConverterCustom JsonConverter for use when deserialising data from 51Degrees cloud service
 CCloudRequestDataThe IElementData class for FlowElements.CloudRequestEngine
 NFlowElements
 CCloudAspectEngineBase< T >Base class for 51Degrees cloud aspect engines
 CRequestEngineAccessorInternal 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
 CCloudRequestEngineEngine that makes requests to the 51Degrees cloud service
 CEndpointsAndKeysRaw string properties that describe server destinations and query parameters
 CCloudRequestEngineBuilderA fluent builder for CloudRequestEngine instances
 CICloudRequestEngineThe 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
 CMissingPropertyServiceCloudCloud-aware missing-property service
 CCloudRequestEngineTemporarilyUnavailableExceptionIndicates that cloud request engine can not currently send a request to the remote cloud server
 CCloudRequestExceptionContains details about exceptions that occur when making requests to the cloud service
 CConstantsCloud request engine constants
 NCore
 NAttributes
 CAlternateNameAttributeThis 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
 CCodeConfigOnlyAttributeThis attribute can be applied to methods to specify that they can only be used when configuring a fluent builder in code
 CDefaultValueAttributeThis attribute can be applied to methods and parameters to specify what the default value is for that setting
 NConfiguration
 CElementOptionsConfiguration object that describes how to build an IFlowElement
 CPipelineOptionsConfiguration object that describes how to build a Pipeline using a PipelineBuilder See the Specification
 NData
 NTypes
 CJavaScriptJavaScript type which can be returned as a value by an ElementData
 CDataBaseThis class stores data values as key/value pairs where the key is a string and the value can be any type
 CDataKeyA DataKey is a multi-field key intended for use in caching and similar scenarios
 CDataKeyBuilderClass to assist with the creation of DataKey instances
 CElementDataBaseThis class stores property values that have been determined by a specific FlowElement based on the supplied evidence
 CElementPropertyMetaDataMeta-data relating to properties that are populated by Flow Elements
 CEvidenceThis class contains the evidence that is passed in to a Pipeline as part of a FlowData object See the Specification
 CEvidenceKeyFilterAggregatorThis implementation of IEvidenceKeyFilter aggregates multiple other filters using a logical OR approach
 CEvidenceKeyFilterWhitelistThis evidence filter will only include keys that are in a list that is specified at construction time
 CFlowDataThe FlowData class contains the data that is used within a pipeline
 CFlowDataExtensionsExtension methods for IFlowData
 CFlowErrorThis class contains details about errors that occur during processing
 CFlowWarningDefault IFlowWarning implementation
 CIDataRepresents property values
 CIDataKeyBuilderRepresents a class that can create new DataKey instances
 CIElementDataRepresents property values that have been determined by a specific FlowElement based on the supplied evidence
 CIElementPropertyMetaDataRepresents meta-data relating to a property that is populated by a IFlowElement instance
 CIEvidenceInterface to the evidence that is passed in to a Pipeline as part of a FlowData object See the Specification
 CIEvidenceKeyFilterRepresents an object that filters evidence key names based on some criteria
 CIFlowDataThe IFlowData represents the data that is used within a pipeline
 CIFlowErrorRepresents an error that occurred during processing
 CIFlowWarningRepresents something the caller should know about the request that did not stop it being served
 CIWeightedValue< T >The value with associated weighting
 CLicencedProductsUsed by the CloudRequestEngine to store details of accessible products and properties based on the currently configured resource key
 CProductMetaDataLicensed properties class used to deserialize accessible property information from cloud services
 CPropertyMetaDataStandalone instance of ElementPropertyMetaData, used to serialize element or aspect properties
 CWeightedValue< T >The value with associated weighting
 CWeightedValueExtensionsExtensions for IWeightedValue<T>
 CWktString
 NExceptions
 CEngineRefreshExceptionException that can be thrown when an IOnPremiseAspectEngine fails to reload from one or more of it's data sources
 CMaskedExceptionStands in for an exception whose message held a license key, and holds the message with each key masked
 CPipelineConfigurationExceptionException that is thrown when the configuration options provided to PipelineBuilder are invalid See the Specification
 CPipelineDataExceptionException that can be thrown when the available data does not match that which is expected
 CPipelineExceptionBase class for all exceptions thrown by Pipeline API components
 CPipelineTemporarilyUnavailableExceptionIndicates that pipeline refused to process Data.IFlowData based on the internal state of some flow elements
 CPropertiesNotYetLoadedExceptionThrown by FlowElements.IFlowElement.Properties to indicate that properties are not available yet but MAY(!) be re-requested later
 NFailHandling
 NExceptionCaching
 CCachedExceptionLinks the exception and the timestamp
 NFacade
 CIFailHandlerTracks failures and throttles requests
 CSimpleFailHandlerTracks failures and throttles requests
 CWindowedFailHandlerTracks failures and throttles requests
 NRecovery
 CExponentialBackoffRecoveryStrategyImplements exponential backoff where delay doubles after each consecutive failure
 CInstantRecoveryStrategyAlways allows to make new server call regardless of previous failures
 CIRecoveryStrategyControls when to suspend requests due to recent query failures
 CNoRecoveryStrategyDrops all server calls after first failure
 CRecoveryStrategyFactoryFactory for creating recovery strategy instances
 CSimpleRecoveryStrategyDisallows calling the server for RecoverySeconds
 NScope
 CAttemptScopeA scope within which an attempt will be made
 CIAttemptScopeA scope within which an attempt will be made
 NFlowElements
 CFlowElementBase< T, TMeta >Abstract base class for Flow Elements
 CIDeclaresUpstreamDependenciesImplemented by an element that needs properties from other elements
 CIFlowElementIFlowElement 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
 CIPipelineThe public interface for a Pipeline
 CIPipelineBuilderFromConfigurationPipeline builders implementing this interface are capable of building a IPipeline based on a supplied PipelineOptions instance
 CPipelineA pipeline is used to create IFlowData instances which then automatically use the pipeline when their Process method is called
 CPipelineBuilderDefault pipeline builder
 CPipelineBuilderBase< T >Abstract pipeline builder base class See the Specification
 CPipelineCancellationExtensionsExtension methods for IPipeline
 CUpstreamDependencyExtensionsHelpers for working with upstream property dependencies
 NServices
 CFiftyOneServiceProviderBasic implementation of IServiceProvider
 CLicenseKeyMaskMasks 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
 CTypeNameHelperProvides helper methods to get a human-readable description of Types including the names of nested type parameters
 CConstantsClass containing values for commonly used evidence keys
 NEngines
 NCaching
 CDataKeyedCacheBase< TValue >Abstract base class for caches that use IFlowData as the key
 CDefaultFlowCacheThe default 'flow cache' implementation
 CIDataKeyedCache< TValue >Represents a put cache where the key is a IFlowData instance
 CIFlowCacheRepresents a 'flow cache' See the Specification
 NConfiguration
 CCacheConfigurationContains everything needed to build a cache
 CDataFileConfigurationThis class contains the automatic update configuration parameters that can be supplied to an engine for a particular data file that the engine uses
 CDataFileConfigurationBuilderBuilder class for DataFileConfiguration instances
 CDataFileConfigurationBuilderBase< TBuilder, TConfig >Builder class that is used to create instances of DataFileConfiguration objects
 CIDataFileConfigurationInterface representing the configuration parameters controlling the automatic update checks for a specific data file
 CLazyLoadingConfigurationUsed 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
 CAspectDataBaseBase class for element data instances that are generated by an IAspectEngine
 CAspectEngineDataFileThis class contains all configuration and run-time state information that is associated with a particular data file used by an aspect engine
 CAspectPropertyMetaDataMeta-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
 CAspectPropertyValueExtensionsSafe accessors for IAspectPropertyValue<T> that return a fallback instead of throwing when a value cannot be provided
 CIAspectDataRepresents an ElementData instance that is generated by an IAspectEngine
 CIAspectEngineDataFileInterface for the details of a data file used by an Aspect engine
 CIAspectPropertyMetaDataRepresents meta-data relating to a property that is populated by an IAspectEngine instance
 CIAspectPropertyValueSee the Specification
 CIAspectPropertyValue< T >Represents a property of an IAspectEngine for which we may not know the value
 CIDataUpdateUrlFormatterRepresents 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
 CIProvidesValuesAsStringElement 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
 CDataUpdateExceptionException that can be thrown when a DataUpdateService fails to successfully complete an update
 CNoValueExceptionException that can be thrown when an AspectPropertyValue<T> does not have a value
 NFiftyOne
 NConfiguration
 CFiftyOneDataFileConfigurationData file configuration class for 51Degrees data files
 CFiftyOneDataFileConfigurationBuilderBuilder class for 51Degrees specific data file configuration instances
 NData
 CComponentMetaDataDefaultData class that contains meta-data relating to a specific component
 CEvidenceKeyFilterShareUsageDecides which of the evidence the ShareUsageElement finds is shared
 CEvidenceKeyFilterShareUsageTrackerWrapper for EvidenceKeyFilter for Share Usage, to be used with the ShareUsageTracker to exclude specific evidence keys from the filter
 CFiftyOneAspectPropertyMetaDataDefaultData class that contains meta-data relating to a specific property
 CFiftyOneDataFileClass that stores meta-data relating to a data file associated with a 51Degrees engine
 CFiftyOneUrlFormatter51Degrees specific URL formatter
 CIComponentMetaDataMeta data relating to a component of an Engine's results e.g
 CIFiftyOneAspectPropertyMetaData51Degrees specific meta data
 CIFiftyOneDataFileA specialized can of IAspectEngineDataFile for files that will be distributed by the 51Degrees 'Distributor' web service
 CIProfileMetaDataMeta data relating to a profile within the data set
 CISetHeadersDataThe IElementData interface for SetHeadersElement
 CIValueMetaDataMeta data relating to a specific value within a data set
 CPropertyKeyedIndexIndex of values and profile ids for a single property
 CSequenceDataElement data instance for SequenceElement
 CSetHeadersDataElement data instance for SetHeadersElement See the Specification
 CValueMetaDataDefaultData 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
 CFiftyOnePipelineBuilderPipeline builder class that allows the 51Degrees share usage element to be enabled/disabled
 CIFiftyOneAspectEngine51Degrees specific Engine interface
 CISetHeadersElementAn IFlowElement that collates responses from all engines that want to set headers in the HTTP response in order to gather additional data
 CPropertyKeyedDataSetContains 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>
 CSequenceElementSequence element establishes session and sequence evidence in the pipeline, and holds the same two values as element data
 CSequenceElementBuilderBuilder for SequenceElement instances
 CSetHeadersElementThis element is used to determine the values for HTTP headers that other elements in the pipeline want to be sent to the client
 CPipelineConfigContains configuration information relating to a particular pipeline
 CPropertyDetailsUsed to store details of SetHeader* properties
 CSetHeadersElementBuilderFluent builder for SetHeadersElement instances
 CShareUsageBaseAbstract base class for ShareUsage elements
 CShareUsageDataInner class that is used to store details of data in memory prior to it being sent to 51Degrees
 CShareUsageBuilderBuilder class that is used to create ShareUsageElement instances
 CShareUsageBuilderBase< T >Abstract base class for ShareUsageElement builders
 CShareUsageElementFlow element that sends usage data to 51Degrees for analysis
 NTrackers
 CShareUsageTrackerA tracker used by share usage to attempt to avoid repeatedly sending data relating to the same user session
 CConstantsConstants 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
 CIAspectEngineInterface representing 51Degrees on-premise aspect engines
 CIAspectEngine< T, TMeta >Interface representing 51Degrees on-premise aspect engines
 CICloudAspectEngineAn interface for aspect engines that process responses from a cloud service
 CIOnPremiseAspectEngineInterface 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
 CDataUpdateCompleteArgsEvent arguments used when an 'UpdteComplete' event is fired by an IDataUpdateService
 CDataUpdateEventArgsEvent arguments used when events are fired by an IDataUpdateService
 CDataUpdateServiceService that manages updates to data files that are used by IAspectEngine instances
 CIDataUpdateServiceService that manages updates to data files that are used by IOnPremiseAspectEngine instances
 CIMissingPropertyServiceService that determines the reason for a property not being populated by an engine
 CMissingPropertyResultDetails of why a property is not populated by an engine
 CMissingPropertyServiceService that determines the reason for a property not being populated by an engine
 CMissingPropertyServiceOnPremiseOn-premise missing-property service
 NTrackers
 CITracker
 CTrackerBase< TValue >The abstract base class for trackers
 CConstantsStatic class containing various constants that are used by the Pipeline and/or are helpful to callers
 CPropertyMissingExceptionException thrown when a user requests a property that is not present in the IFlowData
 CUtilsStatic utility methods
 NJavaScriptBuilder
 NData
 CIJavaScriptBuilderElementDataThe IElementData interface for JavaScriptBuilderElement
 CJavaScriptBuilderElementDataThe IElementData class for JavaScriptBuilderElement
 NFlowElement
 CJavaScriptBuilderElementJavaScript Builder Element generates a JavaScript include to be run on the client device
 CJavaScriptBuilderElementBuilderBuilder for the JavaScriptBuilderElement See the Specification
 NTemplateData
 CJavaScriptResourceA helper class that packages the parameters required by the JavaScript mustache template into the required format
 CConstantsStatic class containing various constants that are used by the Pipeline and/or are helpful to callers
 NJsonBuilder
 NConverters
 CAspectPropertyValueConverterA JsonConverter that converts IAspectPropertyValue instances into JSON data
 CIPAddressValueConverterA JsonConverter that converts IPAddress instances into JSON data
 CJavaScriptConverterA JsonConverter that converts JavaScript instances into JSON data
 CLazyValueConverterA JsonConverter that converts Lazy<T> instances into JSON data
 CWeightedValueConverterA JsonConverter that converts IWeightedValue<T> instances into JSON data
 NData
 CIJsonBuilderElementDataThe IElementData interface for JsonBuilderElement
 CJsonBuilderElementDataJsonBuilderElement data class
 NFlowElement
 CIJsonBuilderElementThe Interface for the JsonBuilderElement See the Specification
 CJsonBuilderElementThe JsonBuilderElement takes accessible properties and adds the property key:values to the Json object
 CPipelineConfigContains configuration information relating to a particular pipeline
 CJsonBuilderElementBuilderFluent builder class for constructing JsonBuilderElement instances
 CConstantsStatic class containing various constants that are used by the Pipeline and/or are helpful to callers
 NWeb
 NAdapters
 CContextAdapterAdapter class that is used to translate requests from common services into the appropriate calls for the ASP.NET Core HttpContext implementation
 CRequestAdapterAdapter class that is used to translate requests from common services into the appropriate calls for the ASP.NET Core HttpRequest implementation
 CResponseAdapterAdapter class that is used to translate requests from common services into the appropriate calls for the ASP.NET Core HttpResponse implementation
 NServices
 CFiftyOneJSServiceService that provides the 51Degrees JavaScript when requested See the Specification
 CFlowDataProviderThis class provides easy access to the results of IPipeline processing
 CIFiftyOneJSServiceInterface for FiftyOneJSService
 CIFlowDataProviderInterface for FlowDataProvider
 CIPipelineResultServiceThe interface for the PipelineResultService
 CISetHeadersServiceThis service handles setting HTTP headers in the response for properties in the results from the pipeline that start with 'SetHeader' See the Specification
 CIWebRequestEvidenceServiceInterface for WebRequestEvidenceService See the Specification
 CPipelineResultServiceThe PipelineResultService passes the current request to the IPipeline and makes the results accessible through the HttpContext
 CSetHeaderService
 CWebRequestEvidenceServiceA helper service that is used to add evidence from a web request to a IFlowData instance
 NShared
 NAdapters
 CIContextAdapterInterface for an adapter class that can be used to translate requests from common services into the appropriate calls for a specific HttpContext implementation
 CIRequestAdapterInterface for an adapter class that can be used to translate requests from common services into the appropriate calls for a specific HttpRequest implementation
 CIResponseAdapterInterface for an adapter class that can be used to translate requests from common services into the appropriate calls for a specific HttpResponse implementation
 NData
 CIAspSessionGeneric interface allowing access to a session instance
 NServices
 CClientsidePropertyServiceClass that provides functionality for the 'Client side Overrides' feature
 CIClientsidePropertyServiceInterface for ClientsidePropertyService See the Specification
 CConstantsStatic class containing various constants that are used by the Pipeline web integration and/or are helpful to callers
 CMessagesA strongly-typed resource class, for looking up localized strings, etc
 CPipelineWebIntegrationOptionsExtends the PipelineOptions class to add web specific options
 CRequestEvidenceViewA 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
 CConstantsStatic class containing various constants that are used by the Pipeline web integration and/or are helpful to callers
 CFiftyOneJSViewComponentView component that injects some JavaScript into the page in order to determine more details about the device
 CFiftyOneMiddlewareThe 51Degrees middleware component
 CFiftyOneStartupStatic class used to setup services, configure DI, etc
 CFiftyOneExtensionsClass that holds the static extension methods that are added to various MVC classes