Singleton Design Pattern in .NET

Author : SriHarsha Kalagara (sriharsha.kalagara@gmail.com)

___________________________________________________________________________

"The goal of Design Patterns is to address the design problems, developers normally have while designing the applications."

Singleton Design Patters categorized under  Creational Pattern Category. This pattern uses when developers have to create an instance of the class.

Definition:

Singleton Design Pattern allows to create only single instance of the class and provides a global point to access the class instance.

When to use Singleton Design Pattern:

Singleton Design Pattern mainly used, when we have a class and the class properties to be accessed globally through out the application and most of the time these class properties are unique.
In this scenario, normally developer ends with creating multiple instances of the same class in different pages of the application, to get the class property values.
To address the problem of creating multiple instances of the same class, we use Singleton Design Pattern.

Example:

Take a scenario, in an ASP.NET application, developer storing his database connection string and other constant values as properties in the class. Whenever he want the connection string and other constants, he has to instantiate the class each time to access them as properties. 
Using Singleton in this scenario, developers creates a single instance of the class and reuse the same instance where ever he want the class properties.

Steps in Creating Singleton class:
  1. Create a class with property variables.
  2. Convert the class constructor as private instead of public (default it is public).
  3. Create a Static variable of the class (this variable holds class instance for reuse).
  4. Create a Static method with in the class, class is the return type  for the static method.(this static method is the global point for accessing the class constructor).
  5. In Static method, verify if the class is already instantiated. If the class is already having an instance, then reuse the same instance. if the class doesn't have any instance, then create a new instance of the class and send the instance as return type of the static method.
  6. Get the instance of the class using the static method.
A Sample class created using Singleton Design Pattern:

 public class clsSingleTon
    {
        #region Private Variables

        /// <summary>
        /// Static variable holds class instance.
        /// </summary>
        private static clsSingleTon _SingletonInsance = null;

        private string _Server = string.Empty;
        private string _Database = string.Empty;
    
        #endregion

        #region Class Properties

        public string Database
        {
            get { return _Database; }
            set { _Database = value; }
        }

        public string Server
        {
            get { return _Server; }
            set { _Server = value; }
        }

        #endregion

        #region Singleton Constrcutor

        /// <summary>
        /// Convert the constructor of the class as "Private" instead of Public
        /// </summary>
        private clsSingleTon()
        {

        }

        /// <summary>
        /// Static method
        /// Create a Public Static Method, with in this method verify if the class is already instantiated.
        /// If class is instantiated before, return existing instance of the class
        /// or else return new instance of the class
        /// </summary>
        /// <returns></returns>
        public static clsSingleTon GetInstance()
        {
            ///verifying if class is already instantiated
            if (_SingletonInsance == null)
            {
                _SingletonInsance = new clsSingleTon();
            }

            return _SingletonInsance;
        }

        #endregion
    }

 Create the class instance:

Now to access the class properites, we have use the static method of the class as mentioned below.

 clsSingleTon _Instance = clsSingleTon.GetInstance();

This static method always returns the existing instance of the class , if any instance created. or else it will return new instance of the class.


SharePoint - Find site process to debug


In SharePoint debugging, it is always hard to find a process of  SharePoint site to attach to debugger.

The below command will help us to find the specific process related to  a SharePoint site.

Go to Start -> Run -> Cmd 

In command prompt, enter the command  cd inetsrv

After that use command. appcmd list wp


Sitemap Menu Control (Coming Soon....)

Hide OPEN button from File download dialogue using JQUERY

When client have a requirement to hide OPEN button from file downloading dialogue, developer can simply accomplish it by adding meta tag in aspx or master page header.

<head>
<meta name = 'DownloadOptions' Content= 'noopen'/>
</head>

but if client want this requirement specific to one download button, developer has to add above meta tag dynamically using Jquery or from code behind. Here I did using JQuery.

<script type="text/javascript">
     $(document).ready(
function () {
     function initMeta() {
     var headID = document.getElementsByTagName("head")[0];
     var metaNode = document.createElement('meta');
     metaNode.name=
'DownloadOptions'; metaNode.content = 'noopen'; metaNode.id = 'metatag';
     headID.appendChild(metaNode);
                         }
        $(
'[id$=CmdDirectInvFaceSheet]').click(function () { initMeta(); });   });</script>


