Page History

...

Demo - with "and" behavior
CI Test - two attributes

Issues/Decisions

...

	Issue	Notes	Decision
1	Does request body need to declare "publicCmHandleProperties"?	Do we need to

explcitly

explicitly declare "publicCmHandleProperties"?

Will there be another possible variation to this in the future?

Code Block

language	yml

{
  "publicCmHandleProperties" : {
          "Name-1" : "some-value",
          "Name-2" : "other-value"
   }
}

Not another variation but there will be "modules" included in future implementations.2Do we need to consider if cm handle exists?3

Yes

2

Are public properties always be in the format of "name" : x, "value": y?

In the fragment table there are example that follow this format

Code Block

language	yml

{
	"name": "Contact",
	"value": "newemailforstore@bookstore.com"
}

Yes.

Image Modified

4

3

Will there only ever be 1 kv pairs in public properties?

Yes

5

4

Does the order matter?

Does

Code Block

language	yml

{
  "publicCmHandleProperties" : {
          "Name-1" : "some-value",
          "Name-2" : "other-value"
   }
}

==

Code Block

language	yml

{
  "publicCmHandleProperties" : {
          "Name-2" : "other-value",
          "Name-1" : "some-value"
   }
}

No

6

5	Should search be case sensitive?	depend on CPSPath functionality - may be case-sensitive	Investigation Pending
6	What format should the response take?	We have two options currently: Return List<String> ["cmHandle1", "cmHandle2"] Return CM Handle Objects Already defined in CPS <Example Pending> Contact Tony Finnerty & kieran mccarthy regarding this.

Analysis/Implementation Proposal

...

Possible High-Level Implementation Steps:

Match all xpaths that contain "public" in fragment table

...

language	sql

...

using CPS Path Query
Iterate over the list and retrieve all attributes
Iterate over the attributes and collect those instances that match
Return collected list of cm handles

...

/**
     * Retrieve public properties for given cm handle.
     *
     * @param publicProperties the public properties to match
     * @return lit of cm handles that match
     */
    @Override
    public List<String> getCmHandlesForMatchingPublicProperties(final Map<String, String> publicProperties) {
        final String retrievePublicFragments =
            "SELECT xpath, attributes #>> '{}' AS attributes FROM fragment WHERE fragment.xpath LIKE '%public%';";

        final List<Object[]> resultsAsObjects =
            entityManager.createNativeQuery(retrievePublicFragments).getResultList();
        final Set<String> cmHandlesThatMatch = new TreeSet<>();
        final Set<String> allCmHandles = new TreeSet<>();

        for (final Object[] row : resultsAsObjects) {
            final String xpath = (String) row[0];
            final String attributes = (String) row[1];
            allCmHandles.add(getCmHandle(xpath));

            try {
                final String attributesAsJsonString = getAttributesAsJsonString(attributes);
                final JsonObject attributesAsJsonObject = new JsonParser().parse(attributesAsJsonString)
                    .getAsJsonObject();

                if (nameAndValueMatch(publicProperties, attributesAsJsonObject)) {
                    cmHandlesThatMatch.add(getCmHandle(xpath));
                }
            } catch (final JsonProcessingException jsonProcessingException) {
                jsonProcessingException.getMessage();
            }
        }

        if (publicProperties.get("name").isEmpty() && publicProperties.get("value").isEmpty()) {
            return List.copyOf(allCmHandles);
        }

        return List.copyOf(cmHandlesThatMatch);
    }

    private String getAttributesAsJsonString(final String attributes) throws JsonProcessingException {
        final ObjectMapper objectMapper = new ObjectMapper();
        String attributesAsJsonString = objectMapper.writeValueAsString(attributes);
        attributesAsJsonString = attributesAsJsonString.replace("\\", "");
        attributesAsJsonString = attributesAsJsonString.replaceFirst("\"", "");
        attributesAsJsonString = attributesAsJsonString.substring(0, attributesAsJsonString.length() - 1);
        return attributesAsJsonString;
    }

    private boolean nameAndValueMatch(final Map<String, String> publicProperties,
                                      final JsonObject attributesAsJsonObject) {
        return attributesAsJsonObject.get("value").getAsString().equals(publicProperties.get("value"))
            && attributesAsJsonObject.get("name").getAsString().equals(publicProperties.get("name"));
    }

    private String getCmHandle(final String xpath) {
        if (xpath.indexOf("\'") > - 1) {
            return xpath.substring(xpath.indexOf("\'") + 1, xpath.indexOf("]") - 1);
        }

        return xpath.substring(xpath.indexOf("\"") + 1, xpath.indexOf("]") - 1);
    }

Interface Proposal

#

URI

Design Notes

Comment(s)

1

POST /ncmp/v1/data/ch/searches

Scenario : Request received to return all cm handles matching properties given
Method : POST
URI : {ncmpRoot}/ncmp/v1/data/ch/searches
Header : Content-Type: application/json

Request Body

Code Block

language	yml

{
  "publicCmHandleProperties" : {
     "Name-1" : "some-value",
     "Name-2" : "other-value"
   }
}

Code Block

language	yml

{
  "publicCmHandleProperties": {
    "name": "Contact",
    "value": "newemailforstore@bookstore.com"
  }
}

Response Body

Code Block

language	yml

[
	"cmHandle1",
	"cmHandle2",
	...,
	"cmHandleN"
]

Below is a sample yaml for OpenAPI.

...

A PoC has been coded and can be found here: https://gerrit.onap.org/r/c/cps/+/127541

#	Scenario	Screenshot
1	Both properties match (CM Handles Returned that Match)	Image Modified
2	One property doesn't match (Nothing Returned)	Image Modified
3	No properties given - all cm handles returned (that contain public properties)	Image Modified
4	Return 400 (BAD_REQUEST)	Image Modified