Home > Articles > Programming > Windows Programming

  • Print
  • + Share This
Like this article? We recommend

Like this article? We recommend

Creating a Sample COM+ Service

A hosted assembly is a .NET assembly that runs in some other application's space. For example, ASP.NET pages are hosted by aspnet_wp.exe, service components are hosted by COM+ (or dllhost.exe), and .NET assemblies loaded by NUnit test fixtures might be hosted by nunit-gui.exe.

If we want to test a hosted assembly, we'll need a hosted assembly to test. In this section, we'll create a basic COM+ serviced component in C#. This simple assembly will be our guinea pig.

NOTE

Unfortunately, we'll have to breeze over building serviced components, but there are many great books on COM+ for .NET. A quick search on Amazon.com or a referral by your friends will lead you to these sources if building serviced components is a subject you'd like to explore further.

Here's an overview of the steps to create a COM+ serviced component in .NET and to demonstrate debugging hosted services, using Visual Studio 2003 and the .NET Framework version 1.1. I'll elaborate modestly after the steps.

  1. Run Visual Studio .NET and create a new Class Library project.

  2. Modify the stubbed project by adding a reference to System.EnterpriseServices.

  3. Add a using statement and add the System.EnterpriseServices namespace.

  4. Add two assembly attributes to the class module: ApplicationActivationAttribute and ApplicationAccessControlAttribute.

  5. Modify the template-generated class so that it inherits from System.EnterpriseServices.ServicedComponent.

  6. Apply the TransactionAttribute to the template class.

  7. Implement the GetLuckyNumber method.

  8. Apply the AutoCompleteAttribute to the GetLuckyNumber method.

  9. Create a key file (because our COM+ service will need to be strongly named).

  10. Add the key file to the project, modifying the AssemblyKeyFileAttribute to refer to our newly created key file.

  11. Build the service and register it.

I've included a paragraph or two to cover each of these steps. If you're very comfortable with creating COM+ servers, feel free to skip ahead to the section "Attaching to the Host Application."

Creating a Library Project

For this example, I used C#. To create the service project, follow these steps:

  1. Start Visual Studio .NET.

  2. Select File, New.

  3. In the New Project dialog box, select Visual C# Project from the Project Types list and Class Library from the Templates list.

  4. Make sure that the project is located in the desired folder; then click OK.

Using EnterpriseServices

COM+ services are supported by the System.EnterpriseServices namespace, so we'll need to add a reference to the assembly containing this namespace and a using statement to our class module. Follow these steps:

  1. Select Project, Add Reference in the context of the project we just created.

  2. On the .NET tab, find the System.EnterpriseServices assembly (see Figure 1), click Select, and then click OK to add the reference.

Figure 1Figure 1 Adding a reference to the System.EnterpriseServices assembly.

  1. After you've added the reference, add a using statement to the top of the class module created by the Class Library project template:

using statement for System.EnterpriseServices;

Adding Assembly Attributes

Working our way from the revisions at the top of the module to the bottom, next we need to add some assembly attributes. Often you'll find assembly attributes in the AssemblyInfo file, but we can place them in a class module as well. Because I want to show all the code we'll need to add (for the most part) in one module, the assembly attributes were added to the same class module as the using statement in the preceding section. Listing 1 shows the first few lines of code, including the assembly attributes:

Listing 1 Assembly Attributes for Our Serviced Component

using System;
using System.EnterpriseServices;

[assembly: ApplicationActivation(ActivationOption.Server)]
[assembly: ApplicationAccessControl(false)]

// ...

The ApplicationActivationAttribute indicates whether the serviced component runs in the creator's process or the server's process. By initializing the ApplicationActivationAttribute with ActivationOption.Server, we indicate that the service should run in the server's process (DLLHOST.EXE). This means that DLLHOST.EXE will be the host application for our service. The other enumeration for ActivationOption is Library, which is the default, and it means that the service would run in our application's process.

The second attribute is ApplicationAccessControlAttribute. Initializing this attribute with true would enable security configuration. We used false here because security is another topic; for now we want it to be easy to host, use, and debug the service.

Defining the ServicedComponent

Template projects and items are just what you might expect: text files with replaceable parameters. When you open a template, a wizard that ships with .NET, vswizard.dll, replaces the parameters in the template source file with options you select in the dialog boxes, such as the New Project dialog box. We'll need to modify the empty class template created by the wizard, as shown in Listing 2.

Listing 2 Completing the Serviced Component's Class

using System;
using System.EnterpriseServices;

[assembly: ApplicationActivation(ActivationOption.Server)]
[assembly: ApplicationAccessControl(false)]
namespace MyService
{

