Home > Articles > Programming > Windows Programming

Configuring and Deploying Your ASP.NET Solutions

📄 Contents

  1. Configuring Your ASP.NET Solutions
  2. Deploying Your ASP.NET Applications
  3. Summary
  • Print
  • + Share This
In this sample chapter, Michael Amudsen and Paul Litwin teach you how to configure your Web solutions using ASP.NET's standardized configuration files. They also discuss how to design deployment plans that make it easy for you to install your ASP.NET solutions both locally and remotely.
This sample chapter is excerpted from Configuring and Deploying Your ASP.NET Solutions, by Michael Amudsen and Paul Litwin.
This chapter is from the book

This chapter is from the book

Now that you know how to build ASP.NET Web Forms, create data-bound applications, support Web services, and design secure solutions using ASP.NET security models, you're ready to learn how to configure and deploy your Web solutions to your production servers.

In the past, configuring and deploying Web solutions was tedious at best, and complicated at worst. This was especially true when your solutions contained one or more compiled components. These components often relied on detailed registry settings, were cumbersome to install remotely and were even more difficult to update once the original component was placed into production.

ASP.NET solutions are much easier to configure since they no longer require registry settings, but instead use a standardized XML-based configuration file to hold all important application data. In addition, ASP.NET greatly simplifies the deployment and maintenance of Web solutions since compiled components no longer require registry support and can easily be updated simply by copying new components over old ones—even while the old ones are still running on the production server.

In this chapter, you learn how to configure your Web solutions using ASP.NET's standardized configuration files. You also learn how to design deployment plans that make it easy for you to install your ASP.NET solutions both locally and remotely.

Configuring Your ASP.NET Solutions

ASP.NET solutions are designed to use a standardized XML-based configuration file for all important runtime settings. In fact, the ASP.NET runtime uses this same kind of configuration file to control the runtime behavior of ASP.NET on the server.

This standardized XML file can be viewed and updated with any simple editor such as Microsoft Notepad or other tool. And, although the configuration file is a standard format, since it's in XML form, the configuration file is easily extended to support custom configuration information needed to support your own application.

The following sections in this chapter show you how the configuration file is arranged, how the ASP.NET runtime uses the configuration data, and how you can use configuration files to control how your ASP.NET solutions behave at runtime.

Understanding the ASP.NET Configuration Model

The ASP.NET configuration model is based on an XML configuration file. Every server that has the ASP.NET platform installed on it contains at least one of these files, called MACHINE.CONFIG. In the default installation of the .NET platform, the MACHINE.CONFIG is kept in the following folder:

C:\WINNT\Microsoft.NET\Framework\v1.0.2615\CONFIG

The MACHINE.CONFIG File

The MACHINE.CONFIG file contains all the settings that control how the entire ASP.NET runtime behaves. Also, this MACHINE.CONFIG contains the default settings for all other Web applications installed on the server. The basic layout of the MACHINE.CONFIG is shown in Listing 21.1.

Listing 21.1. SAMPLE.CONFIG—A Sample ASP.NET Configuration File

<?xml version="1.0" encoding="UTF-8" ?>

<configuration>

  <system.web>
    <trace
      enabled="false"
      requestLimit="10"
      pageOutput="false"
      traceMode="SortByTime"
      localOnly="true"
    />

    <pages buffer="true" 
      enableSessionState="true" 
      enableViewState="true"
      enableViewStateMac="true" 
      autoEventWireup="true" />

    <customErrors mode="RemoteOnly" />

    <sessionState 
      mode="inproc"
      stateConnectionString="tcpip=127.0.0.1:42424"
      sqlConnectionString="data source=127.0.0.1;user id=sa;password="
      cookieless="false" 
      timeout="20" 
    />

    <iisFilter 
      enableCookielessSessions = "true" 
    />

  </system.web>

</configuration>

Actually, there are many more sections in the master MACHINE.CONFIG for an ASP.NET server. The example in Listing 21.1 shows just a few of the important sections. You'll learn more about the possible configuration sections later in this chapter. The important thing to note is that the file is in familiar hierarchical XML format and supports a number of sections.

NOTE

The CONFIG files stored on the Web server are protected by security policies within ASP.NET. For example, any time a user requests a CONFIG file via the browser, the ASP.NET service will return a 403 error (forbidden request).

Configuration Inheritance

A major feature of the ASP.NET configuration system is that it supports a form of inheritance. In other words, settings in the MACHINE.CONFIG are inherited by all running Web applications on that machine. The only time this is not the case is when the individual Web applications have their own CONFIG files that override the MACHINE.CONFIG. For example, let's say the MACHINE.CONFIG file has the following setting:

<pages enableSessionState="true" enableViewState="true" />

This means that for all Web applications on this machine, session state is enabled and view state is enabled. Next, let's say a Web application on the same machine has its own configuration file, called WEB.CONFIG, with the following setting:

<pages enableSessionState="false" />

First, notice that the enableViewState attribute does not appear in the Web's configuration file. That means that the local Web will "inherit" the setting from the MACHINE.CONFIG file for the server. Thus, for this particular Web, session state is disabled, and view state is enabled.

Finally, configuration information can also be kept in WEB.CONFIG files in sub folders within a single Web application. This means that you can customize the application behavior by sub folder, too. For example, if the root folder of the Web application has an authorization section that allows all users to view the contents of the root Web, you can do this:

