From e33a3c09f747ccabae31db4dfe7b3461c0530aa9 Mon Sep 17 00:00:00 2001 From: sourabh_sourabh Date: Tue, 2 Apr 2024 13:35:33 +0100 Subject: Define a java based datastructure for DataJob and interface - Defined java interface to handle datajob - Defined all the modules needed to process data job request - data jon response module id also defined - dummy impl. of java interface Issue-ID: CPS-2155 Change-Id: I20c7b621aa4bd40fe7758cb19b8720fc7cf5164c Signed-off-by: sourabh_sourabh --- .../java/org/onap/cps/ncmp/api/DataJobService.java | 46 ++++++++++++++++++++++ .../onap/cps/ncmp/api/impl/DataJobServiceImpl.java | 43 ++++++++++++++++++++ .../ncmp/api/models/datajob/DataJobMetadata.java | 33 ++++++++++++++++ .../api/models/datajob/DataJobReadRequest.java | 30 ++++++++++++++ .../api/models/datajob/DataJobWriteRequest.java | 30 ++++++++++++++ .../cps/ncmp/api/models/datajob/ReadOperation.java | 43 ++++++++++++++++++++ .../ncmp/api/models/datajob/WriteOperation.java | 34 ++++++++++++++++ 7 files changed, 259 insertions(+) create mode 100644 cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/DataJobService.java create mode 100644 cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/DataJobServiceImpl.java create mode 100644 cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/DataJobMetadata.java create mode 100644 cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/DataJobReadRequest.java create mode 100644 cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/DataJobWriteRequest.java create mode 100644 cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/ReadOperation.java create mode 100644 cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/WriteOperation.java (limited to 'cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api') diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/DataJobService.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/DataJobService.java new file mode 100644 index 0000000000..6122afc808 --- /dev/null +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/DataJobService.java @@ -0,0 +1,46 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2024 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.api; + +import org.onap.cps.ncmp.api.models.datajob.DataJobMetadata; +import org.onap.cps.ncmp.api.models.datajob.DataJobReadRequest; +import org.onap.cps.ncmp.api.models.datajob.DataJobWriteRequest; + +public interface DataJobService { + + /** + * process read data job operations. + * + * @param dataJobId Unique identifier of the job within the request + * @param dataJobMetadata data job request headers + * @param dataJobReadRequest read data job request + */ + void readDataJob(String dataJobId, DataJobMetadata dataJobMetadata, DataJobReadRequest dataJobReadRequest); + + /** + * process write data job operations. + * + * @param dataJobId Unique identifier of the job within the request + * @param dataJobMetadata data job request headers + * @param dataJobWriteRequest write data job request + */ + void writeDataJob(String dataJobId, DataJobMetadata dataJobMetadata, DataJobWriteRequest dataJobWriteRequest); +} \ No newline at end of file diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/DataJobServiceImpl.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/DataJobServiceImpl.java new file mode 100644 index 0000000000..b4377b84f2 --- /dev/null +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/DataJobServiceImpl.java @@ -0,0 +1,43 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2024 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.api.impl; + +import lombok.extern.slf4j.Slf4j; +import org.onap.cps.ncmp.api.DataJobService; +import org.onap.cps.ncmp.api.models.datajob.DataJobMetadata; +import org.onap.cps.ncmp.api.models.datajob.DataJobReadRequest; +import org.onap.cps.ncmp.api.models.datajob.DataJobWriteRequest; + +@Slf4j +public class DataJobServiceImpl implements DataJobService { + + @Override + public void readDataJob(final String dataJobId, final DataJobMetadata dataJobMetadata, + final DataJobReadRequest dataJobReadRequest) { + log.info("data job id for read operation is: {}", dataJobId); + } + + @Override + public void writeDataJob(final String dataJobId, final DataJobMetadata dataJobMetadata, + final DataJobWriteRequest dataJobWriteRequest) { + log.info("data job id for write operation is: {}", dataJobId); + } +} diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/DataJobMetadata.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/DataJobMetadata.java new file mode 100644 index 0000000000..dc8037b86f --- /dev/null +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/DataJobMetadata.java @@ -0,0 +1,33 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2024 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.api.models.datajob; + +/** + * Metadata of read/write data job request. + * + * @param destination The destination of the data job results. + * @param dataAcceptType Define the data response accept type. + * e.g. "application/vnd.3gpp.object-tree-hierarchical+json", + * "application/vnd.3gpp.object-tree-flat+json" etc. + * @param dataContentType Define the data request content type. + * e.g. "application/3gpp-json-patch+json" etc. + */ +public record DataJobMetadata(String destination, String dataAcceptType, String dataContentType) {} \ No newline at end of file diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/DataJobReadRequest.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/DataJobReadRequest.java new file mode 100644 index 0000000000..f861c3d498 --- /dev/null +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/DataJobReadRequest.java @@ -0,0 +1,30 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2024 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.api.models.datajob; + +import java.util.List; + +/** + * Describes the read data job operation to be forwarded to dmi. + * + * @param data List of read operations to be executed. + */ +public record DataJobReadRequest(List data) {} diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/DataJobWriteRequest.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/DataJobWriteRequest.java new file mode 100644 index 0000000000..254e198b81 --- /dev/null +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/DataJobWriteRequest.java @@ -0,0 +1,30 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2024 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.api.models.datajob; + +import java.util.List; + +/** + * Describes the write data job operation to be forwarded to dmi. + * + * @param data List of write operations to be executed. + */ +public record DataJobWriteRequest(List data) {} diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/ReadOperation.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/ReadOperation.java new file mode 100644 index 0000000000..d2b0738969 --- /dev/null +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/ReadOperation.java @@ -0,0 +1,43 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2024 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.api.models.datajob; + +import java.util.List; + +/** + * Holds information of read data job operation. + * based on ETSI TS 128 532 V16.4.0 (2020-08) + * + * @param path Identifier of a managed object (MO) on a network element. Defines the resource on which operation + * is executed. Url Encoded Fully Distinguished Name (FDN). + * @param op Describes the operation to execute. The value can only be "read". + * @param operationId Unique identifier of the operation within the request. + * @param attributes Specifies the attributes of the resources that are returned. + * @param fields Specifies the attribute fields of the resources that are returned. This should be used if an + * attribute is a struct and only a subset of its fields should be returned. + * @param filter This filters the managed Objects. + * @param scopeType This selects MOs depending on relationships with Base Managed Object. + * e.g. "BASE_ONLY", "BASE_ALL", "BASE_NTH_LEVEL" etc. + * @param scopeLevel Defines the level for objects to be returned for certain scopeTypes. The base level is zero. + */ +public record ReadOperation(String path, String op, String operationId, List attributes, List fields, + String filter, String scopeType, int scopeLevel) { +} diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/WriteOperation.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/WriteOperation.java new file mode 100644 index 0000000000..c2f6504ce2 --- /dev/null +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/WriteOperation.java @@ -0,0 +1,34 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2024 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.api.models.datajob; + +/** + * Holds information of write data job operation. + * based on ETSI TS 128 532 V16.4.0 (2020-08) + * + * @param path Identifier of a managed object (MO) on a network element. Defines the resource on which operation + * is executed. Typically, is Fully Distinguished Name (FDN). + * @param op Describes the operation to execute. The value can be as below: + * e.g. "add", "replace", "remove", "action" etc. + * @param operationId Unique identifier of the operation within the request. + * @param value The value to be written depends on the type of operation. + */ +public record WriteOperation(String path, String op, String operationId, Object value) {} -- cgit 1.2.3-korg