001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.rest.swagger;
018
019import java.util.*;
020
021import org.apache.juneau.bean.swagger.Swagger;
022import org.apache.juneau.cp.*;
023import org.apache.juneau.jsonschema.*;
024import org.apache.juneau.rest.*;
025import org.apache.juneau.rest.annotation.*;
026import org.apache.juneau.svl.*;
027
028/**
029 * Basic implementation of a {@link SwaggerProvider}.
030 *
031 * <h5 class='section'>See Also:</h5><ul>
032 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanSwagger2">juneau-bean-swagger-v2</a>
033 * </ul>
034 */
035public class BasicSwaggerProvider implements SwaggerProvider {
036
037   private final VarResolver vr;
038   private final JsonSchemaGenerator js;
039   private final Messages messages;
040   private final FileFinder fileFinder;
041   private final BeanStore beanStore;
042
043   /**
044    * Constructor.
045    *
046    * @param beanStore The bean store containing injectable beans for this logger.
047    */
048   public BasicSwaggerProvider(BeanStore beanStore) {
049      this(
050         SwaggerProvider
051            .create(beanStore)
052            .varResolver(()->beanStore.getBean(VarResolver.class).get())
053            .fileFinder(()->beanStore.getBean(FileFinder.class).get())
054            .messages(()->beanStore.getBean(Messages.class).get())
055            .jsonSchemaGenerator(()->beanStore.getBean(JsonSchemaGenerator.class).get())
056      );
057   }
058
059   /**
060    * Constructor.
061    *
062    * @param builder The builder containing the settings for this Swagger provider.
063    */
064   public BasicSwaggerProvider(SwaggerProvider.Builder builder) {
065      this.beanStore = builder.beanStore;
066      this.vr = builder.varResolver().orElse(beanStore.getBean(VarResolver.class).orElse(VarResolver.DEFAULT));
067      this.js = builder.jsonSchemaGenerator().orElse(beanStore.getBean(JsonSchemaGenerator.class).orElse(JsonSchemaGenerator.DEFAULT));
068      this.messages = builder.messages().orElse(null);
069      this.fileFinder = builder.fileFinder().orElse(null);
070   }
071
072   /**
073    * Returns the Swagger associated with the specified context of a {@link Rest}-annotated class.
074    *
075    * <p>
076    * Subclasses can override this to provide their own method for generating Swagger.
077    *
078    * @param context The context of the {@link Rest}-annotated class.
079    * @param locale The request locale.
080    * @return A new {@link Swagger} object.
081    * @throws Exception If an error occurred producing the Swagger.
082    */
083   @Override /* SwaggerProvider */
084   public Swagger getSwagger(RestContext context, Locale locale) throws Exception {
085
086      Class<?> c = context.getResourceClass();
087      FileFinder ff = fileFinder != null ? fileFinder : FileFinder.create(beanStore).cp(c,null,false).build();
088      Messages mb = messages != null ? messages.forLocale(locale) : Messages.create(c).build().forLocale(locale);
089      VarResolverSession vrs = vr.createSession().bean(Messages.class, mb);
090      BasicSwaggerProviderSession session = new BasicSwaggerProviderSession(context, locale, ff, messages, vrs, js.getSession());
091
092      return session.getSwagger();
093   }
094}