Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


InterfaceRequirementAdditional InformationSignoff
1PolicyExecution

Documentation

NCMP own and clearly document interface using OpenAPI and RTD

2PolicyExecution

Input Parameters:

  • Bearer Token (header information?)
  • Payloadtype 
  • Decisiontype
  • Payload
    • resourceIdentifier
    • targetFdn
    • changeRequest

Payloadtype can only be 'CM_Write' for now

Payloadtype can only be 'Allow' for now

Exact Payload to be defined during study but should be well defined and cannot depend on Java interface (even if it is the same now)

3PolicyExecution

Output  Parameters;

  • Decision (enum: "allow", "deny")
  • Message - Should return a 409. Standard HTTP response
  • Decision id (String)

This is a New Generic interface that can support 'conflict handling'. 


Excerpt

Functional: CPS Impacts Policy Executor


InterfaceRequirementAdditional InformationSignoff
1CPS-E-05

Write operations are intercepted and validated using the new external service.
No effect on existing behavior if the result is 'Allow'



2CPS-E-05When the External validation is negative NCMP REST Response should be '409 Conflict'.  The HTTP status message should contain the message and decision id from the external validation service.NCMP interface validation shall be done before the external validation (Conflict management)
3CPS-E-05

NCMP to provide metrics on external validation

AP on CPS to provide the metrics (Kolawole Adebisi-Adeolokun )

Error Handling


ScenarioExpected BehaviorNotesSignoff
1External validation service does not respond (in time) Or does not respond with 2xx (Http status code)

configurable default answer


This needs further investigation AP Gergely Molnar  

Possible proposal:

  • Implement watchdog similar to DMI health check

2Unrecognized response from External Validation

(Low prio)

No default behavior covered yet in //, 

If not reachable - default accept/reject with specific message



3CM Handle ID without Alternate Id (fdn)




Characteristics


ParameterExpectationNotesSignoff
1Performance impact? 
  • External Validation Response time depends on various response time at the moment



Out of Scope

  1. Batch (bulk) interface methods and Execute a data operation for group of cm handle ids
  2. Data jobs (write) operations

...