EventLogProvider Class

Provides basic operations with the event log.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<EventLogInfo, EventLogProvider, ObjectQuery<EventLogInfo>>
    CMS.DataEngine.AbstractInfoProvider<EventLogInfo, EventLogProvider>
      CMS.EventLog.EventLogProvider

Namespace: CMS.EventLog
Assembly: CMS.EventLog (in CMS.EventLog.dll) Version: 13.0.131

Syntax

public class EventLogProvider : AbstractInfoProvider<EventLogInfo, EventLogProvider>, 
	IEventLogInfoProvider, IInfoProvider<EventLogInfo>, IInfoByIdProvider<EventLogInfo>

The EventLogProvider type exposes the following members.

Constructors

	Name	Description
Public method	EventLogProvider	Initializes a new instance of the EventLogProvider class.

Fields

	Name	Description
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Properties

	Name	Description
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property Static member	Errors	Counter of errors.
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	LogDocumentFieldChanges	Indicates if log should contain the changes to particular document document fields.
Public property Static member	LogFieldChanges	Indicates if log should contain the changes to particular fields.
Public property Static member	LoggingEnabled	Indicates if logging is enabled.
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property Static member	Warnings	Counter of warnings.

Methods

	Name	Description
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>.)
Protected method	CanLogEvent	Returns true if the event can be logged
Protected method	CannotLogEventInternal	Executes when the event logging throws an error.
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>.)
Public method Static member	ClearEventLog	Obsolete. Clears entire event log and writes new event record with information about this action and the user who performed it. This method is obsolete and will be removed in future version. Use ClearEventLog(Int32, String, String, Int32) method instead.
Protected method	ClearEventLogInternal	Obsolete. Clears entire event log and writes new event record with information about this action and the user who performed it. This method is obsolete and will be removed in future version. Use/override ClearEventLogInternal(Int32, String, String, Int32) method instead. If the behavior of this method was changed by overriding, override that method in the helper class.
Protected method	ClearHashtables	Clears up hashtables of EventLogProvider. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.ClearHashtables(Boolean).)
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	Delete	Deletes the info object from the underlying data store. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Get()	Gets the object query for TInfo retrieval. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid)	Gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Int32)	Gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String)	Gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid, Int32)	Gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String, Int32)	Gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetEventInfoInternal	Obsolete. Returns specified event info object from the event log.
Public method Static member	GetEventLogInfo	Obsolete. Returns specified event info object from the event log.
Public method Static member	GetEventLogText	Creates string representation of event log object.
Protected method	GetEventLogTextInternal	Creates string representation of event log object.
Public method Static member	GetEvents	Obsolete. Returns the query for all events.
Public method Static member	GetExceptionLogMessage	Gets complete log for exception with message and deep stack trace.
Protected method	GetExceptionLogMessageInternal	Gets complete log for exception with message and deep stack trace.
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	GetInfoByCodeNameAsync(String, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)	Asynchronously 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	GetInfoByGuidAsync(Guid, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIdAsync	Asynchronously gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetLogItems	Gets the log items count for specified site.
Protected method	GetLogItemsInternal	Returns the log items count for specified site.
Public method Static member	GetLogSize	Gets the log size for specified site.
Protected method	GetLogSizeInternal	Gets the log size for specified site.
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	GetPreviousNext	Returns the previous and next events of the given event in the order specified by ORDER BY parameter matching the WHERE criteria.
Protected method	GetPreviousNextInternal	Returns the previous and next events of the given event in the order specified by ORDER BY parameter matching the WHERE criteria.
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>.)
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	LogEvent(EventLogInfo)	Writes a new record to the event log.
Public method Static member	LogEvent(String, String, String, String, String, Int32, String, Int32, String, String, Int32, String, String, String, Nullable<DateTime>, LoggingPolicy)	Obsolete. Writes a new record to the event log. This method is obsolete and will be removed in future version. Use LogEvent(EventLogData) or LogEvent(IEventLogService, EventTypeEnum, String, String, String) instead.
Protected method	LogEventInternal(EventLogInfo)	Writes a new record to the event log.
Protected method	LogEventInternal(EventLogInfo, Boolean)	Writes a new record to the event log.
Protected method	LogEventInternal(String, String, String, String, String, Int32, String, Int32, String, String, Int32, String, String, String, Nullable<DateTime>, LoggingPolicy)	Writes a new record to the event log.
Public method Static member	LogException	Obsolete. Writes a new error to the event log. This method is obsolete and will be removed in future version. Use LogEvent(EventLogData) or LogException(IEventLogService, String, String, Exception, Int32, String, LoggingPolicy) instead.
Protected method	LogExceptionInternal	Writes a new error to the event log.
Public method Static member	LogInformation	Obsolete. Writes a new information to the event log. This method is obsolete and will be removed in future version. Use LogEvent(EventLogData) or LogInformation(IEventLogService, String, String, String, Int32, LoggingPolicy) instead.
Public method Static member	LogMetadata	Returns true if the metadata should be logged.
Public method Static member	LogWarning	Obsolete. Writes a new warning to the event log. This method is obsolete and will be removed in future version. Use LogEvent(EventLogData) or LogWarning(IEventLogService, String, String, Exception, Int32, String, LoggingPolicy) instead.
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.ProcessWebFarmTaskInternal(String, String, Byte[]).)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Set	Inserts or updates the info object in the underlying data store. (Overrides AbstractInfoProvider<TInfo, TProvider>.Set(TInfo).)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider. Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization). (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetEventLogInfo	Obsolete. Sets event log.
Protected method	SetEventLogInfoInternal	Obsolete. Sets event log.
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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>.)