MasterPage Relative URL using Page.ResolveUrl

Sometimes Url's defined on Masterpage can't idenity proper page paths and throws page not found kind of errors.



<script type="text/javascript" src="../JQuery/jquery-1.6.2.js"></script>

<script type="text/javascript" src="../../Scripts/ValidationRepositoryJQry.js"></script>



The above script definations not always helpful for proper page navigation.

Page.ResolveUrl

<script type="text/javascript" src="<%# Page.ResolveUrl("~/JQuery/jquery-1.6.2.js")%>"></script>
<script type="text/javascript" src="<%# Page.ResolveUrl("~/Scripts/ValidationRepositoryJQry.js")%>"></script>


Binding in Page_load()


Also to make it work it requires Header binding in Page load

Me.Page.Header.DataBind()

Window.Open()

<a href="#" ID="lnkTreatmentProvider" onclick="javascript:window.open('<%#Page.ResolveUrl("~/CommonFiles/WebPages/wfTPInfo.aspx?ProviderID="+ Eval("TPID").Tostring+ "&TableName=tblLkpProvider',null,'width=900,height=500,top=180,left=350,location=0,menubar=no, status=no, toolbar=no, scrollbars=no, resizable=no','true'")%>) "> <%#Container.DataItem("Provider")%></a>

Topics to be covered in SharePoint 2010 Preparation

1) SharePoint 2010 New Features
2) Claims based Authentication in SharePoint 2010
3) Client Object Model in SharePoint 2010.
4) BCS and External Content Types
5) Document and Content Management in SharePoint 2010
6) Customization of Ribbon Control in SharePoint 2010
7) Times Jobs and Retention Policies in SharePoint 2010
8) Load balance
9) PowerShell
10) SandBox Solutions
11) Workflows
12) Content Type Hub
13) Site Backup and Restore Process
14) Migration of Web Application from MOSS 2007 to SharePoint 2010.
15) Creation of Custom Site Definitions and Understanding the difference between Site Definition and Site Templates.

SharePoint 2010 - Compare Backup mechanism

SharePoint 2010 offers 3 Backup mechanism.

  1. Central Admin Backup -

    This is found under Central Administration-> Backup and Restore tab.

    Pros : This allows you take Farm level, Site level and Granular backup
    Allow users to configure Full and Differential Backup.
    Allow users to backup search index files.
    Provides UI to configure backup. 
    Cons : Can not schedule backup.
    It has limitations in taking backup of Configuration DB.

  2. PowerShell Backup -

    SharePoint 2010 introduces PowerShell tool to execute commands from a command prompt.
    PowerShell tools comes along with SharePoint 2010 Products suite and it can found under
    Start -> Programs -> Microsoft SharePoint 2010 Products -> Microsoft 2010 Management Shell.

    Pros : This allows you take Farm level, Site level and Granular backup
    Allow users to configure Full and Differential Backup.
    Allow users to backup search index files.
    Users can schedule backup with the help of Times job service 
    Cons : Can not take backup of Configuration DB and IIS Settings.

     Developer should know the Powershell scripting to create and execute the batch files.

  3. SQL Server Backup -

    Pros : SQL Server is the most reliable backup mechanism.
    It allows to configure Full and Differential backup.
    Scheduling backup is available.
    Very easy to restore the backup data. 
    It takes backup of Configuration DB as well as Content DB.
    Cons : Can not take back up Search Index, IIS Settings.
     Can not take Farm backup.

Paging feature on Repeater Control

We all know about Paging concept in GridView . Microsoft provided this built-in support with Gridview, but haven't provided for Repeater control. Now we will see how to implement paging on Repeater control.

                                    Screen shot: Repeater with Page numbers. For security purpose data was hidden.

Add placeholder to add paging in .aspx file somewhere down to repeater

<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td>
<asp:PlaceHolder ID="plcPaging" runat="server" />
</td>
<td>
<asp:Label runat="server" CssClass="label" ID="lblPageName" />
</td>
</tr>
</table>










