Commit 155d6715 authored by Kostis Trantzas's avatar Kostis Trantzas
Browse files

Merge branch 'tmf-674-feature' into 'develop' 

Tmf 674 feature

See merge request !24
parents 123e9bad 82d13d67

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

+35 −1
Original line number Diff line number Diff line
@@ -728,7 +728,41 @@ public class SwaggerDocumentationConfig { 
	    		.build();

	

	}

	/**

	 * TMF 674 Geographic Site Management

	 * @return

	 */





	@Bean

	public OpenApiCustomizer gsm674OpenAPI() {

		return openApi -> openApi

				.specVersion( SpecVersion.V30 ).addSecurityItem(new SecurityRequirement().addList("security_auth"))

				.info(new Info()

						.title("TMF 674 Geographic Site Management")

						.description("## TMF API Reference: TMF674 - Geographic Site Management  ")

						.version("4.0.0")

						.license(new License()

								.name("Apache 2.0")

								.url("http://openslice.io")))

				.externalDocs(new ExternalDocumentation()

						.description("TMF API Tables")

						.url("https://www.tmforum.org/oda/open-apis/table"));

	}



	@Bean

	public GroupedOpenApi gsm674(){



		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-674-Geographic Site Management-v4.0.0")

				.addOpenApiCustomizer( this.gsm674OpenAPI() )

				.packagesToScan("org.etsi.osl.tmf.gsm674.api")

				.build();



	}





	/**

src/main/java/org/etsi/osl/tmf/gsm674/api/ApiUtil.java

0 → 100644
+19 −0
Original line number Diff line number Diff line 
package org.etsi.osl.tmf.gsm674.api;



import jakarta.servlet.http.HttpServletResponse;

import org.springframework.web.context.request.NativeWebRequest;



import java.io.IOException;



public class ApiUtil {

    public static void setExampleResponse(NativeWebRequest req, String contentType, String example) {

        try {

            HttpServletResponse res = req.getNativeResponse(HttpServletResponse.class);

            res.setCharacterEncoding("UTF-8");

            res.addHeader("Content-Type", contentType);

            res.getWriter().print(example);

        } catch (IOException e) {

            throw new RuntimeException(e);

        }

    }

}

src/main/java/org/etsi/osl/tmf/gsm674/api/Generated.java

0 → 100644
+16 −0
Original line number Diff line number Diff line 
package org.etsi.osl.tmf.gsm674.api;



import java.lang.annotation.Documented;

import java.lang.annotation.Retention;

import java.lang.annotation.Target;



import static java.lang.annotation.ElementType.CONSTRUCTOR;

import static java.lang.annotation.ElementType.METHOD;

import static java.lang.annotation.ElementType.TYPE;

import static java.lang.annotation.RetentionPolicy.RUNTIME;



@Documented

@Retention(RUNTIME)

@Target({TYPE, METHOD, CONSTRUCTOR})

public @interface Generated {

}

src/main/java/org/etsi/osl/tmf/gsm674/api/GeographicSiteManagementApi.java

0 → 100644
+134 −0
Original line number Diff line number Diff line 
package org.etsi.osl.tmf.gsm674.api;



import com.fasterxml.jackson.databind.ObjectMapper;

import io.swagger.v3.oas.annotations.Operation;

import io.swagger.v3.oas.annotations.Parameter;

import io.swagger.v3.oas.annotations.responses.ApiResponse;

import io.swagger.v3.oas.annotations.responses.ApiResponses;

import jakarta.servlet.http.HttpServletRequest;

import jakarta.validation.Valid;



import org.etsi.osl.tmf.gsm674.model.GeographicSite;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.http.HttpStatus;

import org.springframework.http.ResponseEntity;

import org.springframework.security.access.prepost.PreAuthorize;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestBody;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RequestParam;



import java.io.IOException;

import java.security.Principal;

import java.util.List;

import java.util.Optional;



@Generated

public interface GeographicSiteManagementApi {

    Logger log = LoggerFactory.getLogger(GeographicSiteManagementApi.class);



    default Optional<ObjectMapper> getObjectMapper() {

        return Optional.empty();

    }



    default Optional<HttpServletRequest> getRequest() {

        return Optional.empty();

    }



    default Optional<String> getAcceptHeader() {

        return getRequest().map(r -> r.getHeader("Accept"));

    }



    @Operation(summary = "Creates a 'GeographicSite'", operationId = "createGeographicSite", description = "", tags={ "geographicSite", })

    @ApiResponses(value = {

            @ApiResponse(responseCode = "400", description = "Created" ),

            @ApiResponse(responseCode = "400", description = "Bad Request" ),

            @ApiResponse(responseCode = "401", description = "Unauthorized" ),

            @ApiResponse(responseCode = "403", description = "Forbidden" ),

            @ApiResponse(responseCode = "404", description = "Not Found" ),

            @ApiResponse(responseCode = "405", description = "Method Not allowed" ),

            @ApiResponse(responseCode = "409", description = "Conflict" ),

            @ApiResponse(responseCode = "500", description = "Internal Server Error" ) })

    @RequestMapping(value = "/geographicSite",

            produces = { "application/json" },

            consumes = { "application/json" },

            method = RequestMethod.POST)

    default ResponseEntity<GeographicSite> createGeographicSite(@Parameter(description = "The geographic site to be created" ,required=true )  @Valid @RequestBody GeographicSite geographicSite) {

        return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

    }



    @Operation(summary = "Deletes a 'GeographicSite' by Id", operationId = "deleteGeographicSite", description = "", tags={ "GeographicSite", })

    @ApiResponses(value = {

            @ApiResponse(responseCode = "204", description = "Deleted" ),

            @ApiResponse(responseCode = "400", description = "Bad Request" ),

            @ApiResponse(responseCode = "401", description = "Unauthorized" ),

            @ApiResponse(responseCode = "403", description = "Forbidden" ),

            @ApiResponse(responseCode = "404", description = "Not Found" ),

            @ApiResponse(responseCode = "405", description = "Method Not allowed" ),

            @ApiResponse(responseCode = "409", description = "Conflict" ),

            @ApiResponse(responseCode = "500", description = "Internal Server Error" ) })

    @RequestMapping(value = "/geographicSite/{id}",

            produces = { "application/json" },

            method = RequestMethod.DELETE)

    default ResponseEntity<Void> deleteGeographicSite(@Parameter(description = "Identifier of the Geographic site",required=true) @PathVariable("id") String id) {

        return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

    }





    @Operation(summary = "List or find 'GeographicSite' objects", operationId = "listGeographicSite", description = "" , tags={ "GeographicSite", })

    @ApiResponses(value = {

            @ApiResponse(responseCode ="200", description = "Ok" ),

            @ApiResponse(responseCode = "400", description = "Bad Request" ),

            @ApiResponse(responseCode = "401", description = "Unauthorized" ),

            @ApiResponse(responseCode = "403", description = "Forbidden" ),

            @ApiResponse(responseCode = "404", description = "Not Found" ),

            @ApiResponse(responseCode = "405", description = "Method Not allowed" ),

            @ApiResponse(responseCode = "409", description = "Conflict" ),

            @ApiResponse(responseCode = "500", description = "Internal Server Error" ) })

    @RequestMapping(value = "/geographicSite",

            produces = { "application/json" },

            method = RequestMethod.GET)

    default ResponseEntity<List<GeographicSite>> listGeographicSite() {

               return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

    }





    @Operation(summary = "Updates partially a 'GeographicSite' by Id", operationId = "patchGeographicSite", description = "", tags={ "GeographicSite", })

    @ApiResponses(value = {

            @ApiResponse(responseCode ="200", description = "Updated" ),

            @ApiResponse(responseCode = "400", description = "Bad Request" ),

            @ApiResponse(responseCode = "401", description = "Unauthorized" ),

            @ApiResponse(responseCode = "403", description = "Forbidden" ),

            @ApiResponse(responseCode = "404", description = "Not Found" ),

            @ApiResponse(responseCode = "405", description = "Method Not allowed" ),

            @ApiResponse(responseCode = "409", description = "Conflict" ),

            @ApiResponse(responseCode = "500", description = "Internal Server Error" ) })

    @RequestMapping(value = "/geographicSite/{id}",

            produces = { "application/json" },

            consumes = { "application/json" },

            method = RequestMethod.PATCH)

    default ResponseEntity<GeographicSite> patchGeographicalSite(@Parameter(description = "Identifier of the Geographic site",required=true) @PathVariable("id") String id,@Parameter(description = "The Service Level Specification to be updated" ,required=true )  @Valid @RequestBody GeographicSite geographicSite) {

        return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

    }





    @Operation(summary = "Retrieves a 'GeographicSite' by Id", operationId = "retrieveGeographicSite", description = "" , tags={ "GeographicSite", })

    @ApiResponses(value = {

            @ApiResponse(responseCode ="200", description = "Ok" ),

            @ApiResponse(responseCode = "400", description = "Bad Request" ),

            @ApiResponse(responseCode = "401", description = "Unauthorized" ),

            @ApiResponse(responseCode = "403", description = "Forbidden" ),

            @ApiResponse(responseCode = "404", description = "Not Found" ),

            @ApiResponse(responseCode = "405", description = "Method Not allowed" ),

            @ApiResponse(responseCode = "409", description = "Conflict" ),

            @ApiResponse(responseCode = "500", description = "Internal Server Error" ) })

    @RequestMapping(value = "/geographicSite/{id}",

            produces = { "application/json" },

            method = RequestMethod.GET)

    default ResponseEntity<GeographicSite> retrieveGeographicSite(@Parameter(description = "Identifier of the Geographic site",required=true) @PathVariable("id") String id) {

        return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

    }



}

src/main/java/org/etsi/osl/tmf/gsm674/api/GeographicSiteManagementApiController.java

0 → 100644
+106 −0
Original line number Diff line number Diff line 
package org.etsi.osl.tmf.gsm674.api;



import io.swagger.v3.oas.annotations.Parameter;

import jakarta.validation.Valid;

import org.etsi.osl.tmf.gsm674.model.GeographicSite;

import org.etsi.osl.tmf.gsm674.reposervices.GeographicSiteManagementService;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.http.HttpStatus;

import org.springframework.http.ResponseEntity;

import org.springframework.security.access.prepost.PreAuthorize;

import org.springframework.stereotype.Controller;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestBody;

import org.springframework.web.bind.annotation.RequestMapping;



import java.util.List;



@Controller

@RequestMapping("/geographicSiteManagement/v5/")

public class GeographicSiteManagementApiController implements GeographicSiteManagementApi{



    private static final String COULD_NOT_SERIALIZE="Couldn't serialize response for content type application/json";

    private final GeographicSiteManagementService geographicSiteManagementService;



    @Autowired

    public GeographicSiteManagementApiController(GeographicSiteManagementService geographicSiteManagementService) {

        this.geographicSiteManagementService = geographicSiteManagementService;

    }



    @PreAuthorize("hasAnyAuthority('ROLE_USER')" )

    @Override

    public ResponseEntity<List<GeographicSite>> listGeographicSite() {





        try {

            return new ResponseEntity<>(geographicSiteManagementService.findAllGeographicSites(), HttpStatus.OK);



        } catch (Exception e) {

            log.error(COULD_NOT_SERIALIZE, e);

            return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);

        }

    }



    @PreAuthorize("hasAnyAuthority('ROLE_USER')" )

    @Override

    public ResponseEntity<GeographicSite> retrieveGeographicSite(@PathVariable("id") String id) {





        try {

            return new ResponseEntity<>(geographicSiteManagementService.findGeographicSiteByUUID(id), HttpStatus.OK);



        } catch (Exception e) {

            log.error(COULD_NOT_SERIALIZE, e);

            return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);

        }

    }



    @PreAuthorize("hasAnyAuthority('ROLE_USER')" )

    @Override

    public ResponseEntity<GeographicSite> createGeographicSite(

            @Parameter(description = "The geographic site to be created", required = true) @Valid @RequestBody GeographicSite geographicSite

    ) {



        try {



            GeographicSite c = geographicSiteManagementService.createGeographicSite(geographicSite);



            return new ResponseEntity<>(c, HttpStatus.OK);





        } catch (Exception e) {

            log.error(COULD_NOT_SERIALIZE, e);

            return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);

        }

    }



    @PreAuthorize("hasAnyAuthority('ROLE_USER')" )

    @Override

    public ResponseEntity<Void> deleteGeographicSite(

            @Parameter(description = "Identifier of the geographic site", required = true) @PathVariable("id") String id) {



        try {

            return new ResponseEntity<>(geographicSiteManagementService.deleteGeographicSiteById(id), HttpStatus.OK);

        }catch (Exception e) {

            log.error(COULD_NOT_SERIALIZE, e);

            return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);

        }



    }





    @PreAuthorize("hasAnyAuthority('ROLE_USER')" )

    @Override

    public ResponseEntity<GeographicSite> patchGeographicalSite(

            @Parameter(description = "Identifier of the ServiceOrder", required = true) @PathVariable("id") String id,

            @Parameter(description = "The ServiceOrder to be updated", required = true) @Valid @RequestBody GeographicSite geographicSite) {

        try{

        GeographicSite c = geographicSiteManagementService.updateGeographicSite(id, geographicSite);



        return new ResponseEntity<>(c, HttpStatus.OK);

        }catch (Exception e){

            log.error(COULD_NOT_SERIALIZE, e);

            return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);

        }

    }

}