diff --git a/README.md b/README.md index 2f2dc61be9bff3c844290325e1c75d4b6f613734..f846b088a7eba6a0456bc1182a05c42ac49181cd 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,107 @@ -# Service Specification Export +```markdown +# ServiceSpecificationFetcher +## Overview +The `ServiceSpecificationFetcher` is a Java-based application designed to fetch hierarchical data from RESTful APIs. It starts with a given `ServiceSpecification` UUID and recursively retrieves related `ServiceSpecification` and `ResourceSpecification` objects, saving each as JSON files in a structured directory hierarchy. Attachments and LCM rule specifications are also fetched and saved, ensuring all related data is organized and stored appropriately. -## Getting started +## Prerequisites -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +- Java 17+ +- Maven +- Docker (optional, for containerized deployment) -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +## Configuration -## Add your files +The application requires a configuration file named `config.properties` with the following properties: -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://labs.etsi.org/rep/osl/utilities/service-specification-export.git -git branch -M main -git push -uf origin main +```ini +keycloak.url=http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token +client.id=osapiWebClientId +client.secret=admin +username=admin +password=admin +sourceApiEndpoint.url=http://localhost/tmf-api +serviceSpecification.uuid=487b9377-460d-4498-a8f3-a23cd7595b06 ``` -## Integrate with your tools - -- [ ] [Set up project integrations](https://labs.etsi.org/rep/osl/utilities/service-specification-export/-/settings/integrations) +## Building the Project -## Collaborate with your team +To build the project, use Maven: -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. +```sh +mvn clean install +``` -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) +## Running the Project -*** +To run the project, execute the following command: -# Editing this README +```sh +java -cp target/servicespecificationfetcher.jar org.osl.etsi.util.ServiceSpecificationFetcher +``` -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. +## Docker Deployment -## Suggestions for a good README -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. +### Building the Docker Image -## Name -Choose a self-explaining name for your project. +To build the Docker image, use the following command: -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. +```sh +docker build -t servicespecificationfetcher . +``` -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. +### Running the Docker Container -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. +To run the Docker container, use the following command, ensuring to mount the configuration file and data folder: -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +```sh +docker run -v /local/path/to/config.properties:/app/config.properties -v /local/path/to/your-data-folder:/app/data-folder servicespecificationfetcher uuid -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. +docker run -v C:\openslice\servicespecificationfetcher\src\main\resources\config.properties:/app/config.properties -v C:\openslice\servicespecificationfetcher:/app/data-folder servicespecificationfetcher f51cb185-6663-49e8-b195-83deeae32eed +``` -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +## File Hierarchy Structure -## Contributing -State if you are open to contributions and what your requirements are for accepting them. +The fetched data is saved in a structured directory hierarchy as follows: -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +``` +root_directory/ +├── serviceSpecificationId1/ +│ ├── serviceSpecificationId1.json +│ ├── serviceSpecificationLcmRules/ +│ │ ├── ruleId1.json +│ │ ├── ruleId2.json +│ │ └── ... +│ ├── serviceSpecificationServiceRelationships/ +│ │ ├── relatedServiceSpecificationId1/ +│ │ │ ├── relatedServiceSpecificationId1.json +│ │ │ ├── ... +│ │ └── ... +│ ├── serviceSpecificationResourceRelationships/ +│ │ ├── relatedResourceSpecificationId1/ +│ │ │ ├── relatedResourceSpecificationId1.json +│ │ │ ├── ... +│ │ └── ... +│ ├── attachments/ +│ │ ├── attachment1.ext +│ │ ├── attachment2.ext +│ │ └── ... +│ └── ... +├── serviceSpecificationId2/ +│ ├── serviceSpecificationId2.json +│ ├── ... +└── ... +``` -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. +## Error Handling & Logging -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +- **HTTP Errors**: An `IOException` is thrown for non-200 HTTP status codes. +- **JSON Parsing Errors**: Errors are caught and printed to the console. +- **Logging**: `System.out.println` is used for logging. ## License -For open source projects, say how it is licensed. -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +This project is licensed under the Apache Version 2.0 License. +``` \ No newline at end of file diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000000000000000000000000000000000000..a76a3906b3924cb686578a117c5904cc1ca3d77f --- /dev/null +++ b/pom.xml @@ -0,0 +1,101 @@ + + 4.0.0 + org.etsi.osl.util + servicespecificationfetcher + 0.0.1-SNAPSHOT + + + + 17 + 17 + + + + + + com.fasterxml.jackson.core + jackson-databind + 2.12.3 + + + + + org.slf4j + slf4j-api + 2.0.16 + + + + + + ch.qos.logback + logback-classic + 1.5.8 + + + + + + com.google.code.gson + gson + 2.8.6 + + + + + org.etsi.osl + org.etsi.osl.model.tmf + 1.0.0 + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.8.1 + + 17 + 17 + + + + org.apache.maven.plugins + maven-jar-plugin + 3.2.0 + + + + org.osl.etsi.util.ServiceSpecificationFetcher + + + + + + org.apache.maven.plugins + maven-shade-plugin + 3.4.1 + + + package + + shade + + + true + + + + org.osl.etsi.util.ServiceSpecificationFetcher + + + + + + + + + + diff --git a/src/main/java/org/osl/etsi/util/KeycloakAuthenticator.java b/src/main/java/org/osl/etsi/util/KeycloakAuthenticator.java new file mode 100644 index 0000000000000000000000000000000000000000..cfedbcdb39b52b4b0f63f70c11eafa5d664dcb1f --- /dev/null +++ b/src/main/java/org/osl/etsi/util/KeycloakAuthenticator.java @@ -0,0 +1,174 @@ +package org.osl.etsi.util; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import java.io.IOException; +import java.net.URI; +import java.net.URLEncoder; +import java.net.http.HttpClient; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.nio.charset.StandardCharsets; +import java.time.Instant; +import java.util.Properties; + +public class KeycloakAuthenticator { + + private static final Logger logger = LoggerFactory.getLogger(KeycloakAuthenticator.class.getName()); + + private final Properties config; + private final HttpClient client; + private final ObjectMapper objectMapper; + + private String currentToken; + private long tokenExpiryTime; + private long tokenRefreshBufferSeconds; + + /** + * Constructs a KeycloakAuthenticator with the specified configuration file path. + * + * @param configFilePath The file path to the configuration properties file. + * @throws IOException If there is an error loading the configuration file. + */ + public KeycloakAuthenticator(Properties config) throws IOException { + this.config = config; + this.client = HttpClient.newHttpClient(); + this.objectMapper = new ObjectMapper(); + setTokenRefreshBufferSeconds(); + } + + /** + * Loads the configuration properties from the specified file path. + * + * @param configFilePath The file path to the configuration properties file. + * @return The token refresh buffer time in seconds. + * @throws IOException If the configuration file cannot be read. + */ + private void setTokenRefreshBufferSeconds() throws IOException { + // Load the token refresh buffer time, defaulting to 60 seconds if not specified + String bufferSecondsStr = this.config.getProperty("token.refresh.buffer.seconds", "60"); + long bufferSeconds; + try { + bufferSeconds = Long.parseLong(bufferSecondsStr); + if (bufferSeconds < 0) { + throw new NumberFormatException("Buffer seconds cannot be negative."); + } + } catch (NumberFormatException ex) { + logger.warn("Invalid token.refresh.buffer.seconds value: " + bufferSecondsStr + ". Using default of 60 seconds."); + bufferSeconds = 60; + } + + logger.info("Token refresh buffer set to " + bufferSeconds + " seconds."); + this.tokenRefreshBufferSeconds=bufferSeconds; + } + + /** + * Retrieves a valid access token. If the current token is expired or not present, + * it authenticates with Keycloak to obtain a new one. + * + * @return A valid access token as a String. + * @throws IOException If an I/O error occurs during authentication. + * @throws InterruptedException If the HTTP request is interrupted. + */ + public synchronized String getToken() throws IOException, InterruptedException { + long currentEpochSeconds = Instant.now().getEpochSecond(); + + if (currentToken != null && currentEpochSeconds < (tokenExpiryTime - tokenRefreshBufferSeconds)) { + logger.info("Using cached token. Token expires at " + Instant.ofEpochSecond(tokenExpiryTime)); + return currentToken; + } else { + logger.info("Cached token is missing or nearing expiration. Authenticating to obtain a new token."); + return authenticateAndGetToken(); + } + } + + /** + * Authenticates with Keycloak and retrieves a new access token. + * + * @return The new access token as a String. + * @throws IOException If the authentication request fails. + * @throws InterruptedException If the HTTP request is interrupted. + */ + private String authenticateAndGetToken() throws IOException, InterruptedException { + String keycloakUrl = config.getProperty("keycloak.url"); + String clientId = config.getProperty("client.id"); + String clientSecret = config.getProperty("client.secret"); + String username = config.getProperty("username"); + String password = config.getProperty("password"); + + // Validate required properties + if (keycloakUrl == null || clientId == null || username == null || password == null) { + String errorMsg = "Missing required configuration properties."; + logger.error(errorMsg); + throw new IOException(errorMsg); + } + + // Build the form data with URL encoding + String form = buildFormData(clientId, clientSecret, username, password); + + HttpRequest request = HttpRequest.newBuilder() + .uri(URI.create(keycloakUrl)) + .header("Content-Type", "application/x-www-form-urlencoded") + .POST(HttpRequest.BodyPublishers.ofString(form)) + .build(); + + logger.info("Sending authentication request to Keycloak."); + + HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); + + if (response.statusCode() == 200) { + JsonNode responseJson = objectMapper.readTree(response.body()); + currentToken = responseJson.get("access_token").asText(); + long expiresIn = responseJson.get("expires_in").asLong(); + + tokenExpiryTime = Instant.now().getEpochSecond() + expiresIn; + logger.info("Authentication successful. Token obtained. Token expires in " + expiresIn + " seconds."); + + return currentToken; + } else { + String errorMsg = "Authentication failed: HTTP status " + response.statusCode() + ": " + response.body(); + logger.error(errorMsg); + throw new IOException(errorMsg); + } + } + + /** + * Builds the URL-encoded form data for the authentication request. + * + * @param clientId The client ID. + * @param clientSecret The client secret (optional). + * @param username The username. + * @param password The password. + * @return The URL-encoded form data as a String. + * @throws IOException If URL encoding fails. + */ + private String buildFormData(String clientId, String clientSecret, String username, String password) throws IOException { + StringBuilder form = new StringBuilder(); + form.append("client_id=").append(urlEncode(clientId)); + if (clientSecret != null && !clientSecret.isEmpty()) { + form.append("&client_secret=").append(urlEncode(clientSecret)); + } + form.append("&username=").append(urlEncode(username)); + form.append("&password=").append(urlEncode(password)); + form.append("&grant_type=password"); + return form.toString(); + } + + /** + * URL-encodes a string using UTF-8 encoding. + * + * @param value The string to encode. + * @return The URL-encoded string. + * @throws IOException If UTF-8 encoding is not supported. + */ + private String urlEncode(String value) throws IOException { + try { + return URLEncoder.encode(value, StandardCharsets.UTF_8.toString()); + } catch (Exception ex) { + logger.error("URL encoding failed for value: " + value, ex); + throw new IOException("URL encoding failed.", ex); + } + } +} diff --git a/src/main/java/org/osl/etsi/util/ServiceSpecificationFetcher.java b/src/main/java/org/osl/etsi/util/ServiceSpecificationFetcher.java new file mode 100644 index 0000000000000000000000000000000000000000..d52f3081ab57dbb1fa21a65985bb0a6baad0fdd1 --- /dev/null +++ b/src/main/java/org/osl/etsi/util/ServiceSpecificationFetcher.java @@ -0,0 +1,398 @@ +package org.osl.etsi.util; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; + +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.net.URI; +import java.net.http.HttpClient; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.nio.file.Files; +import java.util.*; + +import org.etsi.osl.tmf.common.model.AttachmentRef; +import org.etsi.osl.tmf.common.model.AttachmentRefOrValue; +import org.etsi.osl.tmf.common.model.service.ServiceSpecificationRef; +import org.etsi.osl.tmf.lcm.model.LCMRuleSpecification; +import org.etsi.osl.tmf.rcm634.model.LogicalResourceSpecification; +import org.etsi.osl.tmf.rcm634.model.PhysicalResourceSpecification; +import org.etsi.osl.tmf.rcm634.model.ResourceSpecification; +import org.etsi.osl.tmf.rcm634.model.ResourceSpecificationRef; +import org.etsi.osl.tmf.rcm634.model.ResourceSpecificationRelationship; +import org.etsi.osl.tmf.scm633.model.ServiceSpecRelationship; +import org.etsi.osl.tmf.scm633.model.ServiceSpecification; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class ServiceSpecificationFetcher { + private static final Logger logger = LoggerFactory.getLogger(ServiceSpecificationFetcher.class); + private static final HttpClient client = HttpClient.newHttpClient(); + private static final ObjectMapper objectMapper = new ObjectMapper(); + private static String apiEndpoint=null; + private static KeycloakAuthenticator keycloakAuthenticator = null; + private static final Properties config = new Properties(); + private static String configFilePath = null; + + public static void main(String[] args) throws IOException { + String serviceSpecUUid = null; + // Parse command-line arguments + for (int i = 0; i < args.length; i++) { + switch (args[i]) { + case "--configfile": + if (i + 1 < args.length) { + configFilePath = args[++i]; + logger.info("Config file path set to: " + configFilePath); + try (InputStream input = new FileInputStream(configFilePath)) { + config.load(input); + apiEndpoint = config.getProperty("sourceApiEndpoint.url"); + logger.info("Configuration loaded successfully from " + configFilePath); + } catch (IOException ex) { + logger.error("Failed to load configuration from " + configFilePath, ex); + throw ex; + } + keycloakAuthenticator= new KeycloakAuthenticator(config); + } else { + logger.error("Missing value for --configfile"); + printUsageAndExit(); + } + break; + case "--servicespecuuid": + if (i + 1 < args.length) { + serviceSpecUUid = args[++i]; + logger.info("Service spec uuid set to: " + serviceSpecUUid); + } else { + logger.error("Missing value for --servicespecuuid"); + printUsageAndExit(); + } + break; + default: + logger.error("Unknown argument: " + args[i]); + printUsageAndExit(); + } + } + + // Validate required arguments + if (configFilePath == null || serviceSpecUUid == null) { + logger.error("Missing required arguments."); + printUsageAndExit(); + } + + // Continue with the rest of your application logic + logger.info("Application started successfully with provided configurations."); + try { + fetchServiceSpecification(serviceSpecUUid, null); + logger.info("All data has been fetched and saved hierarchically."); + } catch (IOException | InterruptedException e) { + e.printStackTrace(); + } + } + + /** + * Prints usage instructions and exits the application. + */ + private static void printUsageAndExit() { + String usage = "Usage:\n" + + " java -jar servicespecificationfetcher.jar --configfile /path/to/config.yaml --servicespecuuid servicespecuuid\n\n" + + "Parameters:\n" + + " --configfile Path to the configuration file.\n" + + " --servicespecuuid Path to the service specification uuid."; + logger.info(usage); + System.exit(1); + } + + private static ServiceSpecification fetchServiceSpecification(String uuid, File parentDirectory) throws IOException, InterruptedException { + String url = apiEndpoint + "/serviceCatalogManagement/v4/serviceSpecification/" + uuid; + HttpRequest request = HttpRequest.newBuilder() + .uri(URI.create(url)) + .GET() + .build(); + HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); + + if (response.statusCode() != 200) { + throw new IOException("Failed to get a valid response for "+url+". HTTP status code: " + response.statusCode()); + } + + if (response.body() == null || response.body().isEmpty()) { + logger.error("No content to map for URL: " + url); + return null; + } + + ServiceSpecification serviceSpecification = objectMapper.readValue(response.body(), ServiceSpecification.class); + if (serviceSpecification != null && serviceSpecification.getId() != null) { + logger.info("ServiceSpecification found. Creating folder " + serviceSpecification.getId()); + File serviceSpecificationFolder = new File(parentDirectory, serviceSpecification.getId()); + if (!serviceSpecificationFolder.exists()) { + serviceSpecificationFolder.mkdirs(); + } + saveJsonToFile(serviceSpecification, serviceSpecificationFolder, serviceSpecification.getId() + ".json"); + fetchAndSaveAttachments(serviceSpecification, serviceSpecificationFolder); + fetchLCMRuleSpecification(uuid, serviceSpecificationFolder); + + File relationshipDir = new File(serviceSpecificationFolder, "serviceSpecificationServiceRelationships"); + if (!relationshipDir.exists()) { + relationshipDir.mkdirs(); + } + + if (serviceSpecification.getServiceSpecRelationship() != null) { + for (ServiceSpecRelationship serviceRelationship : serviceSpecification.getServiceSpecRelationship()) { + fetchServiceSpecification(serviceRelationship.getId(), relationshipDir); + } + } + + logger.info("Creating serviceSpecificationResourceRelationships folder for "+serviceSpecification.getId()); + + File resourceRelationshipDir = new File(serviceSpecificationFolder, "serviceSpecificationResourceRelationships"); + if (!resourceRelationshipDir.exists()) { + resourceRelationshipDir.mkdirs(); + } + + if (serviceSpecification.getResourceSpecification()!= null) { + logger.info("Resource Relationships for "+serviceSpecification.getId()+" found!"); + + for (ResourceSpecificationRef resourceRelationship : serviceSpecification.getResourceSpecification()) { + String relatedUrl = apiEndpoint + "/resourceCatalogManagement/v4/resourceSpecification/" + resourceRelationship.getId(); // Now using getId() + logger.info("Fetching from "+relatedUrl); + fetchResourceSpecification(relatedUrl, resourceRelationshipDir); + } + } + else + { + logger.info("Resource Relationships for "+serviceSpecification.getId()+" NOT found!"); + + } + } + return serviceSpecification; + } + + private static void fetchLCMRuleSpecification(String serviceSpecId, File parentDirectory) throws IOException, InterruptedException { + String url = apiEndpoint + "/lcmrulesmanagement/v1/lcmRuleSpecification/serviceSpec/" + serviceSpecId; + String token = keycloakAuthenticator.getToken(); + HttpRequest request = HttpRequest.newBuilder() + .uri(URI.create(url)) + .header("Authorization", "Bearer " + token) + .GET() + .build(); + HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); + + if (response.statusCode() != 200) { + throw new IOException("Failed to get a valid response for "+url+". HTTP status code: " + response.statusCode()); + } + + File lcmRulesDirectory = new File(parentDirectory, "serviceSpecificationLcmRules"); + if (!lcmRulesDirectory.exists()) { + lcmRulesDirectory.mkdirs(); + } + + try { + List ruleIds = parseJsonForIds(response.body()); + if (ruleIds != null && !ruleIds.isEmpty()) { + // Save a list of rule IDs to a file, assuming this is still required + //saveJsonToFile(ruleIds, new File(parentDirectory, serviceSpecId + "-lcmRuleIds.json")); + saveJsonToFile(response.body(), new File(parentDirectory, serviceSpecId + "-lcmRuleIds.json")); + + // Iterate over each ID to fetch and save detailed rule information + for (String ruleId : ruleIds) { + fetchAndSaveDetailedRule(ruleId, lcmRulesDirectory); + } + } + } catch (IOException e) { + e.printStackTrace(); + } + } + + private static void fetchAndSaveDetailedRule(String ruleId, File parentDirectory) throws IOException, InterruptedException { + String ruleUrl = apiEndpoint + "/lcmrulesmanagement/v1/lcmRuleSpecification/" + ruleId; + String token = keycloakAuthenticator.getToken(); + HttpRequest detailedRequest = HttpRequest.newBuilder() + .uri(URI.create(ruleUrl)) + .header("Authorization", "Bearer " + token) + .GET() + .build(); + HttpResponse detailedResponse = client.send(detailedRequest, HttpResponse.BodyHandlers.ofString()); + + if (detailedResponse.statusCode() != 200) { + logger.error("Failed to get a valid response for rule ID: " + ruleId + " HTTP status code: " + detailedResponse.statusCode()); + return; + } + LCMRuleSpecification detailedRule = objectMapper.readValue(detailedResponse.body(), LCMRuleSpecification.class); + detailedRule.setServiceSpecs(new HashSet()); + File ruleFile = new File(parentDirectory, ruleId + ".json"); + saveJsonToFile(detailedRule, ruleFile); + } + + private static ResourceSpecification fetchResourceSpecification(String url, File parentDirectory) throws IOException, InterruptedException { + HttpRequest request = HttpRequest.newBuilder() + .uri(URI.create(url)) + .GET() + .build(); + HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); + + if (response.statusCode() != 200) { + throw new IOException("Failed to get a valid response. HTTP status code: " + response.statusCode()); + } + + if (response.body() == null || response.body().isEmpty()) { + logger.error("No content to map for URL: " + url); + return null; + } + + ResourceSpecification resSpec = null; + try { + JsonNode rootNode = objectMapper.readTree(response.body()); + JsonNode typeNode = rootNode.get("@type"); + + if (typeNode != null) { + String type = typeNode.asText(); + ObjectMapper objectMapper = new ObjectMapper(); + if ("LogicalResourceSpecification".equals(type)) { + resSpec = objectMapper.readValue(response.body(), LogicalResourceSpecification.class); + logger.info("The JSON contains a LogicalResourceSpecification."); + } else if ("PhysicalResourceSpecification".equals(type)) { + resSpec = objectMapper.readValue(response.body(), PhysicalResourceSpecification.class); + logger.info("The JSON contains a PhysicalResourceSpecification."); + } else { + logger.info("The JSON contains an unknown type: " + type); + } + } else { + logger.info("The JSON does not contain a @type field."); + } + } catch (IOException e) { + e.printStackTrace(); + } + + if (resSpec != null && resSpec.getId() != null) { + logger.info("Creating "+resSpec.getId()+" folder!"); + //logger.info("Creating "+resSpec.getName()+" folder!"); + File resourceSpecificationFolder = new File(parentDirectory, resSpec.getId()); + //File resourceSpecificationFolder = new File(parentDirectory, resSpec.getName()); + if (!resourceSpecificationFolder.exists()) { + resourceSpecificationFolder.mkdirs(); + } + saveResourceSpecificationJsonToFile(resSpec, resourceSpecificationFolder, resSpec.getId() + ".json"); + //saveResourceSpecificationJsonToFile(resSpec, resourceSpecificationFolder, resSpec.getName() + ".json"); + fetchAndSaveAttachments(resSpec, resourceSpecificationFolder); + + File relationshipDir = new File(resourceSpecificationFolder, "resourceSpecificationResourceRelationships"); + if (!relationshipDir.exists()) { + relationshipDir.mkdirs(); + } + + if (resSpec.getResourceSpecRelationship()!= null) { + logger.info("Resource Relationships for "+resSpec.getId()+" found!"); + //logger.info("Resource Relationships for "+resSpec.getName()+" found!"); + for (ResourceSpecificationRelationship relationship : resSpec.getResourceSpecRelationship()) { + String relatedUrl = apiEndpoint + "/resourceCatalogManagement/v4/resourceSpecification/" + relationship.getId(); // Now using getId() + fetchResourceSpecification(relatedUrl, relationshipDir); + } + } + else + { + logger.info("Resource Relationships for "+resSpec.getId()+" NOT found!"); + + } + } + else + { + logger.info("resSpec != null && resSpec.getId() != null"); + } + return resSpec; + } + + // Method for ServiceSpecifications + private static void fetchAndSaveAttachments(ServiceSpecification spec, File parentFolder) throws IOException, InterruptedException { + if (spec.getAttachment() != null) { + for (AttachmentRef attachment : spec.getAttachment()) { + String attachmentUrl = attachment.getUrl(); + HttpRequest attachmentRequest = HttpRequest.newBuilder() + .uri(URI.create(apiEndpoint + attachmentUrl)) // Assuming the base URL needs to be prefixed + .GET() + .build(); + HttpResponse attachmentResponse = client.send(attachmentRequest, HttpResponse.BodyHandlers.ofByteArray()); + + if (attachmentResponse.statusCode() == 200) { + String relativePath = extractRelativePath(attachmentUrl); + File attachmentDir = new File(parentFolder, relativePath.substring(0, relativePath.lastIndexOf('/'))); + if (!attachmentDir.exists()) { + attachmentDir.mkdirs(); // Make sure the directory structure exists + } + File attachmentFile = new File(attachmentDir, relativePath.substring(relativePath.lastIndexOf('/') + 1)); + Files.write(attachmentFile.toPath(), attachmentResponse.body()); + logger.info("Attachment saved to " + attachmentFile.getPath()); + } else { + logger.info("Failed to fetch attachment at " + attachmentUrl); + } + } + } + } + + // Overloaded method for ResourceSpecifications + private static void fetchAndSaveAttachments(ResourceSpecification spec, File parentFolder) throws IOException, InterruptedException { + if (spec.getAttachment() != null) { + for (AttachmentRefOrValue attachment : spec.getAttachment()) { + String attachmentUrl = attachment.getUrl(); + HttpRequest attachmentRequest = HttpRequest.newBuilder() + .uri(URI.create(apiEndpoint + attachmentUrl)) // Assuming the base URL needs to be prefixed + .GET() + .build(); + HttpResponse attachmentResponse = client.send(attachmentRequest, HttpResponse.BodyHandlers.ofByteArray()); + + if (attachmentResponse.statusCode() == 200) { + String relativePath = extractRelativePath(attachmentUrl); + File attachmentDir = new File(parentFolder, relativePath.substring(0, relativePath.lastIndexOf('/'))); + if (!attachmentDir.exists()) { + attachmentDir.mkdirs(); // Make sure the directory structure exists + } + File attachmentFile = new File(attachmentDir, relativePath.substring(relativePath.lastIndexOf('/') + 1)); + Files.write(attachmentFile.toPath(), attachmentResponse.body()); + logger.info("Attachment saved to " + attachmentFile.getPath()); + } else { + logger.info("Failed to fetch attachment at " + attachmentUrl); + } + } + } + } + + public static List parseJsonForIds(String json) throws IOException { + // Parse the JSON string into a JsonNode + JsonNode rootNode = objectMapper.readTree(json); + List ids = new ArrayList<>(); + + // Check if the root node is an array and iterate over it + if (rootNode.isArray()) { + for (JsonNode node : rootNode) { + // Extract the id from each object in the array + String id = node.get("id").asText(); + ids.add(id); + } + } + + return ids; + } + + private static String extractRelativePath(String url) { + URI uri = URI.create(url); + String path = uri.getPath(); + return path.substring(path.indexOf("/attachment/") + 1); // Extract the path after "/serviceSpecification/" + } + + private static void saveJsonToFile(ServiceSpecification spec, File parentFolder, String filename) throws IOException { + File file = new File(parentFolder, filename); + objectMapper.writerWithDefaultPrettyPrinter().writeValue(file, spec); + logger.info("Saved JSON to " + file.getPath()); + } + + private static void saveJsonToFile(Object data, File file) throws IOException { + objectMapper.writerWithDefaultPrettyPrinter().writeValue(file, data); + logger.info("Saved JSON to " + file.getPath()); + } + + private static void saveResourceSpecificationJsonToFile(ResourceSpecification spec, File parentFolder, String filename) throws IOException { + File file = new File(parentFolder, filename); + objectMapper.writerWithDefaultPrettyPrinter().writeValue(file, spec); + logger.info("Saved JSON to " + file.getPath()); + } +} diff --git a/src/main/resources/Dockerfile b/src/main/resources/Dockerfile new file mode 100644 index 0000000000000000000000000000000000000000..594b20d7ff39b02cc928f6f536fe37b0d076642b --- /dev/null +++ b/src/main/resources/Dockerfile @@ -0,0 +1,17 @@ +# Select a base image with Java installed +FROM openjdk:17-slim + +# Set the working directory +WORKDIR /app + +# Copy the executable jar file of the application to the image +COPY servicespecificationfetcher-0.0.1-SNAPSHOT.jar /app/servicespecificationfetcher.jar + +# Set the command that will run when the container starts +# Note: Pass the data folder path as an environment variable or argument during runtime. + +# Example command to pass data folder as a runtime argument: +# docker run -v /local/path/to/config.properties:/app/config.properties -v /local/path/to/your-data-folder:/app/data-folder your-image uuid + +# Updated CMD to accept runtime arguments for data folder +ENTRYPOINT ["sh", "-c", "java -jar /app/servicespecificationfetcher.jar --configfile /app/config.properties --servicespecuuid $0"] \ No newline at end of file diff --git a/src/main/resources/config.properties b/src/main/resources/config.properties new file mode 100644 index 0000000000000000000000000000000000000000..e10c7c457102c5f315effdb5ff64b5552d16fae2 --- /dev/null +++ b/src/main/resources/config.properties @@ -0,0 +1,7 @@ +keycloak.url=http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token +client.id=osapiWebClientId +client.secret=admin +username=admin +password=admin +sourceApiEndpoint.url=http://localhost/tmf-api +serviceSpecification.uuid=487b9377-460d-4498-a8f3-a23cd7595b06 \ No newline at end of file diff --git a/src/main/resources/logback.xml b/src/main/resources/logback.xml new file mode 100644 index 0000000000000000000000000000000000000000..e5a0c7c8e0db4a0884c2392cc501edc7801a4b03 --- /dev/null +++ b/src/main/resources/logback.xml @@ -0,0 +1,20 @@ + + + + %d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n + + + + + app.log + true + + %d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n + + + + + + + + \ No newline at end of file