loggingprovider.cs

SharpNuke源代码

using System;
using System.Collections;

//
// DotNetNuke -  http://www.dotnetnuke.com
// Copyright (c) 2002-2005
// by Shaun Walker ( [e-mail] ) of Perpetual Motion Interactive Systems Inc. ( http://www.perpetualmotion.ca )
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
// to permit persons to whom the Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or substantial portions
// of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
// CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//

namespace DotNetNuke.Services.Log.EventLog
{
	
	public abstract class LoggingProvider
	{
		
		public enum ReturnType
		{
			LogInfoObjects,
			XML
		}
		
		#region "Shared/Static Methods"
		
		// singleton reference to the instantiated object
		private static LoggingProvider loggingProvider;
		
		// constructor
		static LoggingProvider() 
		{
			CreateProvider();
		}
		
		// dynamically create provider
		private static void CreateProvider ()
		{
			loggingProvider = ((LoggingProvider) DotNetNuke.Framework.Reflection.CreateObject("logging"));
		}
		
		// return the provider
		public static LoggingProvider Instance()
		{
			return loggingProvider;
		}
		
		#endregion
		
		#region "Abstract Methods"
		
		// methods to return functionality support indicators
		public abstract bool SupportsEmailNotification();
		public abstract bool SupportsInternalViewer();
		public abstract bool LoggingIsEnabled(string logType, int portalID);
		public abstract bool SupportsSendToCoreTeam();
		public abstract bool SupportsSendViaEmail();
		
		// method to add a log entry
		public abstract void AddLog (LogInfo logInfo);
		public abstract void DeleteLog (LogInfo logInfo);
		public abstract void ClearLog ();
		public abstract void PurgeLogBuffer ();
		public abstract void SendLogNotifications ();
		
		// methods to get the log configuration info
		public abstract ArrayList GetLogTypeConfigInfo();
		public abstract LogTypeConfigInfo GetLogTypeConfigInfoByID(string logTypeConfigID);
		public abstract ArrayList GetLogTypeInfo();
		
		public abstract void AddLogTypeConfigInfo (string logTypeConfigID, bool loggingIsActive, string logTypeKey, 
			string logTypePortalID, string keepMostRecent, string logFileName, bool emailNotificationIsActive, 
			string threshold, string notificationThresholdTime, string notificationThresholdTimeType, 
			string mailFromAddress, string mailToAddress);
		public abstract void UpdateLogTypeConfigInfo (string logTypeConfigID, bool loggingIsActive, string logTypeKey, 
			string logTypeportalID, string keepMostRecent, string logFileName, bool emailNotificationIsActive, 
			string threshold, string notificationThresholdTime, string notificationThresholdTimeType, 
			string mailFromAddress, string mailToAddress);
		public abstract void DeleteLogTypeConfigInfo (string logTypeConfigID);
		
		public abstract void AddLogType (string logTypeKey, string logTypeFriendlyName, string logTypeDescription, 
			string logTypeCSSClass, string logTypeOwner);
		public abstract void UpdateLogType (string logTypeKey, string logTypeFriendlyName, string logTypeDescription, 
			string logTypeCSSClass, string logTypeOwner);
		public abstract void DeleteLogType (string logTypeKey);
		
		// methods to get the log entries
		public abstract object GetSingleLog(LogInfo logInfo, ReturnType returnType);
		public abstract LogInfoArray GetLog();
		public abstract LogInfoArray GetLog(string logType);
		public abstract LogInfoArray GetLog(int portalID);
		public abstract LogInfoArray GetLog(int portalID, string logType);
		
		public abstract LogInfoArray GetLog(int pageSize, int pageIndex, ref int totalRecords);
		public abstract LogInfoArray GetLog(string logType, int pageSize, int pageIndex, ref int totalRecords);
		public abstract LogInfoArray GetLog(int portalID, int pageSize, int pageIndex, ref int totalRecords);
		public abstract LogInfoArray GetLog(int portalID, string logType, int pageSize, int pageIndex, ref int totalRecords);
		#endregion
		
	}
	
}