 [Transaction(TransactionOption.Required)]
 public class LuckyNumberGenerator : ServicedComponent
 {
  public LuckyNumberGenerator(){}

  [AutoComplete()]
  public int GetLuckyNumber()
  {
   Random r = new Random(DateTime.Now.Second);
   return r.Next();
  }
 }
}

The first few lines in Listing 2 were shown in Listing 1 and described in the adjacent paragraphs. The class itself is simple: It uses the Random class to return a random number seeded with the system clock's current second count. We're interested in the modest revisions that make this a COM+ component.

The first bold statement in Listing 2 applies the TransactionAttribute. (Keep in mind that Attribute suffixes are left off by convention.) The TransactionAttribute indicates the type of COM+ transaction available to the component. TransactionOption.Required means that the component shares a transaction if one exists. (Other options are Disabled, NotSupported, RequiresNew, and Supported.) Our example is very trivial, so these options won't make a big impact on the behavior of the service.

TIP

To learn more about COM and .NET, pick up a copy of Juval Löwy's COM and .NET Component Services (O'Reilly, 2001).

The next bold clause in Listing 2 indicates that our class inherits from ServicedComponent. A ServicedComponent is derived from a ContextBoundObject and a MarshalByRefObject. These classes support marshalling and proxies, and ServicedComponent is the base class for all .NET COM+ components.

The final bold statement is the application of the AutoCompleteAttribute. AutoComplete makes the transaction call SetComplete automatically if the method called doesn't throw an exception. If you forget AutoComplete, you'll need to call ContextUtil.SetAbort or ContextUtil.SetComplete, respectively, based on the failure or success of the method call.

CAUTION

Forgetting to use the AutoCompleteAttribute or calling SetAbort or SetComplete may make your service component appear to hang interminably.

That's it. We have a basic serviced component. We need to make a few minor adjustments and register the component in the GAC to begin testing and debugging through our host application.

Strongly Naming the Serviced Component

COM+ services need to be strongly named and registered. We'll register the serviced component in the next section. To add a strong name to the assembly, perform these operations:

  1. Open the Visual Studio .NET command prompt.

  2. Run the sn.exe (strong name) utility; for example, sn –k mykey.snk creates the public and private keys.

  3. Add the mykey.snk file to the serviced component's project folder and incorporate it into the project.

  4. Modify the AssemblyKeyFileAttribute, initializing it with the relative path and name of your key file. The AssemblyKeyFileAttribute is found stubbed in the AssemblyInfo.cs file and should look something like this (depending on where your key file is physically located):

[assembly: AssemblyKeyFile("..\\..\\..\\mykey.snk")]

TIP

The Visual Studio command prompt is located at Start, Program Files, Microsoft Visual Studio .NET 2003, Visual Studio .NET Tools, Visual Studio .NET 2003 Command Prompt.

Keep in mind that in C# the whack or backslash (\) character is an escape character, so you need to use two of them (\\) or a single whack and the @ character to unescape the string literal. With the @ symbol, the statement would be written as follows:

[assembly: AssemblyKeyFile(@"..\..\..\mykey.snk")]

Building and Registering the Serviced Component

The final two steps are building the project and registering the serviced component. Build the component from the Build menu in .NET and register the component using the regsvcs.exe utility.

To register the service, open the Visual Studio .NET command prompt, change to the bin folder containing your serviced components assembly, and type the following:

regsvcs myservice.dll

The sample service was actually called myservice.dll. If everything has been put together correctly, the Component Services console should contain your service (see Figure 2).

Figure 2Figure 2 Our serviced component in the Component Services console.

NOTE

When you register the service, you get a warning about not having an interface for the serviced component. This error means that late bound instances of the service will not be able to AutoComplete. For a product service, you'll likely want to define an interface containing the method and property signatures for public members that comprise your service.

Creating a Client Sample Application

Next we need a client application that consumes the service component. To invoke the service, I added a button to a form. When you click the button, an instance of MyService.LuckyNumberGenerator is created, and LuckyNumberGenerator.GetLuckyNumber is called. The results of this method call are shown in a message box.

To complete the client application, add a reference to MyService and System.EnterpriseServices. Then add a button to the template-generated form, use the form designer to generate a button Click event, and add the code shown in Listing 3.

Listing 3 The Only Code We Need To Add To Invoke the LuckyNumberGenerator

private void button1_Click(object sender, System.EventArgs e)
{
 const string message = "Your lucky number is {0}";
 MyService.LuckyNumberGenerator generator = new MyService.LuckyNumberGenerator();
 MessageBox.Show(string.Format(message, generator.GetLuckyNumber()));
}
  • + 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