Policy Framework in STP
- 1 Introduction
- 2 Use Cases
- 3 Design Map
- 4 Policy Data model
- 5 Policy Registry
- 6 Policy Creation
- 7 Policy Validation
- 8 Policy Artifact Processor
- 9 User Roles
- 10 Runtime support
- 11 Example
- 12 Questions
- 13 Reference
This doc is aiming to define a framework to enforce SOA policy during developing and deploying service component. It includes
*Policy Model *Policy Registry *Policy Creation *Policy Validation *Policy Processor
Policy Data model
The policy model used here is different than policy defined in ws_policy or sca policy framework. It will more focus on the policy metaphor used during service creation and deployment.
Name, the name of the policy
Description, policy description
Category, such as transport, binding, security...etc
Version, policy version. We should support versioning in the policy framework
Metadata, the represented underline policy. It maybe a policy file or policy id in the registry. For policy file, it maybe a WS-Policy file or user proprietary xml file.
(Add Policy Model to STP Intermedia Metadmodel?)
The Policy Registry will used to hold all policies to share cross projects. It will provide following functions:
*addPolicy *removePolicy *updatePolicy *listCategories *listPolicies *getPolicy
Since the resource nature of the registry, we will implement it as a REST full service. I am looking for a generic tool to expose database table to REST service. If can't find one, we may develop such as tool in stp.
In the first version, it will be implemented as XML file for simplicity. Later on, we will move to use embedded database (like Apache Derby) for better performance.
Policy Set Extension Point
Extension point to allow user to add pre-defined policy set to the registry. We will load those pre-defined polic sets during startup, and add them to the policy database.
Which means create policy with policy editor and associate policies to service component
Two policy Editors in STP:
XEF Policy Editor: It is a generic schema based policy editor.
WTP based Policy Editor: Used to create policy following ws-policyattachment?
Policy Association / Policy View
Policy View will list all of the policies associated with a service component. Allow user to add/remove policy. The add action will bring up the policy editor.
Here is the screenshot:
When user add/move policy from service component, the policy validator will be called.
Policy association during deployment
Maybe the deployment profile editor needs to be extended to support applying policies at deployment stage.
The policy validation framework is used to define a validation mechanism when applying policies to a service component. Similar to policy editor. We will provide a policy validation rule editor for user to dynamic add/remove validation rules as well.
The validation rules will cover following category:
Define dependencies relationship between policies. Example:
<validation> <rule> <dependency policy_id = "policy A"> <on policy_id="policy B", version="2.0"/> <on policy_id="policy C"/> </dependency> </rule> </validation>
Define conflict relationship between policies Example:
<validation> <rule> <conflict policy_id = "policy A"> <with policy_id="policy D", version="2.0" /> <with policy_id="policy E" /> </conflict> </rule> </validation>
Policy Subject Constraints
Define the subject set which the policy may apply Example:"
<validation> <rule> <subjects policy_id = "policy A"> <subject>endpoint</subject> <subject>message</subject> </subjects> </rule> <rule> <subjects policy_id = "policy B"> <subject>message</subject> </subjects> </rule> </validation>
Policy Validation Engine Implementation
Need to write a engine to support the about validation rules. When user add/remove a policy, we will call the engine to do the validating, the give meaningful error message if any.
Need to looking into the emf.validation to see if we can use use it here. User defines the validation rules from GUI. How to translate those rules to emf validator class on the fly is a problem in that case.
rule based xml validator in stp
Alternative, we may think about extend the current rule based xml validator to support policy validation here.
Policy Artifact Processor
Policies will be translated into different runtime artifacts at various stages.
Policy to Artifact mapping
Policies maybe be mapping to:
configuration file @Policy annotation WS-Policyattachment
When to process policies? I don't have clear picture about the timing yet. I think we need to clearly divide the service creation and deployment into several stages. Then allow user to add customized processor at any stage by extension point.
Since the policy to runtime artifacts mapping is runtimes specific. we will a provide processor extension point to allow user to hook the process function.
*Policy Developer -- write policies and policy validation rules. write policy processor. *Service Developer -- write policy, config and apply existing policy to service component. *Deployment Assembler -- apply policies to services during deployment *Operator -- dynamic config/modify policies at runtime.
Relations with SCA Policy Framework?
The SCA policy association framework allows policies and policy subjects specified using WS-Policy and WS-PolicyAttachment, as well as with other policy languages, to be associated with SCA components.