Merge branch 'feature/tmf702-api' into 'develop' (30e9832b) · Commits · OSL / code / org.etsi.osl.tmf.api

pom.xml

+6 −0

Original line number	Diff line number	Diff line
		@@ -295,6 +295,12 @@
		<artifactId>junit-platform-runner</artifactId>
		<scope>test</scope>
		</dependency>
		<dependency>
		<groupId>org.mockito</groupId>
		<artifactId>mockito-inline</artifactId>
		<version>4.0.0</version>
		<scope>test</scope>
		</dependency>
		<dependency>
		<groupId>com.h2database</groupId>
		<artifactId>h2</artifactId>

src/main/java/org/etsi/osl/tmf/configuration/SwaggerDocumentationConfig.java

+34 −0

Original line number	Diff line number	Diff line
		@@ -876,6 +876,40 @@ public class SwaggerDocumentationConfig {
		.packagesToScan("org.etsi.osl.tmf.pm628.api")
		.build();

		}

		/**
		* TMF 702 Resource Activation Management
		* @return
		*/
		@Bean
		public OpenApiCustomizer ram7020penAPI() {


		return openApi -> openApi
		.specVersion( SpecVersion.V30 ).addSecurityItem(new SecurityRequirement().addList("security_auth"))
		.info(new Info().title("TMF 702 Resource Activation and Configuration")
		.description("## TMF API Reference: TMF702 - Resource Activation \n\n### Release : 19.5 - December 2019\n\nResource Activation API goal is to provide the ability to activate Resources.\n\n### Operations\nResource Activation and Configuration API performs the following operations on the resources :\n- Retrieve an entity or a collection of entities depending on filter criteria\n- Partial update of an entity (including updating rules)\n- Create an entity (including default values and creation rules)\n- Delete an entity (for administration purposes)\n- Manage notification of events")
		.version("4.0.0")
		.license(new License().name("Apache 2.0").url("https://osl.etsi.org")))
		.externalDocs(new ExternalDocumentation()
		.description("TMF API Tables")
		.url("https://www.tmforum.org/oda/open-apis/table"));

		}


		@Bean
		public GroupedOpenApi ram702() {

		SpringDocUtils.getConfig().replaceWithClass(java.time.LocalDate.class, java.sql.Date.class);
		SpringDocUtils.getConfig().replaceWithClass(java.time.OffsetDateTime.class, java.util.Date.class);
		return GroupedOpenApi.builder()
		.group("tmf-api-702-Resource Activation and Configuration-v4.0.0")
		.addOpenApiCustomizer( this.ram7020penAPI() )
		.packagesToScan("org.etsi.osl.tmf.ram702.api")
		.build();

		}

src/main/java/org/etsi/osl/tmf/ram702/api/ApiException.java

0 → 100644

+29 −0

Original line number	Diff line number	Diff line
		/*-
		* ========================LICENSE_START=================================
		* org.etsi.osl.tmf.api
		* %%
		* Copyright (C) 2024 openslice.io
		* %%
		* 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.
		* =========================LICENSE_END==================================
		*/

		package org.etsi.osl.tmf.ram702.api;

		public class ApiException extends Exception{
		private int code;
		public ApiException (int code, String msg) {
		super(msg);
		this.code = code;
		}
		}

src/main/java/org/etsi/osl/tmf/ram702/api/ApiOriginFilter.java

0 → 100644

+50 −0

Original line number	Diff line number	Diff line
		/*-
		* ========================LICENSE_START=================================
		* org.etsi.osl.tmf.api
		* %%
		* Copyright (C) 2024 openslice.io
		* %%
		* 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.
		* =========================LICENSE_END==================================
		*/

		package org.etsi.osl.tmf.ram702.api;

		import java.io.IOException;

		import jakarta.servlet.FilterChain;
		import jakarta.servlet.FilterConfig;
		import jakarta.servlet.ServletException;
		import jakarta.servlet.ServletRequest;
		import jakarta.servlet.ServletResponse;
		import jakarta.servlet.http.HttpServletResponse;

		public class ApiOriginFilter implements jakarta.servlet.Filter {
		@Override
		public void doFilter(ServletRequest request, ServletResponse response,
		FilterChain chain) throws IOException, ServletException {
		HttpServletResponse res = (HttpServletResponse) response;
		res.addHeader("Access-Control-Allow-Origin", "*");
		res.addHeader("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT");
		res.addHeader("Access-Control-Allow-Headers", "Content-Type");
		chain.doFilter(request, response);
		}

		@Override
		public void destroy() {
		}

		@Override
		public void init(FilterConfig filterConfig) throws ServletException {
		}
		}

src/main/java/org/etsi/osl/tmf/ram702/api/ApiResponseMessage.java

0 → 100644

+88 −0

Original line number	Diff line number	Diff line
		/*-
		* ========================LICENSE_START=================================
		* org.etsi.osl.tmf.api
		* %%
		* Copyright (C) 2024 openslice.io
		* %%
		* 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.
		* =========================LICENSE_END==================================
		*/

		package org.etsi.osl.tmf.ram702.api;

		import jakarta.xml.bind.annotation.XmlTransient;

		@jakarta.xml.bind.annotation.XmlRootElement
		public class ApiResponseMessage {
		public static final int ERROR = 1;
		public static final int WARNING = 2;
		public static final int INFO = 3;
		public static final int OK = 4;
		public static final int TOO_BUSY = 5;

		int code;
		String type;
		String message;

		public ApiResponseMessage(){}

		public ApiResponseMessage(int code, String message){
		this.code = code;
		switch(code){
		case ERROR:
		setType("error");
		break;
		case WARNING:
		setType("warning");
		break;
		case INFO:
		setType("info");
		break;
		case OK:
		setType("ok");
		break;
		case TOO_BUSY:
		setType("too busy");
		break;
		default:
		setType("unknown");
		break;
		}
		this.message = message;
		}

		@XmlTransient
		public int getCode() {
		return code;
		}

		public void setCode(int code) {
		this.code = code;
		}

		public String getType() {
		return type;
		}

		public void setType(String type) {
		this.type = type;
		}

		public String getMessage() {
		return message;
		}

		public void setMessage(String message) {
		this.message = message;
		}
		}