| /** |
| * 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.cxf.jaxrs.swagger; |
| |
| import java.net.URL; |
| import java.net.URLClassLoader; |
| import java.util.ArrayList; |
| import java.util.List; |
| |
| import org.apache.commons.lang3.StringUtils; |
| import org.apache.cxf.Bus; |
| import org.apache.cxf.common.util.PackageUtils; |
| import org.apache.cxf.endpoint.Server; |
| import org.apache.cxf.feature.AbstractFeature; |
| import org.apache.cxf.jaxrs.JAXRSServiceFactoryBean; |
| import org.apache.cxf.jaxrs.model.ClassResourceInfo; |
| |
| public abstract class AbstractSwaggerFeature extends AbstractFeature { |
| |
| protected static final String SWAGGER_UI_RESOURCE_ROOT; |
| private static final boolean SWAGGER_JAXRS_AVAILABLE; |
| |
| static { |
| SWAGGER_JAXRS_AVAILABLE = isSwaggerJaxRsAvailable(); |
| SWAGGER_UI_RESOURCE_ROOT = checkSwaggerUiResourceRoot(); |
| } |
| |
| protected boolean scan = true; |
| protected boolean runAsFilter; |
| private boolean activateOnlyIfJaxrsSupported; |
| private String resourcePackage; |
| private String version = "1.0.0"; |
| // depending on swagger version basePath is set differently |
| private String basePath; |
| private String title = "Sample REST Application"; |
| private String description = "The Application"; |
| private String contact = "users@cxf.apache.org"; |
| private String license = "Apache 2.0 License"; |
| private String licenseUrl = "http://www.apache.org/licenses/LICENSE-2.0.html"; |
| private String termsOfServiceUrl; |
| private String filterClass; |
| |
| private static boolean isSwaggerJaxRsAvailable() { |
| try { |
| Class.forName("io.swagger.jaxrs.DefaultParameterExtension"); |
| return true; |
| } catch (Throwable ex) { |
| return false; |
| } |
| } |
| private static String checkSwaggerUiResourceRoot() { |
| try { |
| ClassLoader cl = AbstractSwaggerFeature.class.getClassLoader(); |
| if (cl instanceof URLClassLoader) { |
| final String resourcesRootStart = "META-INF/resources/webjars/swagger-ui/"; |
| for (URL url : ((URLClassLoader)cl).getURLs()) { |
| String urlStr = url.toString(); |
| if (urlStr.contains("/swagger-ui") && urlStr.toString().endsWith(".jar")) { |
| urlStr = urlStr.substring(0, urlStr.length() - 4); |
| String version = urlStr.substring(urlStr.lastIndexOf("/swagger-ui") + 12); |
| return "jar:" + url.toString() + "!/" |
| + resourcesRootStart + version + "/"; |
| } |
| } |
| |
| } |
| } catch (Throwable ex) { |
| // ignore |
| } |
| return null; |
| } |
| |
| @Override |
| public void initialize(Server server, Bus bus) { |
| if (!activateOnlyIfJaxrsSupported || SWAGGER_JAXRS_AVAILABLE) { |
| calculateDefaultResourcePackage(server); |
| calculateDefaultBasePath(server); |
| addSwaggerResource(server, bus); |
| |
| initializeProvider(server.getEndpoint(), bus); |
| bus.setProperty("swagger.service.description.available", "true"); |
| } |
| } |
| |
| protected abstract void addSwaggerResource(Server server, Bus bus); |
| |
| protected abstract void setBasePathByAddress(String address); |
| |
| private void calculateDefaultResourcePackage(Server server) { |
| if (!StringUtils.isEmpty(getResourcePackage())) { |
| return; |
| } |
| JAXRSServiceFactoryBean serviceFactoryBean = |
| (JAXRSServiceFactoryBean)server.getEndpoint().get(JAXRSServiceFactoryBean.class.getName()); |
| List<ClassResourceInfo> resourceInfos = serviceFactoryBean.getClassResourceInfo(); |
| |
| if (resourceInfos.size() == 1) { |
| setResourcePackage(resourceInfos.get(0).getServiceClass().getPackage().getName()); |
| } else { |
| List<Class<?>> serviceClasses = new ArrayList<Class<?>>(resourceInfos.size()); |
| for (ClassResourceInfo cri : resourceInfos) { |
| serviceClasses.add(cri.getServiceClass()); |
| } |
| String sharedPackage = PackageUtils.getSharedPackageName(serviceClasses); |
| if (!StringUtils.isEmpty(sharedPackage)) { |
| setResourcePackage(sharedPackage); |
| } |
| } |
| } |
| |
| private void calculateDefaultBasePath(Server server) { |
| if (getBasePath() == null || getBasePath().length() == 0) { |
| String address = server.getEndpoint().getEndpointInfo().getAddress(); |
| setBasePathByAddress(address); |
| } |
| } |
| |
| public String getResourcePackage() { |
| return resourcePackage; |
| } |
| public void setResourcePackage(String resourcePackage) { |
| this.resourcePackage = resourcePackage; |
| } |
| public String getVersion() { |
| return version; |
| } |
| public void setVersion(String version) { |
| this.version = version; |
| } |
| public String getBasePath() { |
| return basePath; |
| } |
| public void setBasePath(String basePath) { |
| this.basePath = basePath; |
| } |
| public String getTitle() { |
| return title; |
| } |
| public void setTitle(String title) { |
| this.title = title; |
| } |
| public String getDescription() { |
| return description; |
| } |
| public void setDescription(String description) { |
| this.description = description; |
| } |
| public String getContact() { |
| return contact; |
| } |
| public void setContact(String contact) { |
| this.contact = contact; |
| } |
| public String getLicense() { |
| return license; |
| } |
| public void setLicense(String license) { |
| this.license = license; |
| } |
| public String getLicenseUrl() { |
| return licenseUrl; |
| } |
| public void setLicenseUrl(String licenseUrl) { |
| this.licenseUrl = licenseUrl; |
| } |
| public String getTermsOfServiceUrl() { |
| return termsOfServiceUrl; |
| } |
| public void setTermsOfServiceUrl(String termsOfServiceUrl) { |
| this.termsOfServiceUrl = termsOfServiceUrl; |
| } |
| public boolean isScan() { |
| return scan; |
| } |
| public void setScan(boolean scan) { |
| this.scan = scan; |
| } |
| public String getFilterClass() { |
| return filterClass; |
| } |
| public void setFilterClass(String filterClass) { |
| this.filterClass = filterClass; |
| } |
| |
| public boolean isRunAsFilter() { |
| return runAsFilter; |
| } |
| public void setRunAsFilter(boolean runAsFilter) { |
| this.runAsFilter = runAsFilter; |
| } |
| |
| public boolean isActivateOnlyIfJaxrsSupported() { |
| return activateOnlyIfJaxrsSupported; |
| } |
| |
| public void setActivateOnlyIfJaxrsSupported(boolean activateOnlyIfJaxrsSupported) { |
| this.activateOnlyIfJaxrsSupported = activateOnlyIfJaxrsSupported; |
| } |
| |
| } |