Using attributes to identify and filter pluggable functionality

• US 7,831,956 B2
• Filed: 12/14/2005
• Issued: 11/09/2010
• Est. Priority Date: 09/13/2005
• Status: Active Grant

• Current Assignee: Microsoft Technology Licensing LLC (Microsoft Corporation)
• Original Assignee: Microsoft Corporation
• Inventors: Kimmerly, Randy S.
• Primary Examiner(s): Zhen; Wei Y
• Assistant Examiner(s): Nguyen; Phillip H
• Application Number:
  US11/304,204
• Publication Number:
  US 20070061799A1
• Time in Patent Office: 1,791 Days
• Field of Search: 717/113, 717/166
• US Class Current: 717/113
• CPC Class Codes: G06F 8/20 Software design

Abstract

In a composition model for large-scale extensible applications, applications are constructed in a modular fashion. The modules integrate with each other by producing and consuming functionality that conforms to a common definition. Producer modules and consumer modules are kept independent of one another, and are linked together indirectly via a definition module. .NET attributes are used to identify various code artifacts (such as classes, methods, properties, etc.) as being functionality definitions, productions, and/or consumptions. These attributes are examined by the module loader and used to create relationships between individually installed producer and consumer modules. The consumer uses .NET attributes to declare dependency on functionality and filter out implementations that don'"'"'t meet the criteria specified by those attributes.

Claims

1. A computer-implemented method for using an attribute to identify a functionality, the method comprising:

discovering a software consumer module, wherein the software consumer module is configured to consume the functionality;

discovering a definition module, wherein the definition module is configured to define a programmatic interface for the functionality and an attribute for advertising a functionality definition that corresponds to the functionality, wherein the attribute comprising metadata associated with the functionality;

discovering a software producer module, wherein the software producer module is configured to produce a functionality implementation that conforms to the functionality definition; and

establishing a link between the software producer module and the software consumer module for the software consumer module to consume the functionality produced by the software producer module.

2. The method of claim 1 further comprising:

associating metadata with the definition module, the software producer module, and the software consumer module in a static and serializable fashion.

3. The method of claim 1, wherein the producer module and consumer module are kept independent of one another, and are linked together indirectly via the definition module.

4. The method of claim 1, further comprising obtaining, via the attribute, metadata associated with the software producer module without loading the software producer module.

5. The method of claim 1, wherein the software consumer module is further configured to advertise consumption of the functionality via a service attribute.

6. The method of claim 1, wherein the software consumer module is further configured to define a service factory class for obtaining a method for invoking the functionality provided by the producer module.

7. The method of claim 6, wherein an instance of the service factory class is configured to return a service attribute instance comprising metadata associated with the software producer module.

8. The method of claim 6, wherein the service factory class comprising a service attribute for indicating a producer module criteria, wherein the service attribute declares a dependency on a producer module having an service attribute instance that meets the producer module criteria.

9. The method of claim 1, wherein the software consumer module is further configured to define a service broker class for providing access to a plurality of functionality implementations that provide the functionality.

10. The method of claim 1, wherein the software producer module is further configured to:

define a service producer class for implementing the functionality, the service object type being defined in a definition module;

advertise the service producer class as an functionality implementation via a service attribute; and

supply metadata associated with the service producer class via the service attribute.

11. A system for using an attribute to identify a functionality, the system comprising:

a processor; and

a module loader operated by the processor, and is configured to;

discover a software consumer module, wherein the software consumer module is configured to consume the functionality,

discover a definition module, the definition module is configured to define a programmatic interface for the functionality and an attribute for advertising a functionality definition that corresponds to the functionality, wherein the attribute comprising metadata associated with the functionality,

discover a software producer module configured to produce a functionality implementation that conforms to the functionality definition, and

establish a link between the software producer module and the software consumer module for the software consumer module to consume the functionality produced by the software producer module.

12. The system of claim 11, further comprising the definition module, the definition module comprising:

a port class defining the functionality; and

a port definition attribute advertizing the port class as a port definition.

13. The system of claim 12, wherein the port class further comprising:

a signature method defining a contribution associated with the port class; and

a metadata association attribute for associating metadata with the contribution that corresponds to the port class.

14. The system of 11, further comprising the software producer module, the producer module comprising:

a contribution class comprising a static method that corresponds to a signature method of a corresponding port class defined in the definition module; and

a contribution attribute identifying a port type associated with the contribution class.

15. The system of 14, wherein the module loader is configured to provide a plurality of port class instances to the software consumer and wherein the software consumer module is further configured to examine a respective port type of each of the plurality of port class instances, and selecting a port class instance for consuming the functionality based on the respective port type.

16. The system of 11, further comprising the software consumer module, the software consumer module is configured to:

advertise consumption of the functionality via an attribute; and

obtain an port class instance that matches the declared dependency via a dispenser, the port class instance representing a corresponding contribution conforming to the definition of the port class.

17. A computer readable storage medium having computer executable instructions for identifying a functionality, said instructions comprising:

at a consumer module;

declaring dependency on the functionality of a software producer module;

specifying a functionality criterion via an attribute, the attribute comprising metadata associated with the functionality;

receiving a plurality of functionalities via a link to the software producer module, the link being established based on the declared dependency, wherein the link is established by a loader module that discovers the software producer module and the consumer module via a definition module, the definition module defines a programmatic interface for the functionality and the attribute for advertising a functionality definition that corresponds to the functionality; and

consuming one of the plurality of received functionalities produced by the software producer module that meets the specified functionality criterion.

18. The computer readable storage medium of claim 17, the instructions further comprising:

obtaining an port class instance that matches the declared dependency via a dispenser, the port class instance representing a corresponding contribution conforming to the definition of the port class.

19. The computer readable storage medium of claim 17, the instructions further comprising:

obtaining a plurality of port class instance that matches the declared dependency via a dispenser, the plurality of port class instances representing a corresponding contribution conforming to the definition of the port class;

identifying a contribution method based on respective metadata associated with each of the plurality of the port class instances; and

invoking the identified contribution method.

20. A computer readable storage medium having computer executable instructions for identifying a functionality, said instructions comprising:

discovering a software consumer module, wherein the software consumer module is configured to consume the functionality;

discovering a definition module, wherein the definition module is configured to define a programmatic interface for the functionality and an attribute for advertising a functionality definition that corresponds to the functionality, the attribute comprising metadata associated with the functionality;

discovering a software producer module, wherein the software producer module is configured to produce a functionality implementation that conforms to the functionality definition; and

establishing a link between the software producer module and the software consumer module for the software consumer module to consume the functionality produced by the software producer module.