<authorization>
  <allow users="*" />
</authorization>

However, in a subfolder off the root Web, called "SECURE", there is another configuration file that has a setting to allow only validated users to view the contents of the sub folder:

<authorization>
  <allow users="?" />
</authorization>

This means that any attempts by users to view the contents of the SECURE folder will result in a request for user credentials. If the system determines that the credentials are valid, the user will be allowed to view the contents of the folder.

Configuration Elements

Since the ASP.NET CONFIG files are extensible, the actual contents of the files can vary greatly. However, there are several basic elements that could often be found in ASP.NET CONFIG files. For example, the MACHINE.CONFIG file contains the following top-level sections:

  • ConfigSections: This section contains definitions for all the different configuration sections found in the file along with .NET components that are to be used to interpret the contents of each section.

  • AppSettings: This is an open section that can be used by ASP.NET programmers to place name/value pairs for access at runtime. This is an ASP.NET version of registry settings for Web applications.

  • system.diagnostics: This section contains information used by the ASP.NET runtime to perform internal diagnostic routines.

  • system.net: This section contains information on network services for ASP.NET.

  • system.web: This section contains information used to set the behavior of all Webs on the machine.

  • runtime: This section contains information about the actual .NET runtime system.

Theoretically, virtually all of the sections in the MACHINE.CONFIG file could be overridden in WEB.CONFIG files within Web applications running on the same machine. However, many of the MACHINE.CONFIG files are of little interest to application-level programming. The primary exception to this rule is the <system.web> section. This is the section that defines the behavior of running Web applications and it is often overridden in the local WEB.CONFIG files.

Common Configuration Elements in WEB.CONFIG Files

The WEB.CONFIG file can be thought of as ASP.NET's version of the registry settings for traditional Windows applications. You can use the WEB.CONFIG file to store important settings that can be accessed at runtime. Following is a list of commonly used sections in WEB.CONFIG files including notes on the contents of these sections.

AppSettings

This is a general top-level section that can be used to store name value pairs for use in your application. For example, you can store database connection information here, common folders or file pointers, even extended information such as default values for dialogs, etc. (See Listing 7.2)

Listing 21.2. COMMON_SECTIONS.CONFIG—Example AppSettings Section

<configuration>
<appSettings>
 <add key="PubsDSN" value="server=myServer;database=pubs;userid=sa;
 password=''" />
 <add key="dialogLevel" value="expertMode" />
 <add key="defaultBackgroundColor" value="white" />
 <add key="defaultFontColor" value="black" />
</appSettings>
</configuration>

sessionState

This section, occurring within the <system.web> section controls the session state behavior of the application. Following is a typical session state entry:

<sessionState 
  mode="inproc"
  stateConnectionString="tcpip=127.0.0.1:42424"
  sqlConnectionString="data source=127.0.0.1;user id=sa;password="
  cookieless="false" 
  timeout="20" 
/>

The mode setting of sessionState can be set to inproc, stateserver, or sqlserver. If mode is set to "inproc," then all data is kept on the local machine. When mode is set to "stateserver", all session data is kept on a single shared server in the network. When mode is set to "sqlserver," all session data is stored within a SQL Server database. If the cookieless attribute is set to true, session data can be tracked even if the client browser has cookie support turned off.

customErrors

The customErrors setting, part of the <system.web> section, allows you to control how and when a customized error page is displayed to users. The following listing shows a version of the custom errors section of WEB.CONFIG.

<system.web>
  <customErrors mode="On" defaultRedirect="errorGeneric.aspx">
    <error statusCode="404" redirect="notfound.aspx"/>
    <error statusCode="403" redirect="notallowed.aspx"/>
    <error statusCode="500" redirect="apperror.aspx"/>
  </customErrors>
</system.web>

The default setting is "remoteOnly." This means custom errors will only be displayed when users are calling from a remote machine. This allows local calls to see the standard Internet Information Server error information, while remote users will see a more friendly error page.

There are a number of possible configuration sections for WEB.CONFIG files. Check the ASP.NET documentation for a comprehensive list of configuration sections and settings.

Accessing Configuration Data at Runtime

You can access values in the WEB.CONFIG file of your Web application at runtime. In this way, you can store important values such as data connections and other configuration information in the file and then read them into your program as needed.

Listing 21.3 shows the code that can be used to read in all the values in the appSettings section of the WEB.CONFIG file.

Listing 21.3. DEFAULT.ASPX—Reading the Contents of the AppSettings Section of a WEB.CONFIG File

<%@ Page Description="Accessing Configuration Settings" %>

<script language="vb" runat="server">

sub Page_Load(sender as object, args as EventArgs)

  dim strKey as string

  for each strKey in ConfigurationSettings.AppSettings
   configDisplay.Text &= "<b>" & strKey & "</b> :: "
   configDisplay.Text &= ConfigurationSettings.AppSettings(strKey)
   configDisplay.Text &= "<br />"
  next

end sub
</script>

<html>
<body>

<h2>Accessing Configuration Settings</h2>
<hr />

<h3>appSettings</h3>
<asp:Label id="configDisplay" runat="server"/>

</body>
</html>

When you run this code against the WEB.CONFIG file that is shown in List 21.2, you'll see the list of appSettings values appear in the browser (See Figure 21.1).

Figure 21.1. Viewing the appSettings values from WEB.CONFIG in a browser.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020