Create Paging control and Handler to fire page number links

Fire Handler method to bind Repeater control for each page

Fetch data to bind repeater


Executing code after Response.End() or Response.Binarywrite() in ASP.NET

Many of you know, code after Response.End() or Response.Binarywrite() will not work. But there might be a situation, where you want to execute a piece of code after Response.End() or Response.Binarywrite().

A possible scenario, after downloading a file using Response.Binarywrite(), showing an JavaScript alert about download status or closing Jquery Loader after downloading file. But code after Response.Binarywrite() will not work.

The following steps can be used to address this issue.
  1. Save the data into ViewState in the file download Button (name it btnDownLoad) Click event.
  2. Add a new button (name it btnHidden) in designer, and make it display false.
  3. Call javascript function in btnDownLoad server side code and save the data to be downloaded into viewstate.                  
 ViewState["DownloadData"] = fileDownloadStream; Page.ClientScript.RegisterStartupscript(this.GetType(),"Test","ShowAlert();",true);
  1. In the Javascript function (ShowAlert()), write code to close jquery loader or to show alert and to download file from stream.                                                                                         
  2. <script>
function ShowAlert()
{
    $(“#Loader”).close();
     document.getElementById('<%=btnHidden.ClientID%>').click();
}

6.                         In the server side button click (btnHidden), write code to download the file, 
               make sure this button is not visible to users.

protected void btnHidden_Click(object sender, EventArgs e)
{
   byte[] certificateBytes = (byte[])ViewState["DownloadData "];

   Response.ContentType = "application/pdf";
               Response.AddHeader("Content-Disposition", "attachment; 
               filename=Test.pdf"; size=" + certificateBytes.Length.ToString());
   Response.BinaryWrite(certificateBytes);
   Response.End();
            }

 Happy Coding..............







 SharePoint 2010 Search Server Feature Comparison


SharePoint 2010 Feature
Foundation
Standard
Enterprise
FAST Search





Basic Search
crawl SharePoint sites in the same farm
Y
Y
Y
Y
Sorting
Sort results based on the Date or view

Y
Y
Y
Best Bets
Best Bets are URLs to documents that are associated with one or more keywords.

Y
Y
Y
Click through relevancy
The click-through behavior of similar search queries affects the rank that documents receive. The more users click on a certain item, the higher its ranking for related queries.

Y
Y
Y
Duplicate Detection
Reduce display of same document with multiple versions
Y
Y
Y
Y
Enterprise Scale Search scale
(Best Performance)

300,000 (SQL Express) ,
10 Million ( SQL Server)

100 Million
100 Million
500 Million +
Federated Search
Federate results from multiple search sources

Y
Y
Y
Metadata-driven Refinement
To narrow down the search results

Y
Y
Y
People Search
People search enables users to find other people in the organization not only by name, but also by many other categories, such as department, job title, projects, expertise, and location.

Y
Y
Y
Query Suggestion
Related Queries as part of your Search

Y
Y
Y
Search Scopes
Users can filter search results by using scopes

Y
Y
Y
SP 2010 Search connector Framework
Securely connect to content in SharePoint sites and from sources across your enterprise.

Y
Y
Y
Advanced Content Processing
Extract and create metadata latent in documents to improve search results, sorting capabilities, and the refinement panel.


Y
Y
Contextual Search
Tailor different results and refinement options based on the profile of the user or audience.


Y
Y
Extensible Search Platform
Meet all the search application needs you have across your business. Common examples include 360° Customer Insight, Research and Development Innovation Portal, and Product Support.


Y
Y
Rich Web Indexing
Index dynamic web content and JavaScript


Y
Y
Thumbnails and Previews
Thumbnails and previews make the results of a search query visual, allowing users to recognize the right content quickly.


Y
Y
Visual Best Bets
Keyword terms and synonyms defined by an administrator to enhance search results. 


Y
Y
Custom Properties
Manage which properties are indexed and how these are treated in search results.



Y
Property Extraction
Extracts key information (people names, locations, company names) from unstructured text to use as additional managed properties.



Y
Preview
Display inline previews of Word, PowerPoint, and Excel files.



Y
Taxonomy Integration
Bring the power of taxonomy into search. Tag metadata is shown in results, and users can refine by taxonomy-based tags.


Y
Y
Windows Files Shares

Y
Y
Y
Exchange Public Folders

Y
Y
Y
Lotus Notes

Y
Y
Y
Web Sites

Y
Y
Y
IFilters

Y
Y
Y
Structured Content in DB

Y
Y
Y
General Questions
Does C# support multiple-inheritance? No.
Who is a protected class-level variable available to? It is available to any sub-class (a class inheriting this class).
Are private class-level variables inherited? Yes, but they are not accessible. Although they are not visible or accessible via the class interface, they are inherited.
Describe the accessibility modifier “protected internal”. It is available to classes that are within the same assembly and derived from the specified base class.
What’s the top .NET class that everything is derived from? System.Object.
What does the term immutable mean?The data value may not be changed. Note: The variable value may be changed, but the original immutable data value was discarded and a new data value was created in memory.
What’s the difference between System.String and System.Text.StringBuilder classes?System.String is immutable. System.StringBuilder was designed with the purpose of having a mutable string where a variety of operations can be performed.
What’s the advantage of using System.Text.StringBuilder over System.String?StringBuilder is more efficient in cases where there is a large amount of string manipulation. Strings are immutable, so each time a string is changed, a new instance in memory is created.
Can you store multiple data types in System.Array?No.
What’s the difference between the System.Array.CopyTo() and System.Array.Clone()?The Clone() method returns a new array (a shallow copy) object containing all the elements in the original array. The CopyTo() method copies the elements into another existing array. Both perform a shallow copy. A shallow copy means the contents (each array element) contains references to the same object as the elements in the original array. A deep copy (which neither of these methods performs) would create a new instance of each element's object, resulting in a different, yet identacle object.
How can you sort the elements of the array in descending order?By calling Sort() and then Reverse() methods.
What’s the .NET collection class that allows an element to be accessed using a unique key?HashTable.
What class is underneath the SortedList class?A sorted HashTable.
Will the finally block get executed if an exception has not occurred?­Yes.
What’s the C# syntax to catch any possible exception?A catch block that catches the exception of type System.Exception. You can also omit the parameter data type in this case and just write catch {}.
Can multiple catch blocks be executed for a single try statement?No. Once the proper catch block processed, control is transferred to the finally block (if there are any).
Explain the three services model commonly know as a three-tier application.Presentation (UI), Business (logic and underlying code) and Data (from storage or other sources).
Class Questions
What is the syntax to inherit from a class in C#? Place a colon and then the name of the base class.Example: class MyNewClass : MyBaseClass
Can you prevent your class from being inherited by another class? Yes. The keyword “sealed” will prevent the class from being inherited.
Can you allow a class to be inherited, but prevent the method from being over-ridden?Yes. Just leave the class public and make the method sealed.
What’s an abstract class?A class that cannot be instantiated. An abstract class is a class that must be inherited and have the methods overridden. An abstract class is essentially a blueprint for a class without any implementation.
When do you absolutely have to declare a class as abstract?1. When the class itself is inherited from an abstract class, but not all base abstract methods have been overridden. 2. When at least one of the methods in the class is abstract.
What is an interface class?Interfaces, like classes, define a set of properties, methods, and events. But unlike classes, interfaces do not provide implementation. They are implemented by classes, and defined as separate entities from classes.
Why can’t you specify the accessibility modifier for methods inside the interface?They all must be public, and are therefore public by default.
Can you inherit multiple interfaces?Yes. .NET does support multiple interfaces.
What happens if you inherit multiple interfaces and they have conflicting method names?
It’s up to you to implement the method inside your own class, so implementation is left entirely up to you. This might cause a problem on a higher-level scale if similarly named methods from different interfaces expect different data, but as far as compiler cares you’re okay. To Do: Investigate
What’s the difference between an interface and abstract class?In an interface class, all methods are abstract - there is no implementation. In an abstract class some methods can be concrete. In an interface class, no accessibility modifiers are allowed. An abstract class may have accessibility modifiers.
What is the difference between a Struct and a Class?Structs are value-type variables and are thus saved on the stack, additional overhead but faster retrieval. Another difference is that structs cannot inherit.
Method and Property Questions
What’s the implicit name of the parameter that gets passed into the set method/property of a class? Value. The data type of the value parameter is defined by whatever data type the property is declared as.
What does the keyword “virtual” declare for a method or property? The method or property can be overridden.
How is method overriding different from method overloading? When overriding a method, you change the behavior of the method for the derived class. Overloading a method simply involves having another method with the same name within the class.
Can you declare an override method to be static if the original method is not static? No. The signature of the virtual method must remain the same. (Note: Only the keyword virtual is changed to keyword override)
What are the different ways a method can be overloaded? Different parameter data types, different number of parameters, different order of parameters.
If a base class has a number of overloaded constructors, and an inheriting class has a number of overloaded constructors; can you enforce a call from an inherited constructor to a specific base constructor?Yes, just place a colon, and then keyword base (parameter list to invoke the appropriate constructor) in the overloaded constructor definition inside the inherited class.
Events and Delegates
What’s a delegate?
A delegate object encapsulates a reference to a method.
What’s a multicast delegate? A delegate that has multiple handlers assigned to it. Each assigned handler (method) is called.
ADO.NET and Database Questions
What is the role of the DataReader class in ADO.NET connections? It returns a read-only, forward-only rowset from the data source. A DataReader provides fast access when a forward-only sequential read is needed.
What are advantages and disadvantages of Microsoft-provided data provider classes in ADO.NET? SQLServer.NET data provider is high-speed and robust, but requires SQL Server license purchased from Microsoft. OLE-DB.NET is universal for accessing other sources, like Oracle, DB2, Microsoft Access and Informix. OLE-DB.NET is a .NET layer on top of the OLE layer, so it’s not as fastest and efficient as SqlServer.NET.
What is the wildcard character in SQL? Let’s say you want to query database with LIKE for all employees whose name starts with La. The wildcard character is %, the proper query with LIKE would involve ‘La%’.
Explain ACID rule of thumb for transactions.A transaction must be:1. Atomic - it is one unit of work and does not dependent on previous and following transactions.2. Consistent - data is either committed or roll back, no “in-between” case where something has been updated and something hasn’t.3. Isolated - no transaction sees the intermediate results of the current transaction).4. Durable - the values persist if the data had been committed even if the system crashes right after.
What connections does Microsoft SQL Server support? Windows Authentication (via Active Directory) and SQL Server authentication (via Microsoft SQL Server username and password).
Between Windows Authentication and SQL Server Authentication, which one is trusted and which one is untrusted? Windows Authentication is trusted because the username and password are checked with the Active Directory, the SQL Server authentication is untrusted, since SQL Server is the only verifier participating in the transaction.
What does the Initial Catalog parameter define in the connection string? The database name to connect to.
What does the Dispose method do with the connection object? Deletes it from the memory.To Do: answer better. The current answer is not entirely correct.
What is a pre-requisite for connection pooling? Multiple processes must agree that they will share the same connection, where every parameter is the same, including the security settings. The connection string must be identical.
Assembly Questions
How is the DLL Hell problem solved in .NET?
Assembly versioning allows the application to specify not only the library it needs to run (which was available under Win32), but also the version of the assembly.
What are the ways to deploy an assembly? An MSI installer, a CAB archive, and XCOPY command.
What is a satellite assembly? When you write a multilingual or multi-cultural application in .NET, and want to distribute the core application separately from the localized modules, the localized assemblies that modify the core application are called satellite assemblies.
What namespaces are necessary to create a localized application? System.Globalization and System.Resources.
What is the smallest unit of execution in .NET?an Assembly.
When should you call the garbage collector in .NET?As a good rule, you should not call the garbage collector. However, you could call the garbage collector when you are done using a large object (or set of objects) to force the garbage collector to dispose of those very large objects from memory. However, this is usually not a good practice.
How do you convert a value-type to a reference-type?Use Boxing.
What happens in memory when you Box and Unbox a value-type?Boxing converts a value-type to a reference-type, thus storing the object on the heap. Unboxing converts a reference-type to a value-type, thus storing the value on the stack.