-
Notifications
You must be signed in to change notification settings - Fork 271
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Port json schema dereferencing (#5312)
- Loading branch information
1 parent
7685240
commit 4b5e37d
Showing
71 changed files
with
1,356 additions
and
428 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
133 changes: 0 additions & 133 deletions
133
app/src/main/java/io/apicurio/registry/rest/v2/AbstractResourceImpl.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,143 +1,10 @@ | ||
| package io.apicurio.registry.rest.v2; | ||
|
|
||
| import io.apicurio.common.apps.config.Info; | ||
| import io.apicurio.registry.content.TypedContent; | ||
| import io.apicurio.registry.content.dereference.ContentDereferencer; | ||
| import io.apicurio.registry.content.refs.JsonPointerExternalReference; | ||
| import io.apicurio.registry.storage.RegistryStorage; | ||
| import io.apicurio.registry.storage.dto.ArtifactReferenceDto; | ||
| import io.apicurio.registry.types.Current; | ||
| import io.apicurio.registry.types.provider.ArtifactTypeUtilProvider; | ||
| import io.apicurio.registry.types.provider.ArtifactTypeUtilProviderFactory; | ||
| import io.apicurio.registry.utils.StringUtil; | ||
| import jakarta.inject.Inject; | ||
| import jakarta.servlet.http.HttpServletRequest; | ||
| import jakarta.ws.rs.core.Context; | ||
| import org.eclipse.microprofile.config.inject.ConfigProperty; | ||
| import org.slf4j.Logger; | ||
|
|
||
| import java.net.URI; | ||
| import java.net.URISyntaxException; | ||
| import java.net.URLEncoder; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| public abstract class AbstractResourceImpl { | ||
|
|
||
| @Inject | ||
| Logger log; | ||
|
|
||
| @Inject | ||
| @Current | ||
| RegistryStorage storage; | ||
|
|
||
| @Inject | ||
| ArtifactTypeUtilProviderFactory factory; | ||
|
|
||
| @Context | ||
| HttpServletRequest request; | ||
|
|
||
| @ConfigProperty(name = "apicurio.apis.v2.base-href", defaultValue = "_") | ||
| @Info(category = "api", description = "API base href (URI)", availableSince = "2.5.0.Final") | ||
| String apiBaseHref; | ||
|
|
||
| /** | ||
| * Handle the content references based on the value of "dereference" - this can mean we need to fully | ||
| * dereference the content. | ||
| * | ||
| * @param dereference | ||
| * @param content | ||
| */ | ||
| protected TypedContent handleContentReferences(boolean dereference, String artifactType, | ||
| TypedContent content, List<ArtifactReferenceDto> references) { | ||
| // Dereference or rewrite references | ||
| if (!references.isEmpty() && dereference) { | ||
| ArtifactTypeUtilProvider artifactTypeProvider = factory.getArtifactTypeProvider(artifactType); | ||
| ContentDereferencer contentDereferencer = artifactTypeProvider.getContentDereferencer(); | ||
| Map<String, TypedContent> resolvedReferences = storage.resolveReferences(references); | ||
| content = contentDereferencer.dereference(content, resolvedReferences); | ||
| } | ||
| return content; | ||
| } | ||
|
|
||
| /** | ||
| * Convert the list of references into a list of REST API URLs that point to the content. This means that | ||
| * we generate a REST API URL from the GAV (groupId, artifactId, version) information found in each | ||
| * reference. | ||
| * | ||
| * @param references | ||
| */ | ||
| protected Map<String, String> resolveReferenceUrls(List<ArtifactReferenceDto> references) { | ||
| Map<String, String> rval = new HashMap<>(); | ||
| for (ArtifactReferenceDto reference : references) { | ||
| String resolvedReferenceUrl = resolveReferenceUrl(reference); | ||
| if (reference.getName().contains("#")) { | ||
| JsonPointerExternalReference jpRef = new JsonPointerExternalReference(reference.getName()); | ||
| resolvedReferenceUrl = resolvedReferenceUrl + jpRef.getComponent(); | ||
| } | ||
| if (resolvedReferenceUrl != null) { | ||
| rval.put(reference.getName(), resolvedReferenceUrl); | ||
| } | ||
| } | ||
| return rval; | ||
| } | ||
|
|
||
| /** | ||
| * Convert a single artifact reference to a REST API URL. This means that we generate a REST API URL from | ||
| * the GAV (groupId, artifactId, version) information found in the reference. | ||
| * | ||
| * @param reference | ||
| */ | ||
| protected String resolveReferenceUrl(ArtifactReferenceDto reference) { | ||
| URI baseHref = null; | ||
| try { | ||
| if (!"_".equals(apiBaseHref)) { | ||
| baseHref = new URI(apiBaseHref); | ||
| } else { | ||
| baseHref = getApiBaseHrefFromXForwarded(request); | ||
| if (baseHref == null) { | ||
| baseHref = getApiBaseHrefFromRequest(request); | ||
| } | ||
| } | ||
| } catch (URISyntaxException e) { | ||
| this.log.error("Error trying to determine the baseHref of the REST API.", e); | ||
| return null; | ||
| } | ||
|
|
||
| if (baseHref == null) { | ||
| this.log.warn("Failed to determine baseHref for the REST API."); | ||
| return null; | ||
| } | ||
|
|
||
| String path = String.format("/apis/registry/v2/groups/%s/artifacts/%s/versions/%s?references=REWRITE", | ||
| URLEncoder.encode(reference.getGroupId(), StandardCharsets.UTF_8), | ||
| URLEncoder.encode(reference.getArtifactId(), StandardCharsets.UTF_8), | ||
| URLEncoder.encode(reference.getVersion(), StandardCharsets.UTF_8)); | ||
| return baseHref.resolve(path).toString(); | ||
| } | ||
|
|
||
| /** | ||
| * Resolves a host name from the information found in X-Forwarded-Host and X-Forwarded-Proto. | ||
| */ | ||
| private static URI getApiBaseHrefFromXForwarded(HttpServletRequest request) throws URISyntaxException { | ||
| String fproto = request.getHeader("X-Forwarded-Proto"); | ||
| String fhost = request.getHeader("X-Forwarded-Host"); | ||
| if (!StringUtil.isEmpty(fproto) && !StringUtil.isEmpty(fhost)) { | ||
| return new URI(fproto + "://" + fhost); | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Resolves a host name from the request information. | ||
| */ | ||
| private static URI getApiBaseHrefFromRequest(HttpServletRequest request) throws URISyntaxException { | ||
| String requestUrl = request.getRequestURL().toString(); | ||
| URI requestUri = new URI(requestUrl); | ||
| return requestUri.resolve("/"); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.