void Update(string statusMessage)
{
// temp stop timer
_heartbeatTimer.Change(System.Threading.Timeout.Infinite, System.Threading.Timeout.Infinite);
DbTableDmlMgr dmlUpdateMgr = _daMgr.DbCatalogGetTableDmlMgr(DataAccess.Constants.SCHEMA_CORE
, Constants.AppSessions);
dmlUpdateMgr.SetWhereCondition((j) => j.Column(Constants.AppCode)
== j.Parameter(dmlUpdateMgr.MainTable.SchemaName
, dmlUpdateMgr.MainTable.TableName
, Constants.AppCode
, _daMgr.BuildParamName(Constants.AppCode)) &&
j.Column(Constants.MultipleSessionCode)
== j.Parameter(dmlUpdateMgr.MainTable.SchemaName
, dmlUpdateMgr.MainTable.TableName
, Constants.MultipleSessionCode
, _daMgr.BuildParamName(Constants.MultipleSessionCode)));
dmlUpdateMgr.AddColumn(Constants.StatusMessage, _daMgr.BuildParamName(Constants.StatusMessage));
dmlUpdateMgr.AddColumn(Constants.StatusDateTime, Core.EnumDateTimeLocale.UTC);
DbCommand dbCmdUpdate = _daMgr.BuildUpdateDbCommand(dmlUpdateMgr);
dbCmdUpdate.Parameters[_daMgr.BuildParamName(Constants.AppCode)].Value = _appCode;
dbCmdUpdate.Parameters[_daMgr.BuildParamName(Constants.MultipleSessionCode)].Value = _appSessionCode;
dbCmdUpdate.Parameters[_daMgr.BuildParamName(Constants.StatusMessage)].Value = statusMessage;
DbCommandMgr dbCmdMgr = new DbCommandMgr(_daMgr);
dbCmdMgr.AddDbCommand(dbCmdUpdate);
// refresh signon control
List <string> tableNames = new List <string>();
DbTableDmlMgr dmlSelectMgr = _daMgr.DbCatalogGetTableDmlMgr(DataAccess.Constants.SCHEMA_CORE
, Constants.SignonControl);
DbCommand dbCmdSelect = _daMgr.BuildSelectDbCommand(dmlSelectMgr, null);
dbCmdMgr.AddDbCommand(dbCmdSelect);
tableNames.Add(Constants.SignonControl);
// refresh app sessions
dmlSelectMgr = _daMgr.DbCatalogGetTableDmlMgr(DataAccess.Constants.SCHEMA_CORE
, Constants.AppSessions);
dbCmdSelect = _daMgr.BuildSelectDbCommand(dmlSelectMgr, null);
dbCmdMgr.AddDbCommand(dbCmdSelect);
tableNames.Add(Constants.AppSessions);
DataSet controldata = dbCmdMgr.ExecuteDataSet(tableNames);
_signonControl.Refresh(controldata.Tables[Constants.SignonControl]);
_appSessions = controldata.Tables[Constants.AppSessions];
// temp start timer
_heartbeatTimer.Change(_signonControl.SignonControlData.StatusSeconds * 1000
, _signonControl.SignonControlData.StatusSeconds * 1000);
}
/// <summary>
/// Adds a record to the session database table
/// </summary>
/// <param name="daMgr">DataAccessMgr object</param>
/// <param name="userId">Unique user identifier</param>
/// <param name="userCode">Unique numeric user identifier</param>
/// <param name="userEnv">MetaData about the user's environment</param>
/// <returns>A unique session code</returns>
static Int64 AddSession(DataAccessMgr daMgr, string userId, Int32 userCode, UserEnvironmentStructure userEnv)
{
Int64 sessionCode = daMgr.GetNextSequenceNumber(Constants.SessionCode);
DbTableDmlMgr dmlInsert = daMgr.DbCatalogGetTableDmlMgr(DataAccess.Constants.SCHEMA_CORE
, Constants.UserSessions);
dmlInsert.AddColumn(Constants.SessionCode, daMgr.BuildParamName(Constants.SessionCode));
dmlInsert.AddColumn(Constants.UserCode, daMgr.BuildParamName(Constants.UserCode));
dmlInsert.AddColumn(Constants.UserId, daMgr.BuildParamName(Constants.UserId));
dmlInsert.AddColumn(Constants.AppCode, daMgr.BuildParamName(Constants.AppCode));
dmlInsert.AddColumn(Constants.AppId, daMgr.BuildParamName(Constants.AppId));
dmlInsert.AddColumn(Constants.AppMachine, daMgr.BuildParamName(Constants.AppMachine));
dmlInsert.AddColumn(Constants.AppVersion, daMgr.BuildParamName(Constants.AppVersion));
dmlInsert.AddColumn(Constants.RemoteAddress, daMgr.BuildParamName(Constants.RemoteAddress));
DbCommand cmdInsert = daMgr.BuildInsertDbCommand(dmlInsert);
cmdInsert.Parameters[daMgr.BuildParamName(Constants.SessionCode)].Value = sessionCode;
cmdInsert.Parameters[daMgr.BuildParamName(Constants.UserId)].Value = userId;
cmdInsert.Parameters[daMgr.BuildParamName(Constants.UserCode)].Value = userCode;
cmdInsert.Parameters[daMgr.BuildParamName(Constants.AppId)].Value = userEnv.AppId;
cmdInsert.Parameters[daMgr.BuildParamName(Constants.AppCode)].Value = userEnv.AppCode;
cmdInsert.Parameters[daMgr.BuildParamName(Constants.AppVersion)].Value = userEnv.AppVersion;
cmdInsert.Parameters[daMgr.BuildParamName(Constants.RemoteAddress)].Value = userEnv.RemoteAddress;
cmdInsert.Parameters[daMgr.BuildParamName(Constants.AppMachine)].Value = Environment.MachineName;
DbTableDmlMgr dmlUpdate = daMgr.DbCatalogGetTableDmlMgr(DataAccess.Constants.SCHEMA_CORE
, Constants.UserMaster);
dmlUpdate.AddColumn(Constants.FailedSignonAttempts
, daMgr.BuildParamName(Constants.FailedSignonAttempts));
dmlUpdate.AddColumn(Constants.LastSignonDateTime
, EnumDateTimeLocale.Default);
dmlUpdate.SetWhereCondition((j) => j.Column(Constants.UserId)
== j.Parameter(dmlUpdate.MainTable.SchemaName
, dmlUpdate.MainTable.TableName
, Constants.UserId
, daMgr.BuildParamName(Constants.UserId)));
DbCommand cmdUpdate = daMgr.BuildUpdateDbCommand(dmlUpdate);
cmdUpdate.Parameters[daMgr.BuildParamName(Constants.UserId)].Value
= userId;
cmdUpdate.Parameters[daMgr.BuildParamName(Constants.FailedSignonAttempts)].Value
= 0;
DbCommandMgr cmdMgr = new DbCommandMgr(daMgr);
cmdMgr.AddDbCommand(cmdInsert);
cmdMgr.AddDbCommand(cmdUpdate);
cmdMgr.ExecuteNonQuery();
return(sessionCode);
}
/// <summary>
/// Constructor accepting the assembly and a usercode performing the registration
/// </summary>
/// <param name="daMgr">DataAccess manager object</param>
/// <param name="assemblyName">Fully qualified assembly name</param>
/// <param name="assemblyFileName">Fully qualified assembly path and filename</param>
/// <param name="userCode">Usercode of user performing registration</param>
/// <returns></returns>
public static Int32 RegisterAssemblyTasks(DataAccessMgr daMgr
, string assemblyName
, string assemblyFileName
, Int32?userCode)
{
// Load the assemlb
Assembly asm = Assembly.LoadFrom(assemblyFileName);
DbCommandMgr cmdMgr = new DbCommandMgr(daMgr);
DbTableDmlMgr dmlMgr = new DbTableDmlMgr(daMgr, DataAccess.Constants.SCHEMA_CORE, Constants.TaskRegistrations);
dmlMgr.AddColumn(Constants.TaskId, daMgr.BuildParamName(Constants.TaskId), DbTableColumnType.ForInsertOnly);
dmlMgr.AddColumn(Constants.AssemblyName, daMgr.BuildParamName(Constants.AssemblyName));
dmlMgr.AddColumn(Constants.TaskDescription, daMgr.BuildParamName(Constants.TaskDescription));
dmlMgr.AddColumn(Constants.LastRegisteredDate, EnumDateTimeLocale.Default);
// if usercode was provided add it to last mod key
if (userCode.HasValue)
{
dmlMgr.AddColumn(Constants.LastModifiedUserCode, daMgr.BuildParamName(Constants.LastModifiedUserCode));
dmlMgr.AddColumn(Constants.LastModifiedDateTime, EnumDateTimeLocale.Default);
}
dmlMgr.SetWhereCondition((j) =>
j.Column(Constants.TaskId) ==
j.Parameter(Constants.TaskRegistrations
, Constants.TaskId
, daMgr.BuildParamName(Constants.TaskId)));
// build a merge statement
DbCommand dbCmd = daMgr.BuildMergeDbCommand(dmlMgr);
int typesFound = 0;
// set the values for the dbCommand
foreach (Type t in ObjectFactory.SearchTypes <TaskProcess>(asm))
{
// we must create the task object in or to have access to the TaskDesve
TaskProcess tp = ObjectFactory.Create <TaskProcess>(assemblyFileName, t.FullName, null, null, null, null, null, null);
dbCmd.Parameters[daMgr.BuildParamName(Constants.TaskId)].Value = t.FullName;
dbCmd.Parameters[daMgr.BuildParamName(Constants.AssemblyName)].Value = assemblyName;
dbCmd.Parameters[daMgr.BuildParamName(Constants.TaskDescription)].Value = tp.TaskDescription();
if (userCode.HasValue)
{
dbCmd.Parameters[daMgr.BuildParamName(Constants.LastModifiedUserCode)].Value = userCode.Value;
}
cmdMgr.AddDbCommand(dbCmd);
++typesFound;
}
// register the task (update it if exists otherwise insert)
cmdMgr.ExecuteNonQuery();
return(typesFound);
}
/// <summary>
/// Increases the signon failure account for the given user identifier and returns the latest count
/// </summary>
/// <param name="daMgr">DataAccessMgr object</param>
/// <param name="userId">Unique user identifier</param>
/// <returns>The icremented count of failed attempts</returns>
static Int16 IncreaseFailedAttemptCount(DataAccessMgr daMgr, string userId)
{
DbTableDmlMgr dmlUpdate = daMgr.DbCatalogGetTableDmlMgr(DataAccess.Constants.SCHEMA_CORE
, Constants.UserMaster);
DbFunctionStructure addOne = new DbFunctionStructure();
addOne.FunctionBody = string.Format("{0} + 1", Constants.FailedSignonAttempts);
dmlUpdate.AddColumn(Constants.FailedSignonAttempts
, addOne);
dmlUpdate.SetWhereCondition((j) => j.Column(Constants.UserId)
== j.Parameter(dmlUpdate.MainTable.SchemaName
, dmlUpdate.MainTable.TableName
, Constants.UserId
, daMgr.BuildParamName(Constants.UserId)));
DbCommand cmdUpdate = daMgr.BuildUpdateDbCommand(dmlUpdate);
cmdUpdate.Parameters[daMgr.BuildParamName(Constants.UserId)].Value
= userId;
DbTableDmlMgr dmlSelectMgr = daMgr.DbCatalogGetTableDmlMgr(DataAccess.Constants.SCHEMA_CORE
, Constants.UserMaster
, Constants.FailedSignonAttempts);
dmlSelectMgr.SetWhereCondition((j) => j.Column(Constants.UserId)
== j.Parameter(dmlSelectMgr.MainTable.SchemaName
, dmlSelectMgr.MainTable.TableName
, Constants.UserId
, daMgr.BuildParamName(Constants.UserId)));
DbCommand cmdSelectUserMaster = daMgr.BuildSelectDbCommand(dmlSelectMgr, null);
cmdSelectUserMaster.Parameters[daMgr.BuildParamName(Constants.UserId)].Value = userId;
DbCommandMgr cmdMgr = new DbCommandMgr(daMgr);
cmdMgr.AddDbCommand(cmdUpdate);
cmdMgr.AddDbCommand(cmdSelectUserMaster);
DataTable userMaster = cmdMgr.ExecuteDataTable();
return(Convert.ToInt16(userMaster.Rows[0][Constants.FailedSignonAttempts]));
}
/// <summary>
/// Implements the user signon operation
/// </summary>
/// <param name="daMgr">DataAccessMgr object</param>
/// <param name="signonControl">SignonControl data structure</param>
/// <param name="userId">Unique user identifier</param>
/// <param name="userPassword">User's password (NULL for first time initialization)</param>
/// <param name="userEnv">Meta data about user's environment</param>
/// <param name="allowMultipleSessions">Indicates whether to allow multiple session for an account that was not setup for multiple sessions</param>
/// <returns>SignonResult data structure</returns>
public static SignonResultsStructure Signon(DataAccessMgr daMgr
, SignonControl signonControl
, string userId
, string userPassword
, UserEnvironmentStructure userEnv
, bool allowMultipleSessions = false)
{
SignonResultsStructure results = new SignonResultsStructure();
results.ResultEnum = SignonResultsEnum.Success;
results.ResultMessage = null;
DbTableDmlMgr dmlSelectMgr = daMgr.DbCatalogGetTableDmlMgr(DataAccess.Constants.SCHEMA_CORE
, Constants.UserMaster
, Constants.UserCode
, Constants.UserPassword
, Constants.PasswordSalt
, Constants.SignonRestricted
, Constants.LastSignonDateTime
, Constants.FailedSignonAttempts
, Constants.ForcePasswordChange
, Constants.MultipleSignonAllowed
, Constants.DefaultAccessGroupCode);
dmlSelectMgr.SetWhereCondition((j) => j.Column(Constants.UserId)
== j.Parameter(dmlSelectMgr.MainTable.SchemaName
, dmlSelectMgr.MainTable.TableName
, Constants.UserId
, daMgr.BuildParamName(Constants.UserId)));
DbCommand cmdSelectUserMaster = daMgr.BuildSelectDbCommand(dmlSelectMgr, null);
cmdSelectUserMaster.Parameters[daMgr.BuildParamName(Constants.UserId)].Value = userId;
DbCommandMgr dbCmdMgr = new DbCommandMgr(daMgr);
dbCmdMgr.AddDbCommand(cmdSelectUserMaster);
if (!allowMultipleSessions)
{
dmlSelectMgr = daMgr.DbCatalogGetTableDmlMgr(DataAccess.Constants.SCHEMA_CORE
, Constants.UserSessions
, Constants.SessionCode
, Constants.SessionDateTime
, Constants.ForceSignOff);
dmlSelectMgr.SetWhereCondition((j) => j.Column(Constants.UserId)
== j.Parameter(dmlSelectMgr.MainTable.SchemaName
, dmlSelectMgr.MainTable.TableName
, Constants.UserId
, daMgr.BuildParamName(Constants.UserId)));
DbCommand cmdSelectSessions = daMgr.BuildSelectDbCommand(dmlSelectMgr, null);
cmdSelectSessions.Parameters[daMgr.BuildParamName(Constants.UserId)].Value = userId;
dbCmdMgr.AddDbCommand(cmdSelectSessions);
}
List <string> tableNames = new List <string>();
tableNames.Add(Constants.UserMaster);
if (!allowMultipleSessions)
{
tableNames.Add(Constants.UserSessions);
}
DataSet userSigonData = dbCmdMgr.ExecuteDataSet(tableNames);
DataTable userMaster = userSigonData.Tables[Constants.UserMaster];
// see if the userId exists and that the password is correct
if (userMaster.Rows.Count == 0)
{
// userId does not exists, return an invalid credentials message
results.ResultEnum = SignonResultsEnum.InvaldCredentials;
results.ResultMessage = "Incorrect UserId or Password, please try again.";
return(results);
}
string storedUserPassword = userMaster.Rows[0][Constants.UserPassword].ToString();
string passwordSalt = userMaster.Rows[0][Constants.PasswordSalt].ToString();
userPassword = Cryptography.HashOperation.ComputeHash(HashAlgorithmTypeEnum.SHA512HashAlgorithm, userPassword, passwordSalt);
if (storedUserPassword != userPassword)
{
// invalid credentials; do not indicate whether userId or password is incorrect
results.ResultEnum = SignonResultsEnum.InvaldCredentials;
results.ResultMessage = "Incorrect UserId or Password, please try again.";
Int16 failedAttempts = IncreaseFailedAttemptCount(daMgr, userId);
// check for failed limit and restrict account
if (failedAttempts >= signonControl.SignonControlData.FailedAttemptLimit)
{
RestrictSignon(daMgr, userId);
}
return(results);
}
// Since the UserId and Password matched, we found the account,
// now check for account level restrictions
bool signonRestricted = Convert.ToBoolean(userMaster.Rows[0][Constants.SignonRestricted]);
if (signonRestricted)
{
// invalid credentials; do not indicate whether userId or password is incorrect
results.ResultEnum = SignonResultsEnum.SignonsRestricted;
results.ResultMessage = "The account is restrcited from signing on.";
return(results);
}
bool ForcePasswordChange = Convert.ToBoolean(userMaster.Rows[0][Constants.ForcePasswordChange]);
if (ForcePasswordChange)
{
// invalid credentials; do not indicate whether userId or password is incorrect
results.ResultEnum = SignonResultsEnum.PasswordChangeRequired;
results.ResultMessage = "The account requires a password change before proceeding.";
return(results);
}
if (!allowMultipleSessions)
{
bool MultipleSignonAllowed = Convert.ToBoolean(userMaster.Rows[0][Constants.MultipleSignonAllowed]);
DataTable userSessions = userSigonData.Tables[Constants.UserSessions];
Int16 sessionCount = 0;
foreach (DataRow userSession in userSessions.Rows)
{
DateTime sessionDateTime = Convert.ToDateTime(userSession[Constants.SessionDateTime]);
TimeSpan sessionInterval = daMgr.DbSynchTime - sessionDateTime;
if (sessionInterval.TotalSeconds < signonControl.SignonControlData.TimeOutSeconds)
{
if (!MultipleSignonAllowed)
{
// if the user cannot have multiple signons, then we must check
// for existing (Active) session
results.ResultEnum = SignonResultsEnum.MultipleSignonRestricted;
results.ResultMessage = "The account can only have a single signon session. They must signOff the other session first.";
return(results);
}
++sessionCount;
}
}
}
// if the userId and password are correct, check signon control (general restrictions)
if (signonControl.SignonControlData.RestrictSignon)
{
results.ResultEnum = SignonResultsEnum.SignonsRestricted;
results.ResultMessage = signonControl.SignonControlData.RestrictSignonMsg;
return(results);
}
if (signonControl.SignonControlData.ForceSignoff)
{
results.ResultEnum = SignonResultsEnum.ForcedSignoff;
results.ResultMessage = signonControl.SignonControlData.SignoffWarningMsg;
return(results);
}
// successful signon
UserSignonSessionStructure uss = new UserSignonSessionStructure();
uss.UserCode = Convert.ToInt32(userMaster.Rows[0][Constants.UserCode]);
uss.PasswordHash = userMaster.Rows[0][Constants.UserPassword].ToString();
uss.DefaultAccessGroupCode = Convert.ToInt32(userMaster.Rows[0][Constants.DefaultAccessGroupCode]);
uss.UserId = userId;
uss.SignonApp.AppCode = userEnv.AppCode;
uss.SignonApp.AppId = userEnv.AppId;
uss.SignonApp.AppVersion = userEnv.AppVersion;
uss.SessionCode = AddSession(daMgr, userId, uss.UserCode, userEnv);
UserSession sessionMgr = new UserSession(daMgr, uss);
results.ResultMessage = "Welcome.";
if (userMaster.Rows[0][Constants.LastSignonDateTime] != DBNull.Value)
{
DateTime signonDateTime = Convert.ToDateTime(userMaster.Rows[0][Constants.LastSignonDateTime]);
results.ResultMessage += " Your last signon was: ." + signonDateTime.ToString();
}
results.ResultEnum = SignonResultsEnum.Success;
results.UserSessionMgr = sessionMgr;
return(results);
}
/// <summary>
/// Method with change the settings of the SignonControl table to the given new settings only if they have not already been changed.
/// <para>If </para>
/// </summary>
/// <param name="lastModifiedUser">The userCode of the user who last updated the record (or null if not changed)</param>
/// <param name="lastModifiedDateTime">The DateTime of when the user last updated the record (or null if not changed)</param>
/// <param name="newControlSettings">Signon Control Data Strcutre containing the new values.</param>
/// <returns>Boolean indicating if record was changed or not.</returns>
internal bool ChangeControl(int?lastModifiedByUserCode
, DateTime?lastModifiedDateTime
, SignonControlStructure newControlSettings)
{
DbTableDmlMgr dmlChange = _daMgr.DbCatalogGetTableDmlMgr(DataAccess.Constants.SCHEMA_CORE
, Constants.SignonControl);
dmlChange.AddColumn(Constants.TimeoutSeconds);
dmlChange.AddColumn(Constants.SignoffWarningMsg);
dmlChange.AddColumn(Constants.ForceSignOff);
dmlChange.AddColumn(Constants.RestrictSignon);
dmlChange.AddColumn(Constants.StatusSeconds);
dmlChange.AddColumn(Constants.RestrictSignonMsg);
dmlChange.AddColumn(Constants.FailedAttemptLimit);
dmlChange.SetWhereCondition((j) =>
j.Column(Constants.SignonControl) ==
j.Parameter(Constants.SignonControl));
DbCommandMgr dbCmdMgr = new DbCommandMgr(_daMgr);
DbCommand cmdChangeOrig = _daMgr.BuildChangeDbCommand(dmlChange
, Constants.LastModifiedUserCode
, Constants.LastModifiedDateTime);
cmdChangeOrig.Parameters[_daMgr.BuildParamName(Constants.ControlCode)].Value
= newControlSettings.SessionControlCode;
cmdChangeOrig.Parameters[_daMgr.BuildParamName(Constants.TimeoutSeconds)].Value
= Convert.ToInt16(newControlSettings.TimeOutSeconds);
cmdChangeOrig.Parameters[_daMgr.BuildParamName(Constants.SignoffWarningMsg)].Value
= newControlSettings.SignoffWarningMsg;
cmdChangeOrig.Parameters[_daMgr.BuildParamName(Constants.ForceSignOff)].Value
= newControlSettings.ForceSignoff;
cmdChangeOrig.Parameters[_daMgr.BuildParamName(Constants.RestrictSignon)].Value
= newControlSettings.RestrictSignon;
cmdChangeOrig.Parameters[_daMgr.BuildParamName(Constants.RestrictSignonMsg)].Value
= newControlSettings.RestrictSignonMsg;
cmdChangeOrig.Parameters[_daMgr.BuildParamName(Constants.StatusSeconds)].Value
= newControlSettings.StatusSeconds;
cmdChangeOrig.Parameters[_daMgr.BuildParamName(Constants.FailedAttemptLimit)].Value
= newControlSettings.FailedAttemptLimit;
if (lastModifiedByUserCode.HasValue)
{
cmdChangeOrig.Parameters[_daMgr.BuildParamName(Constants.LastModifiedUserCode)].Value
= lastModifiedByUserCode.Value;
}
if (lastModifiedDateTime.HasValue)
{
cmdChangeOrig.Parameters[_daMgr.BuildParamName(Constants.LastModifiedDateTime)].Value
= lastModifiedDateTime.Value;
}
if (newControlSettings.LastModifiedByUserCode.HasValue)
{
cmdChangeOrig.Parameters[_daMgr.BuildParamName(Constants.LastModifiedUserCode, true)].Value
= newControlSettings.LastModifiedByUserCode.Value;
}
cmdChangeOrig.Parameters[_daMgr.BuildParamName(Constants.LastModifiedDateTime, true)].Value
= newControlSettings.LastModifiedByDateTime.Value;
int rowsAffected = _daMgr.ExecuteNonQuery(cmdChangeOrig, null, null);
if (rowsAffected == 1)
{
_signonControl.FailedAttemptLimit = newControlSettings.FailedAttemptLimit;
_signonControl.ForceSignoff = newControlSettings.ForceSignoff;
_signonControl.RestrictSignon = newControlSettings.RestrictSignon;
_signonControl.RestrictSignonMsg = newControlSettings.RestrictSignonMsg;
_signonControl.SignoffWarningMsg = newControlSettings.SignoffWarningMsg;
_signonControl.StatusSeconds = newControlSettings.StatusSeconds;
_signonControl.TimeOutSeconds = newControlSettings.TimeOutSeconds;
_signonControl.LastModifiedByUserCode = newControlSettings.LastModifiedByUserCode;
_signonControl.LastModifiedByDateTime = newControlSettings.LastModifiedByDateTime;
return(true);
}
else
{
return(false);
}
}
/// <summary>
/// Method to begin session for the application.
/// <para>Once started, the application session record will also be updated by the heartbeat process.</para>
/// <para>The frequency of the heartbeat process is controlled by the SignonControl.StatusSeconds column.</para>
/// <para>If the application is a TaskProcessingEngine, then there can be only a single active instance
/// for a given AppId. If there is a violation, a string message will be returned. The caller, can recall
/// this method with the overWrite parameter = true. In that case the existing record will be removed.</para>
/// </summary>
/// <param name="configSettings">A string of configuration settings used by the application</param>
/// <param name="statusMsg">A startup status message by the application</param>
/// <param name="overwrite">Indicates whether or not to overwrite an existing record for the AppId</param>
/// <param name="tpeEndpointAddress">Indentifies the WCF host endpoint address of when app is a TPE</param>
/// <returns>Null for success; error message otherwise.</returns>
public string Start(string configSettings, string statusMsg, bool overwrite, string tpeEndpointAddress = null)
{
DbTableDmlMgr dmlSelectMgr = _daMgr.DbCatalogGetTableDmlMgr(DataAccess.Constants.SCHEMA_CORE
, Constants.AppSessions);
DbCommand dbCmdSelect = _daMgr.BuildSelectDbCommand(dmlSelectMgr, null);
DbTableDmlMgr dmlInsertMgr = _daMgr.DbCatalogGetTableDmlMgr(DataAccess.Constants.SCHEMA_CORE
, Constants.AppSessions);
dmlInsertMgr.AddColumn(Constants.AppId, _daMgr.BuildParamName(Constants.AppId));
dmlInsertMgr.AddColumn(Constants.AppCode, _daMgr.BuildParamName(Constants.AppCode));
dmlInsertMgr.AddColumn(Constants.AppVersion, _daMgr.BuildParamName(Constants.AppVersion));
dmlInsertMgr.AddColumn(Constants.AppName, _daMgr.BuildParamName(Constants.AppName));
dmlInsertMgr.AddColumn(Constants.MultipleSessionCode, _daMgr.BuildParamName(Constants.MultipleSessionCode));
dmlInsertMgr.AddColumn(Constants.ProcessId, _daMgr.BuildParamName(Constants.ProcessId));
dmlInsertMgr.AddColumn(Constants.StatusMessage, _daMgr.BuildParamName(Constants.StatusMessage));
dmlInsertMgr.AddColumn(Constants.ConfigSettings, _daMgr.BuildParamName(Constants.ConfigSettings));
dmlInsertMgr.AddColumn(Constants.EnvironmentSettings, _daMgr.BuildParamName(Constants.EnvironmentSettings));
dmlInsertMgr.AddColumn(Constants.MachineName, _daMgr.BuildParamName(Constants.MachineName));
dmlInsertMgr.AddColumn(Constants.TpeEndpointAddress, _daMgr.BuildParamName(Constants.TpeEndpointAddress));
DbCommand dbCmdInsert = _daMgr.BuildInsertDbCommand(dmlInsertMgr);
DbCommandMgr dbCmdMgr = new DbCommandMgr(_daMgr);
StringBuilder sb = new StringBuilder();
sb.AppendFormat("AllowMultipleSessions: {0} {1}", _allowMultipleSessions, Environment.NewLine);
sb.AppendFormat("OS Version: {0} {1}", Environment.OSVersion, Environment.NewLine);
sb.AppendFormat("ProcessName: {0} {1}", Process.GetCurrentProcess().ProcessName, Environment.NewLine);
sb.AppendFormat("CLR Version: {0} {1}", Environment.Version, Environment.NewLine);
sb.AppendFormat("DbProvider Version: {0} {1}", _daMgr.DbProviderVersion, Environment.NewLine);
sb.AppendFormat("DbServer Version: {0} {1}", _daMgr.DbServerVersion, Environment.NewLine);
sb.AppendFormat("Is x64bit OS: {0} {1}", Environment.Is64BitOperatingSystem, Environment.NewLine);
sb.AppendFormat("Is x64bit process: {0} {1}", Environment.Is64BitProcess, Environment.NewLine);
sb.AppendFormat("Processor Count: {0} {1}", Environment.ProcessorCount, Environment.NewLine);
dbCmdInsert.Parameters[_daMgr.BuildParamName(Constants.AppId)].Value = _appId;
dbCmdInsert.Parameters[_daMgr.BuildParamName(Constants.AppCode)].Value = _appCode;
dbCmdInsert.Parameters[_daMgr.BuildParamName(Constants.MachineName)].Value = Environment.MachineName;
dbCmdInsert.Parameters[_daMgr.BuildParamName(Constants.ProcessId)].Value = System.Diagnostics.Process.GetCurrentProcess().Id;
dbCmdInsert.Parameters[_daMgr.BuildParamName(Constants.AppVersion)].Value = _appVersion;
dbCmdInsert.Parameters[_daMgr.BuildParamName(Constants.AppName)].Value = _appName;
dbCmdInsert.Parameters[_daMgr.BuildParamName(Constants.MultipleSessionCode)].Value = _appSessionCode;
dbCmdInsert.Parameters[_daMgr.BuildParamName(Constants.ConfigSettings)].Value = configSettings;
dbCmdInsert.Parameters[_daMgr.BuildParamName(Constants.EnvironmentSettings)].Value = sb.ToString();
dbCmdInsert.Parameters[_daMgr.BuildParamName(Constants.StatusMessage)].Value = statusMsg;
dbCmdInsert.Parameters[_daMgr.BuildParamName(Constants.TpeEndpointAddress)].Value = tpeEndpointAddress;
if (overwrite)
{
dbCmdMgr.TransactionBeginBlock();
DbCommand dbCmdDelete = GetDeleteSessionRecordCmd();
dbCmdDelete.Parameters[_daMgr.BuildParamName(Constants.AppCode)].Value = _appCode;
dbCmdDelete.Parameters[_daMgr.BuildParamName(Constants.MultipleSessionCode)].Value = _appSessionCode;
dbCmdMgr.AddDbCommand(dbCmdDelete);
dbCmdMgr.AddDbCommand(dbCmdInsert);
dbCmdMgr.TransactionEndBlock();
dbCmdMgr.AddDbCommand(dbCmdSelect);
}
else
{
dbCmdMgr.AddDbCommand(dbCmdInsert);
dbCmdMgr.AddDbCommand(dbCmdSelect);
}
try
{
_appSessions = dbCmdMgr.ExecuteDataTable();
_heartbeatTimer = new System.Threading.Timer(new TimerCallback(Heartbeat), null
, _signonControl.SignonControlData.StatusSeconds * 1000
, _signonControl.SignonControlData.StatusSeconds * 1000);
if (_daMgr.loggingMgr != null)
{
_daMgr.loggingMgr.WriteToLog(string.Format("AppId {0}; AppName: {1}; Version: {2}; TaskProcessingEngine: {3}; Session Started."
, _appId
, _appName
, _appVersion
, IsTaskProcessingEngine)
, EventLogEntryType.Information
, enumEventPriority.Critical);
}
}
catch (ExceptionEvent e)
{
if (_daMgr.loggingMgr != null)
{
_daMgr.loggingMgr.WriteToLog(e);
}
if (e.ExceptionEventCode == enumExceptionEventCodes.DbTablePrimaryKeyViolation)
{
return("AppCode record already exists in AppSession table. If you wish to cleanup record and continue,"
+ " please resubmit.");
}
throw;
}
return(null);
}