PasswordHistoryManager

The class manages password histories.

Namespace

Ektron.Cms.Framework.Commerce.PasswordHistoryManager

Constructors

  • PasswordHistoryManager()
  • PasswordHistoryManager(ApiAccessMode)

Properties

  • ApiMode. Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
  • ApplicationPath. Gets the application path to the Workarea.
  • ContentLanguage. Gets or sets the current content language.
  • InPreviewMode. Gets or sets the preview mode and returns true if the site is in preview mode.
  • IsCommerceEnabled. Checks for a commerce license.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.Commerce.PasswordHistoryData)

Adds a password history to CMS. The PasswordHistory.Id property is populated with the new password history's ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * User ID
  • * Password Hash
  • * Change Date Time

Parameters

  • PasswordHistoryData. PasswordHistoryData object to add.

Returns

PasswordHistoryData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-4 last"
            runat="server" Text="* UserId :" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordHashLabel" AssociatedControlID="uxPasswordHash" CssClass="span-4 last"
            runat="server" Text="* PasswordHash :" />
        <ektronUI:TextField ID="uxPasswordHash" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxChangeDateLabel" AssociatedControlID="uxChangeDate" CssClass="span-4 last"
            runat="server" Text="* Change DateTime :" />
        <ektronUI:DatePicker Rows="3" ID="uxChangeDate" CssClass="span-4" runat="server" Text="MM/DD/YYYY"
            ValidationGroup="RegisterValidationGroup" />
        <asp:DropDownList ID="uxChangeTime" runat="server">
            <asp:ListItem>12</asp:ListItem>
            <asp:ListItem>1</asp:ListItem>
            <asp:ListItem>2</asp:ListItem>
            <asp:ListItem>3</asp:ListItem>
            <asp:ListItem>4</asp:ListItem>
            <asp:ListItem>5</asp:ListItem>
            <asp:ListItem>6</asp:ListItem>
            <asp:ListItem>7</asp:ListItem>
            <asp:ListItem>8</asp:ListItem>
            <asp:ListItem>9</asp:ListItem>
            <asp:ListItem>10</asp:ListItem>
            <asp:ListItem>11</asp:ListItem>
        </asp:DropDownList>
        <asp:DropDownList ID="uxChangePeriod" runat="server">
            <asp:ListItem>AM</asp:ListItem>
            <asp:ListItem>PM</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PasswordHistoryManager passwordHistoryManager = new PasswordHistoryManager();
            long userId;
            long.TryParse(uxUserId.Text, out userId);
            string passwordHash = uxPasswordHash.Text;
            string ch = uxChangeDate.Text + " " + uxChangeTime.SelectedItem.Text + ":00:00 " + uxChangePeriod.SelectedItem.Text;
            DateTime changeDate = DateTime.Parse(ch);
            if (userId > 0 && passwordHash != "")
            {
                PasswordHistoryData passwordHistoryData = new PasswordHistoryData();
                passwordHistoryData.UserId = userId;
                passwordHistoryData.PasswordHash = passwordHash;
                passwordHistoryData.ChangeDate = changeDate;
                passwordHistoryManager.RequestInformation.CommerceSettings.PasswordHistory = 1000;
                passwordHistoryData = passwordHistoryManager.Add(passwordHistoryData);
                MessageUtilities.UpdateMessage(uxMessage, "PasswordHistory Added with Id: " + passwordHistoryData.Id.ToString(), Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid values for required fields", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete

Delete(System.Int64)

Deletes a password history from the CMS.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Password History ID

Parameters

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordHistoryIdLabel" AssociatedControlID="uxPasswordHistoryId" CssClass="span-4 last"
            runat="server" Text="* PasswordHistoryId :" />
        <ektronUI:TextField ID="uxPasswordHistoryId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PasswordHistoryManager passwordHistoryManager = new PasswordHistoryManager();
            long passwordHistoryId;
            long.TryParse(uxPasswordHistoryId.Text, out passwordHistoryId);
            if (passwordHistoryId > 0)
            {
                PasswordHistoryData passwordHistoryData = passwordHistoryManager.GetItem(passwordHistoryId);
                if (passwordHistoryData != null)
                {
                    passwordHistoryManager.Delete(passwordHistoryId);
                    MessageUtilities.UpdateMessage(uxMessage, "PasswordHistory with Id " + passwordHistoryId.ToString() + " has been Deleted.", Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid PasswordHistory Id.", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid PasswordHistory Id.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(System.Int64)

Retrieves a PasswordHistory by ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Password History ID

Parameters

  • id. ID of PasswordHistory to retrieve.

Returns

PasswordHistoryData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordHistoryIdLabel" AssociatedControlID="uxPasswordHistoryId" CssClass="span-4 last"
            runat="server" Text="* PasswordHistoryId :" />
        <ektronUI:TextField ID="uxPasswordHistoryId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetItem"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>    
    <li class="clearfix">
        <asp:Literal ID="uxUserId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxPasswordHash" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxChangeDate" runat="server"></asp:Literal>
    </li>                
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PasswordHistoryManager passwordHistoryManager = new PasswordHistoryManager();
            long passwordHistoryId;
            long.TryParse(uxPasswordHistoryId.Text, out passwordHistoryId);
            if (passwordHistoryId > 0)
            {
                PasswordHistoryData passwordHistoryData = passwordHistoryManager.GetItem(passwordHistoryId);
                if (passwordHistoryData != null)
                {                    
                    MessageUtilities.UpdateMessage(uxMessage, "PasswordHistory Details for Id " + passwordHistoryId.ToString() + " are below", Message.DisplayModes.Success);                    
                    uxUserId.Text = "UserId : " + passwordHistoryData.UserId.ToString();
                    uxPasswordHash.Text = "PasswordHash : " + passwordHistoryData.PasswordHash.ToString();
                    uxChangeDate.Text = "ChangeDate : " + passwordHistoryData.ChangeDate.ToString();
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid PasswordHistory Id.", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid PasswordHistory Id.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(Ektron.Cms.Commerce.PasswordHistoryCriteria)

Retrieves a list of password history data objects based upon the supplied criteria.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Password History Property
  • * Object Value

Parameters

  • criteria. Criteria by which to filter password history being retrieved.

Returns

List of PasswordHistoryData objects.

Criteria use

The DataProperty enum works with its criteria class and defines the properties that the Manager class uses to filter and order. Specify zero (0) or more criteria to retrieve the objects you want. The criteria object also lets you set the number of items to return, define paging data, and modify sorting.

Criteria objects
  • Condition. The Logical operator to apply to the filters. The default value is "AND". The criteria condition controls the operator for the default filter group and the AND-ing\Or-ing the filter groups together.
    public Ektron.Cms.Common.LogicalOperation Condition { set; get; }
  • FilterGroups. Gets a list of filter groups. Filter groups can be created to do filter grouping (that is, parentheses in the where clause). The groups use the criteria's condition like other filters, but can use their own condition internally.
    public 
  System.Collections.Generic.List<CriteriaFilterGroup<ActivityCommentProperty>> 
  FilterGroups { get; }
  • Filters. Lists of filters defined in this criteria object. To add new Filters, you can add them here or use the AddFilter method (recommended).
    public 
  System.Collections.Generic.List<CriteriaFilter<ActivityCommentProperty>> 
  Filters { get; }
  • GroupByField. The group by field to apply to the results.
    public 
  Ektron.Cms.Activity.ActivityCommentProperty 
  GroupByField { set; get; }
  • OrderByDirection. Sets the order direction (ascending or descending).
    public EkEnumeration.OrderByDirection 
  OrderByDirection { set; get; }
  • OrderByField . Set the property used to order the results.
    public Ektron.Cms.Activity.ActivityCommentProperty 
  OrderByField { set; get; }
  • PagingInfo. By default, page size is 50 for improved performance. Example paging Info: 
    PagingInfo pageinfo = new PagingInfo();
pageinfo.CurrentPage=1;
pageinfo.RecordsPerPage = 100;
criteria.PagingInfo = pageinfo;
Constructor(property, orderbyDirection)

Sorts the results by a property in ascending or descending order.

AddFilter(property, operator, value)

Filters the results based on the conditions defined in this method.

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo, Objectvalue);
LogicalOperation Condition

Filters the array of items based on the logical condition set in the AddFilter properties. 

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo,Objectvalue);
List<CriteriaFilterGroup> FilterGroups

Binds data to a listview or gridview.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordHistoryPropertyLabel" AssociatedControlID="uxPasswordHistoryProperty" CssClass="span-5 last"
            runat="server" Text="* PasswordHistoryProperty :" />
        <asp:DropDownList ID="uxPasswordHistoryProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>UserId</asp:ListItem>
            <asp:ListItem>PasswordHash</asp:ListItem>
        </asp:DropDownList>
    </li>                    
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-5 last"
            runat="server" Text="* ObjectValue :" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
<asp:ListView ID="uxPasswordHistorylist" runat="server" ItemPlaceholderID="aspItemPlaceholder"
    Visible="false">
    <EmptyDataTemplate>
        Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        User Id
                    </th>
                    <th>
                        Password Hash
                    </th>
                    <th>
                        Change Date
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("PasswordHash")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ChangeDate")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PasswordHistoryManager passwordHistoryManager = new PasswordHistoryManager();
            object objectValue = uxObjectValue.Text;
            string passwordHistoryProperty = uxPasswordHistoryProperty.SelectedItem.Text;
            PasswordHistoryCriteria criteria = new PasswordHistoryCriteria(PasswordHistoryProperty.Id, EkEnumeration.OrderByDirection.Ascending);
            if (passwordHistoryProperty == "Id")
            {
                criteria.AddFilter(PasswordHistoryProperty.Id, CriteriaFilterOperator.EqualTo, objectValue);
            }
            else if (passwordHistoryProperty == "UserId")
            {
                criteria.AddFilter(PasswordHistoryProperty.UserId, CriteriaFilterOperator.EqualTo, objectValue);
            }
            else
            {
                criteria.AddFilter(PasswordHistoryProperty.PasswordHash, CriteriaFilterOperator.EqualTo, objectValue);
            }
            
            List<PasswordHistoryData> passwordHistoryDataList = passwordHistoryManager.GetList(criteria);
            uxPasswordHistorylist.Visible = true;
            uxPasswordHistorylist.DataSource = passwordHistoryDataList;
            uxPasswordHistorylist.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetRecentPasswords

GetRecentPasswords(System.Int64,System.Int32)

Retrieves the last N number of passwords for a user.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * User ID
  • * Number

Parameters

  • userId. The user ID for whom to retrieve the recent passwords.
  • number. The number of recent passwords to get.

Returns

List of PasswordHistoryData objects.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-4 last"
            runat="server" Text="* UserId :" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxNumberLabel" AssociatedControlID="uxNumber" CssClass="span-4 last"
            runat="server" Text="* Number :" />
        <ektronUI:TextField ID="uxNumber" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Recent"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
 
<asp:ListView ID="uxPasswordHistorylist" runat="server" ItemPlaceholderID="aspItemPlaceholder"
    Visible="false">
    <EmptyDataTemplate>
        UserId did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        User Id
                    </th>
                    <th>
                        Password Hash
                    </th>
                    <th>
                        Change Date
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("PasswordHash")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ChangeDate")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PasswordHistoryManager passwordHistoryManager = new PasswordHistoryManager();
            long userId;
            long.TryParse(uxUserId.Text, out userId);
            int number;
            int.TryParse(uxNumber.Text, out number);
            if (userId > 0 && number > 0)
            {
                List<PasswordHistoryData> passwordHistoryDataList = passwordHistoryManager.GetRecentPasswords(userId, number);
                uxPasswordHistorylist.Visible = true;
                uxPasswordHistorylist.DataSource = passwordHistoryDataList;
                uxPasswordHistorylist.DataBind();
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid values for required fields", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

MatchesRecentPassword

MatchesRecentPassword(System.Int64,System.String,System.Int32)

Returns whether the password matches the user's last N number of passwords.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * User ID
  • * Password Hash
  • * Number

Parameters

  • userId. The user ID that matches the recent passwords.
  • passwordHash. Hashed password to match.
  • number. The number of recent passwords to look in.

Returns

Returns true if a password matches.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-4 last"
            runat="server" Text="* UserId :" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordHashLabel" AssociatedControlID="uxPasswordHash" CssClass="span-4 last"
            runat="server" Text="* PasswordHash :" />
        <ektronUI:TextField ID="uxPasswordHash" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxNumberLabel" AssociatedControlID="uxNumber" CssClass="span-4 last"
            runat="server" Text="* Number :" />
        <ektronUI:TextField ID="uxNumber" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Match Recent"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PasswordHistoryManager passwordHistoryManager = new PasswordHistoryManager();
            long userId;
            long.TryParse(uxUserId.Text, out userId);
            int number;
            int.TryParse(uxNumber.Text, out number);
            string passwordHash = uxPasswordHash.Text;
            if (userId > 0 && number > 0 && passwordHash != "")
            {
                bool match = passwordHistoryManager.MatchesRecentPassword(userId, passwordHash, number);
                if (match)
                {
                    MessageUtilities.UpdateMessage(uxMessage, "PasswordHash " + passwordHash + " is matched to UserId " + userId.ToString(), Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "PasswordHash " + passwordHash + " is not matched to UserId " + userId.ToString(), Message.DisplayModes.Error);
                }                
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid values for required fields", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Purge

Purge(System.Int64,System.Int32)

Deletes a password history from the CMS.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * User ID
  • * Number

Parameters

  • userId. ID of user to delete password history.
  • number. Deletes a password history except a given number of recently added passwords.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-4 last"
            runat="server" Text="* UserId :" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxNumberLabel" AssociatedControlID="uxNumber" CssClass="span-4 last"
            runat="server" Text="* Number :" />
        <ektronUI:TextField ID="uxNumber" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Purge"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PasswordHistoryManager passwordHistoryManager = new PasswordHistoryManager();
            long userId;
            long.TryParse(uxUserId.Text, out userId);
            int number;
            int.TryParse(uxNumber.Text, out number);
            if (userId > 0)
            {
                passwordHistoryManager.Purge(userId, number);
                MessageUtilities.UpdateMessage(uxMessage, "PasswordHistory has been deleted for UserId " + userId.ToString() + " except " + number.ToString() + " records which are added recently.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid UserId.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update

Update(Ektron.Cms.Commerce.PasswordHistoryData)

Updates an existing password history in CMS.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Password History ID
  • User ID
  • Password Hash
  • * Change Date Time

Parameters

  • PasswordHistoryData. PasswordHistoryData object to save.

Returns

PasswordHistoryData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordHistoryIdLabel" AssociatedControlID="uxPasswordHistoryId" CssClass="span-4 last"
            runat="server" Text="* PasswordHistoryId :" />
        <ektronUI:TextField ID="uxPasswordHistoryId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-4 last"
            runat="server" Text=" UserId :" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordHashLabel" AssociatedControlID="uxPasswordHash" CssClass="span-4 last"
            runat="server" Text=" PasswordHash :" />
        <ektronUI:TextField ID="uxPasswordHash" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxChangeDateLabel" AssociatedControlID="uxChangeDate" CssClass="span-4 last"
            runat="server" Text="* Change DateTime :" />
        <ektronUI:DatePicker Rows="3" ID="uxChangeDate" CssClass="span-4" runat="server" Text="MM/DD/YYYY"
            ValidationGroup="RegisterValidationGroup" />
        <asp:DropDownList ID="uxChangeTime" runat="server">
            <asp:ListItem>12</asp:ListItem>
            <asp:ListItem>1</asp:ListItem>
            <asp:ListItem>2</asp:ListItem>
            <asp:ListItem>3</asp:ListItem>
            <asp:ListItem>4</asp:ListItem>
            <asp:ListItem>5</asp:ListItem>
            <asp:ListItem>6</asp:ListItem>
            <asp:ListItem>7</asp:ListItem>
            <asp:ListItem>8</asp:ListItem>
            <asp:ListItem>9</asp:ListItem>
            <asp:ListItem>10</asp:ListItem>
            <asp:ListItem>11</asp:ListItem>
        </asp:DropDownList>
        <asp:DropDownList ID="uxChangePeriod" runat="server">
            <asp:ListItem>AM</asp:ListItem>
            <asp:ListItem>PM</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PasswordHistoryManager passwordHistoryManager = new PasswordHistoryManager();
            long passwordHistoryId;
            long.TryParse(uxPasswordHistoryId.Text, out passwordHistoryId);
            long userId;
            long.TryParse(uxUserId.Text, out userId);
            string passwordHash = uxPasswordHash.Text;
            string ch = uxChangeDate.Text + " " + uxChangeTime.SelectedItem.Text + ":00:00 " + uxChangePeriod.SelectedItem.Text;
            DateTime changeDate = DateTime.Parse(ch);
            if (passwordHistoryId > 0)
            {
                PasswordHistoryData passwordHistoryData = passwordHistoryManager.GetItem(passwordHistoryId);
                if(passwordHistoryData != null)
                {
                    passwordHistoryData.UserId = userId > 0 ? userId : passwordHistoryData.UserId;
                    passwordHistoryData.PasswordHash = passwordHash != "" ? passwordHash : passwordHistoryData.PasswordHash;
                    passwordHistoryData.ChangeDate = changeDate;
                    passwordHistoryData = passwordHistoryManager.Update(passwordHistoryData);
                    MessageUtilities.UpdateMessage(uxMessage, "PasswordHistory Updated for Id: " + passwordHistoryId.ToString(), Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid PasswordHistory Id.", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid PasswordHistory Id.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

PasswordHistoryCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • PasswordHistoryCriteria()
    public PasswordHistoryCriteria()
  • PasswordHistoryCriteria(Ektron.Cms.Commerce.PasswordHistoryProperty, EkEnumeration.OrderByDirection)
    public
  PasswordHistoryCriteria(Ektron.Cms.Commerce.PasswordHistoryProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the PasswordHistoryProperty are:

    • ChangeDate
    • Id
    • PasswordHash
    • UserId

PasswordHistoryData

Namespace

Ektron.Cms.Commerce

Properties

  • ChangeDate
    public System.DateTime ChangeDate { set; get; }
  • Id
    public long Id { set; get; }
  • PasswordHash
    public string PasswordHash { set; get; }
  • PasswordHistoryData()
    public PasswordHistoryData()
  • PasswordHistoryData(long, string)
    public PasswordHistoryData(long userId, string passwordHash)
  • UserId
    public long UserId { set; get; }
  • Validate
    public ValidationResults Validate()