Java tutorial
/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you 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. */ package org.apache.syncope.core.rest.cxf; import io.swagger.jaxrs.listing.SwaggerSerializers; import io.swagger.models.HttpMethod; import io.swagger.models.Operation; import io.swagger.models.Path; import io.swagger.models.Swagger; import io.swagger.models.Tag; import io.swagger.models.parameters.HeaderParameter; import java.io.IOException; import java.io.OutputStream; import java.lang.annotation.Annotation; import java.lang.reflect.Type; import java.util.ArrayList; import java.util.Collections; import java.util.Comparator; import java.util.HashMap; import java.util.List; import java.util.Map; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.MultivaluedMap; import org.apache.commons.collections4.ComparatorUtils; import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.tuple.ImmutablePair; import org.apache.commons.lang3.tuple.Pair; import org.apache.cxf.jaxrs.ext.MessageContext; import org.apache.cxf.jaxrs.model.ClassResourceInfo; import org.apache.cxf.jaxrs.model.OperationResourceInfo; import org.apache.cxf.jaxrs.model.doc.DocumentationProvider; import org.apache.cxf.jaxrs.utils.JAXRSUtils; import org.apache.syncope.common.lib.SyncopeConstants; import org.apache.syncope.common.rest.api.RESTHeaders; import org.apache.syncope.core.persistence.api.DomainsHolder; import org.apache.syncope.core.spring.ApplicationContextProvider; public class ExtendedSwagger2Serializers extends SwaggerSerializers implements Swagger2Serializers { protected boolean dynamicBasePath; protected boolean replaceTags; protected DocumentationProvider javadocProvider; protected List<ClassResourceInfo> cris; protected final List<String> domains = new ArrayList<>(); public ExtendedSwagger2Serializers() { super(); domains.addAll(ApplicationContextProvider.getApplicationContext().getBean(DomainsHolder.class).getDomains() .keySet()); } @Override public void setDynamicBasePath(final boolean dynamicBasePath) { this.dynamicBasePath = dynamicBasePath; } @Override public void setReplaceTags(final boolean replaceTags) { this.replaceTags = replaceTags; } @Override public void setJavadocProvider(final DocumentationProvider javadocProvider) { this.javadocProvider = javadocProvider; } @Override public void setClassResourceInfos(final List<ClassResourceInfo> classResourceInfos) { this.cris = classResourceInfos; } @Override public void writeTo(final Swagger data, final Class<?> type, final Type genericType, final Annotation[] annotations, final MediaType mediaType, final MultivaluedMap<String, Object> headers, final OutputStream out) throws IOException { if (dynamicBasePath) { MessageContext ctx = JAXRSUtils.createContextValue(JAXRSUtils.getCurrentMessage(), null, MessageContext.class); data.setBasePath(StringUtils.substringBeforeLast(ctx.getHttpServletRequest().getRequestURI(), "/")); } if (replaceTags || javadocProvider != null) { Map<String, ClassResourceInfo> operations = new HashMap<>(); Map<Pair<String, String>, OperationResourceInfo> methods = new HashMap<>(); for (ClassResourceInfo cri : cris) { for (OperationResourceInfo ori : cri.getMethodDispatcher().getOperationResourceInfos()) { String normalizedPath = getNormalizedPath(cri.getURITemplate().getValue(), ori.getURITemplate().getValue()); operations.put(normalizedPath, cri); methods.put(ImmutablePair.of(ori.getHttpMethod(), normalizedPath), ori); } } if (replaceTags && data.getTags() != null) { data.getTags().clear(); } for (final Map.Entry<String, Path> entry : data.getPaths().entrySet()) { Tag tag = null; if (replaceTags && operations.containsKey(entry.getKey())) { ClassResourceInfo cri = operations.get(entry.getKey()); tag = new Tag(); tag.setName(cri.getURITemplate().getValue()); if (javadocProvider != null) { tag.setDescription(javadocProvider.getClassDoc(cri)); } data.addTag(tag); } for (Map.Entry<HttpMethod, Operation> subentry : entry.getValue().getOperationMap().entrySet()) { if (replaceTags && tag != null) { subentry.getValue().setTags(Collections.singletonList(tag.getName())); } Pair<String, String> key = ImmutablePair.of(subentry.getKey().name(), entry.getKey()); if (methods.containsKey(key) && javadocProvider != null) { OperationResourceInfo ori = methods.get(key); subentry.getValue().setSummary(javadocProvider.getMethodDoc(ori)); boolean domainHeaderParameterFound = false; for (int i = 0; i < subentry.getValue().getParameters().size(); i++) { subentry.getValue().getParameters().get(i) .setDescription(javadocProvider.getMethodParameterDoc(ori, i)); if (subentry.getValue().getParameters().get(i) instanceof HeaderParameter && RESTHeaders.DOMAIN .equals(subentry.getValue().getParameters().get(i).getName())) { domainHeaderParameterFound = true; } } if (!domainHeaderParameterFound) { HeaderParameter domainHeaderParameter = new HeaderParameter(); domainHeaderParameter.setName(RESTHeaders.DOMAIN); domainHeaderParameter.setRequired(true); domainHeaderParameter.setType("string"); domainHeaderParameter.setEnum(domains); domainHeaderParameter.setDefault(SyncopeConstants.MASTER_DOMAIN); subentry.getValue().getParameters().add(domainHeaderParameter); } if (subentry.getValue().getResponses() != null && !subentry.getValue().getResponses().isEmpty()) { subentry.getValue().getResponses().entrySet().iterator().next().getValue() .setDescription(javadocProvider.getMethodResponseDoc(ori)); } } } } } if (replaceTags && data.getTags() != null) { Collections.sort(data.getTags(), new Comparator<Tag>() { @Override public int compare(final Tag tag1, final Tag tag2) { return ComparatorUtils.<String>naturalComparator().compare(tag1.getName(), tag2.getName()); } }); } super.writeTo(data, type, genericType, annotations, mediaType, headers, out); } protected String getNormalizedPath(final String classResourcePath, final String operationResourcePath) { StringBuilder normalizedPath = new StringBuilder(); String[] segments = org.apache.commons.lang3.StringUtils.split(classResourcePath + operationResourcePath, "/"); for (String segment : segments) { if (!org.apache.commons.lang3.StringUtils.isEmpty(segment)) { normalizedPath.append("/").append(segment); } } // Adapt to Swagger's path expression if (normalizedPath.toString().endsWith(":.*}")) { normalizedPath.setLength(normalizedPath.length() - 4); normalizedPath.append('}'); } return StringUtils.EMPTY.equals(normalizedPath.toString()) ? "/" : normalizedPath.toString(); } }