System and method for external override of annotations

• US 7,607,126 B2
• Filed: 05/20/2005
• Issued: 10/20/2009
• Est. Priority Date: 05/21/2004
• Status: Active Grant

• Current Assignee: Oracle International Corporation (Oracle Corporation)
• Original Assignee: BEA Systems Incorporated (Oracle Corporation)
• Inventors: Read, David
• Primary Examiner(s): Khatri; Anil
• Application Number:
  US11/134,714
• Publication Number:
  US 20050262499A1
• Time in Patent Office: 1,614 Days
• Field of Search: 717/101, 717/118, 717120-121, 717172-174
• US Class Current: 717/172
• CPC Class Codes: G06F 8/656 while running

Abstract

A deployable application component can be configured via external annotation overrides at runtime without having to restart the component. An annotation/manifest can be populated to the corresponding application component at build time. The application component can then be configured and changes can be saved as annotation override into an external descriptor in XML format at deploy time. Such external descriptor can then be distributed, parsed, and validated at runtime to configure/update the deployed application component upon receiving notification of deployment changes.

Claims

1. A system to provide an external configuration framework, comprising:

one or more computing devices;

a manifest operable to define a plurality of annotations and their constraints;

an application component configurable via the plurality of annotations at build time;

a deployment configuration manager operable to

configure values of the plurality of annotations under their constraints, and save the values as overrides of the plurality of annotations in an external descriptor at configure or deploy time;

a deployment manager operable to distribute, start, stop, or update the application component at runtime;

a descriptor framework operable to parse or validate the external descriptor at runtime, wherein a deployment plan is distributed to the descriptor framework in addition to the external descriptor; and

a container operable to configure or update the application component externally at runtime with the overrides of the plurality of annotations upon receiving a notification of deployment or deployment change without restarting or redeploying the application component, wherein the container is operable to access the overrides of the plurality of annotations from the descriptor framework, and a custom module operable to;

listen to deployment or update event at runtime;

respond to the event by invoking the descriptor framework to parse or validate the external descriptor if it is changed; and

generate the notification of deployment changes to be delivered to the container.

2. The system according to claim 1, further comprising:

an administrative application operable to present or edit values of the plurality of annotations under their constraints, wherein the administrative application is a console, an IDE or a web-based administrative tooling environment such as Jython scripting.

3. The system according to claim 1 wherein:

the external configuration framework is implemented in one of a Java®

, programming language, a C++ programming language, and a C# programming language via one of a bean object, an enterprise bean object, and a class.

4. The system according to claim 1, wherein:

the application component is deployed under a Java®

platform environment.

5. The system according to claim 1, wherein:

each constraint on the plurality of the annotations is one of;

a data type, a range, an optional or required tag, and a membership rule.

6. The system according to claim 1, wherein:

the plurality of annotations have a structural or a collapsed form of representation.

7. The system according to claim 1, wherein:

values of the plurality of annotations are in clear text or encrypted.

8. The system according to claim 1, wherein:

the deployment configuration manager is further operable to perform at least one of the following operations;

identifying a subset of the plurality of annotations to be externally configurable;

setting values of the subset of the plurality of annotations identified as externally configurable;

replacing or removing the existing values of the subset of the plurality of annotations identified as externally configurable;

supporting dynamic setting of the subset of the plurality of annotations; and

creating an external representation of overrides of the subset of the plurality of annotations by serializing them to an XML file.

9. The system according to claim 1, wherein:

the deployment manager or the deployment configuration manager is integrated with a Java®

application programming interface configuration process.

10. The system according to claim 1, wherein:

the external descriptor is in XML format.

11. The system according to claim 1, wherein:

the type of the container is a control or an enterprise bean object.

12. A method to provide an external configuration framework, comprising:

defining and populating, at a computing device, a plurality of annotations and their constraints specified at build time to an application component;

configuring the application component via the plurality of annotations of under their constraints;

saving values of the plurality of annotations as overrides into an external descriptor at configure or deploy time;

distributing, starting, stopping, or updating the application component at runtime;

distributing, parsing or validating the external descriptor at runtime;

distributing a deployment plan at runtime in addition to the external descriptor;

configuring or updating the application component with the overrides of the plurality of annotations externally at runtime upon receiving a notification of deployment or deployment change without restarting or redeploying the application component; and

accessing the overrides of the plurality of annotations, listening to deployment or update event at runtime;

responding to the event by invoking the descriptor framework to parse or validate the external descriptor if it is changed; and

generating the notification of deployment changes to be delivered to the container.

13. The method according to claim 12, further comprising:

presenting or editing the plurality of annotations under their constraints via an administrative application, which is one of a console, an IDE or an administrative tooling environment such as Jython scripting.

14. The method according to claim 12, further comprising at least one of:

identifying a subset of the plurality of annotations to be externally configurable;

setting values of the subset of the plurality of annotations identified as externally configurable;

replacing or removing the existing values of the subset of the plurality of annotations identified as externally configurable;

supporting dynamic setting of the subset of the plurality of annotations; and

creating an external representation of overrides of the subset of the plurality of annotations by serializing them to an XML file.

15. A tangible machine readable medium having instructions stored thereon that when executed cause a system to:

define and populate a plurality of annotations and their constraints specified at build time to an application component;

configure the application component via the plurality of annotations of under their constraints;

save values of the plurality of annotations as overrides into an external descriptor at configure or deploy time;

distribute, start, stop, or update the application component at runtime;

distribute, parse and/or validate the external descriptor at runtime;

distribute a deployment plan at runtime in addition to the external descriptor;

configure or update the application component with the overrides of the plurality of annotations externally at runtime upon receiving a notification of deployment or deployment change without restarting or redeploying the application component; and

access the overrides of the plurality of annotations, listening to deployment or update event at runtime;

responding to the event by invoking the descriptor framework to parse or validate the external descriptor if it is changed; and

generating the notification of deployment changes to be delivered to the container.

16. A system to provide an architecture for external control configuration, comprising:

one or more computing devices;

means for defining and populating a plurality of annotations and their constraints specified at build time to an application component;

means for configuring the application component via the plurality of annotations of under their constraints;

means for saving values of the plurality of annotations as overrides into an external descriptor at configure or deploy time;

means for distributing, starting, stopping, or updating the application component at runtime;

means for distributing, parsing or validating the external descriptor at runtime;

means for distributing a deployment plan at runtime in addition to the external descriptor;

means for configuring or updating the application component with the overrides of the plurality of annotations externally at runtime upon receiving a notification of deployment and/or deployment change without restarting or redeploying the application component; and

means for accessing the overrides of the plurality of annotations, means for listening to deployment or update event at runtime;

means for responding to the event by invoking the descriptor framework to parse or validate the external descriptor if it is changed; and

means for generating the notification of deployment changes to be delivered to the container.