BannedIPInfoProvider Class

Class providing BannedIPInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<BannedIPInfo, BannedIPInfoProvider, ObjectQuery<BannedIPInfo>>
    CMS.DataEngine.AbstractInfoProvider<BannedIPInfo, BannedIPInfoProvider>
      CMS.Protection.BannedIPInfoProvider

Namespace: CMS.Protection
Assembly: CMS.Protection (in CMS.Protection.dll) Version: 12.0.0

Syntax

public class BannedIPInfoProvider : AbstractInfoProvider<BannedIPInfo, BannedIPInfoProvider>

The BannedIPInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	BannedIPInfoProvider

Fields

	Name	Description
Public field Static member	ALLOWED	Bool indicating that IP was allowed.
Public field Static member	DENIED	Bool indicating that IP was denied.
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Properties

	Name	Description
Protected property	CachedBannedIPs	Contains denied IP address which accessed site from last change in banned IP info objects. Increases performance when attacker is spamming.
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	GlobalBannedIPs	Stores global banned IPs and if it is allowed.
Public property	HashtableSettings	Gets hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property Static member	LastChange	Returns time of the last change in banned IP settings.
Protected property	LastChangeInternal	Returns time of the last change in banned IP settings.
Protected property	SitesBannedIPs	Stores site related banned IPs and if it is allowed.
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Methods

	Name	Description
Public method Static member	BanRedirect	Redirects current http response to special page for banned IPs (settings key CMSBannedIPRedirectURL).
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkDelete	Bulk deletes info objects based on the given condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	CheckBannedIP	Checks the current IP for being banned for web access
Public method Static member	CheckIPandRedirect	Check if IP address id allowed and if not redirects to the page specified in App settings, key CMSBannedIPRedirectURL.
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	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 AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ClearHashtables	Clears the object's hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteBannedIPInfo(Int32)	Deletes specified bannedIP.
Public method Static member	DeleteBannedIPInfo(BannedIPInfo)	Deletes specified bannedIP.
Protected method	DeleteInfo	Deletes the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.DeleteInfo(TInfo).)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetBannedIPInfo	Returns the BannedIPInfo structure for the specified bannedIP.
Public method Static member	GetBannedIPs	Returns the query for all banned IPs.
Protected method	GetBannedIPsInternal	Returns the query for all banned IPs.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets the info by its ID. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.GetInfoById(Int32, Boolean).)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetRegularIPAddress	Returns regular expression corresponding to ip address.
Protected method	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Invalidate	Sets this provider as invalid (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	IsAllowed(String, BanControlEnum)	Returns true if client IP address (from HttpContext) is allowed to access the site, false if it is banned.
Public method Static member	IsAllowed(String, String, BanControlEnum)	Returns true if client IP address is allowed to access the site, false if it is banned.
Protected method	IsAllowedInternal	Returns true if client IP address is allowed to access the site, false if it is banned.
Public method Static member	IsBannedIPEnabled	Returns true if BannedIP module is enabled for specified site (Settings key).
Protected method	IsBannedIPEnabledInternal	Returns true if BannedIP module is enabled for specified site (Settings key).
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadCachedIPs	Load all banned ip from DB to Hash tables if not yet loaded.
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.ProcessWebFarmTask(String, String, Byte[]).)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ReloadCachedIPs	Reload all banned ip from DB to Hash tables.
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetBannedIPInfo	Sets (updates or inserts) specified bannedIP.
Protected method	SetInfo	Inserts or Updates the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.SetInfo(TInfo).)
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)