Click or drag to resize
BannedIPInfoProvider Class
Class providing BannedIPInfo management.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractProvider
    CMS.DataEngineBaseAbstractInfoProvider
      CMS.DataEngineAbstractInfoProviderBannedIPInfoProvider
        CMS.DataEngineAbstractInfoProviderBannedIPInfo, BannedIPInfoProvider
          CMS.ProtectionBannedIPInfoProvider

Namespace: CMS.Protection
Assembly: CMS.Protection (in CMS.Protection.dll) Version: 8.2.23
Syntax
C#
public class BannedIPInfoProvider : AbstractInfoProvider<BannedIPInfo, BannedIPInfoProvider>

The BannedIPInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodBannedIPInfoProvider
Top
Methods
  NameDescription
Public methodAddSiteWhereCondition(String, Int32, String, Boolean)
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodAddSiteWhereCondition(String, Int32, String, Boolean, String)
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberBanControlEnumString(BanControlEnum)
Returns BanControlEnum string code.
Public methodStatic memberBanControlEnumString(Type, Int32)
Returns BanControlEnum string code derived from type of enumeration and enum value.
Public methodStatic memberBanRedirect
Redirects current http response to special page for banned IPs (settings key CMSBannedIPRedirectURL).
Protected methodBoundGetInfoByGuid(Guid)
Gets the info object by its GUID
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodBoundGetInfoByGuid(Guid, Int32)
Gets the info object by its GUID and site ID
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodBoundGetInfoById
Gets the info by ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodBoundGetInfoByName(String)
Gets the info object by its code name
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodBoundGetInfoByName(String, Int32)
Gets the info object by its code name and site Id
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodBoundGetInfosByIds
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodClearHashtables
Clear hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodCreateHashtables
Creates the provider hashtables
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodCreateInfo(Int32)
Creates an instance of info object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodCreateInfo(DataRow, Boolean)
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.)
Public methodCreateWebFarmTask(String, String, Byte)
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.)
Public methodStatic memberDeleteBannedIPInfo(Int32)
Deletes specified bannedIP.
Public methodStatic memberDeleteBannedIPInfo(BannedIPInfo)
Deletes specified bannedIP.
Protected methodDeleteBannedIPInfoInternal
Deletes specified bannedIP.
Protected methodDeleteData(String)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodDeleteData(IWhereCondition)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodDeleteData(ActionObjectQueryTInfo)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetBanControlEnum
Returns BanControlEnum type derived from string.
Public methodStatic memberGetBannedIPInfo
Returns the BannedIPInfo structure for the specified bannedIP.
Protected methodGetBannedIPInfoInternal
Returns the BannedIPInfo structure for the specified bannedIP.
Public methodStatic memberGetBannedIPs
Returns the query for all banned IPs.
Public methodGetBindingWhereCondition(String, Int32)
Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetBindingWhereCondition(String, Object)
Gets the where condition to limit the objects to specific binding dependencies. Use this method for 3 and more-keys bindings.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetCacheDependency(DataSet, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetCacheDependency(BaseInfo, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetCountInternal
Gets the number of items matching the given parameters. Does not check the license when retrieving data.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32, Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDataByColumnT
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDataByGuidColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDataByIntColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDataByStringColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDependencyCacheKeys(DataSet, String, String)
Gets the cache dependency keys for the given DataSet.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDependencyCacheKeys(GeneralizedInfo, String, String)
Gets the cache dependency keys for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetEmptyDataSet
Gets the empty data set to be filled by the data
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetExistingIDsInternal
Filters out all object IDs that do not exist in the database.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetFullNameDictionary
Creates new dictionary for caching the objects by full name
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetFullNameWhereCondition
Gets the where condition that searches the object based on the given full name
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfo(IWhereCondition)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfo(ActionObjectQueryTInfo)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfo(String, String)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String, Int32)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String, Int32, Int32)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeNameFromDB
Gets an instance of info object based on the given code name from database
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByFullName(String)
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByFullName(String, Boolean)
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByFullNameInternal
Gets the info by its full name from the database
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByGuid(Guid)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByGuid(Guid, Int32)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByGuidColumn
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByGuidFromDB
Gets an instance of info object based on the given GUID from database
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoById(Int32)
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoById(Int32, Boolean)
Gets the info by its ID.
(Overrides AbstractInfoProviderTInfo, TProviderGetInfoById(Int32, Boolean).)
Protected methodGetInfoByIntColumn
Gets an instance of info object based on the integer column value.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByStringColumn
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetParentWhereCondition
Gets the where condition to limit the objects to specific parent.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetRegularIPAddress
Returns regular expression corresponding to ip address.
Protected methodGetSingleObject
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetSiteWhereCondition(Int32)
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetSiteWhereCondition(Int32, Boolean)
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetTypeInfo
Gets the type info for this provider
(Inherited from BaseAbstractInfoProvider.)
Public methodStatic memberCheckBannedIP
Checks the current IP for being banned for web access
Public methodStatic memberCheckIPandRedirect
Check if IP address id allowed and if not redirects to the page specified in App settings, key CMSBannedIPRedirectURL.
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodCheckUniqueValues
Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodInit
Initializes the provider variables.
(Inherited from BaseAbstractInfoProvider.)
Protected methodInitHashtables
Initializes the hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodInvalidate
Sets this provider as invalid
(Inherited from AbstractProvider.)
Public methodStatic memberIsAllowed(String, BanControlEnum)
Returns true if client IP address (from HttpContext) is allowed to access the site, false if it is banned.
Public methodStatic memberIsAllowed(String, String, BanControlEnum)
Returns true if client IP address is allowed to access the site, false if it is banned.
Public methodStatic memberIsBannedIPEnabled
Returns true if BannedIP module is enabled for specified site (Settings key).
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodStatic memberLoadCachedIPs
Load all banned ip from DB to Hash tables if not yet loaded.
Protected methodLoadGeneration
Loads the specified generation of the objects.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodLoadObjectsToHashtables
Loads the objects from a DataSet to the hashtables
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodNewTransaction
Creates a new transaction over this provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Overrides BaseAbstractInfoProviderProcessWebFarmTask(String, String, Byte).)
Protected methodRecalculateData
Recalculates the value in the given column using the coefficient.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodRefreshObjectsCounts
Updates all counts for all sub-objects.
(Inherited from BaseAbstractInfoProvider.)
Protected methodRegister
Registers current provider in providers collection
(Inherited from AbstractProvider.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodStatic memberReloadCachedIPs
Reload all banned ip from DB to Hash tables.
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodReplaceData
Replaces the data in the given columns.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodResetToDefault
Resets the provider to default implementation
(Inherited from AbstractInfoProviderTProvider.)
Public methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProviderTProvider.)
Public methodStatic memberSetBannedIPInfo
Sets (updates or inserts) specified bannedIP.
Protected methodSetBannedIPInfoInternal
Sets (updates or inserts) specified bannedIP.
Protected methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodSortAlphabetically
Sorts the object alphabetically.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodTouchCacheDependencies
Touches the cache dependencies of the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodUpdateData
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Updates is different than register, because it logs task about changing object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodUseSource(TInfo)
Sets the provider to use given data as data source
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodUseSource(DataQuerySource)
Sets the provider to use given data as data source
(Inherited from BaseAbstractInfoProvider.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Public fieldStatic memberALLOWED
Bool indicating that IP was allowed.
Public fieldStatic memberDENIED
Bool indicating that IP was denied.
Protected fieldhashtableLock
Table lock for loading hashtables
(Inherited from BaseAbstractInfoProvider.)
Protected fieldinfos
Info tables.
(Inherited from BaseAbstractInfoProvider.)
Protected fieldmTypeInfo
Object type information.
(Inherited from BaseAbstractInfoProvider.)
Top
Properties
  NameDescription
Protected propertyStatic memberCachedBannedIPs
Contains denied IP address which accessed site from last change in banned IP info objects.
Protected propertyDataSource
Data source for the provider
(Inherited from BaseAbstractInfoProvider.)
Protected propertyGenerationColumn Obsolete.
Column used to filter the data according the generation in which the items should be loaded.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyStatic memberGlobalBannedIPs
Stores global banned IPs and if it is allowed.
Public propertyHashtableSettings
Hashtable settings
(Inherited from BaseAbstractInfoProvider.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public propertyInfoType
Returns the type of the info object for this provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public propertyIsDataAvailable
Returns true if the data is available for this provider
(Inherited from BaseAbstractInfoProvider.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractProvider.)
Public propertyStatic memberLastChange
Returns time of the last change in banned IP settings.
Protected propertyLoadHashtables Obsolete.
Determines the mode in which the hashtables should be loaded. In case the hashtables are loaded through generations, you must also specify the GenerationColumn property.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyProviderName
Provider name
(Inherited from BaseAbstractInfoProvider.)
Protected propertyStatic memberSitesBannedIPs
Stores site related banned IPs and if it is allowed.
Public propertyStoreEmptyValuesInHashtables
If true, provider hashtables store empty values for not found objects to reduce database calls
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public propertyTypeInfo
Object type information.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseFullNameHashtable Obsolete.
If true, the full name hashtable is allowed to be used.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseGUIDHashtable Obsolete.
If true, the guid hashtable is allowed to be used.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseHashtables Obsolete.
If true, the provider uses hashtables.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseIDHashtable Obsolete.
If true, the ID hashtable is allowed to be used.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseNameHashtable Obsolete.
If true, the code name hashtable is allowed to be used.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseWeakReferences Obsolete.
If true, the weak references are used for the items so the memory can be cleared upon request
(Inherited from BaseAbstractInfoProvider.)
Top
See Also