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.server.swagger;
018
019import static org.apache.juneau.commons.utils.Shorts.*;
020
021import java.util.*;
022
023import org.apache.juneau.bean.swagger.Swagger;
024import org.apache.juneau.commons.inject.*;
025import org.apache.juneau.commons.svl.*;
026import org.apache.juneau.marshall.cp.*;
027import org.apache.juneau.marshall.jsonschema.*;
028import org.apache.juneau.rest.server.*;
029
030/**
031 * Basic implementation of a {@link SwaggerProvider}.
032 *
033 * <h5 class='section'>See Also:</h5><ul>
034 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanSwagger2">juneau-bean-swagger-v2</a>
035 * </ul>
036 */
037public class BasicSwaggerProvider implements SwaggerProvider {
038
039   private final VarResolver vr;
040   private final JsonSchemaGenerator js;
041   private final Messages messages;
042   private final FileFinder fileFinder;
043   private final BeanStore beanStore;
044
045   /**
046    * Constructor.
047    *
048    * @param beanStore The bean store containing injectable beans for this Swagger provider.
049    *    <br>Must not be <jk>null</jk>.
050    */
051   public BasicSwaggerProvider(BeanStore beanStore) {
052      // @formatter:off
053      this(
054         SwaggerProvider
055            .create(beanStore)
056            .varResolver(()->beanStore.getBean(VarResolver.class).get())
057            .fileFinder(()->beanStore.getBean(FileFinder.class).get())
058            .messages(()->beanStore.getBean(Messages.class).get())
059            .jsonSchemaGenerator(()->beanStore.getBean(JsonSchemaGenerator.class).get())
060      );
061      // @formatter:on
062   }
063
064   /**
065    * Constructor.
066    *
067    * @param builder The builder containing the settings for this Swagger provider.
068    *    <br>Must not be <jk>null</jk>.
069    */
070   public BasicSwaggerProvider(SwaggerProvider.Builder builder) {
071      this.beanStore = builder.beanStore;
072      this.vr = builder.varResolver().orElse(beanStore.getBean(VarResolver.class).orElse(VarResolver.DEFAULT));
073      this.js = builder.jsonSchemaGenerator().orElse(beanStore.getBean(JsonSchemaGenerator.class).orElse(JsonSchemaGenerator.DEFAULT));
074      this.messages = builder.messages().orElse(null);
075      this.fileFinder = builder.fileFinder().orElse(null);
076   }
077
078   /**
079    * Returns the Swagger associated with the specified context of a {@link Rest}-annotated class.
080    *
081    * <p>
082    * Subclasses can override this to provide their own method for generating Swagger.
083    *
084    * @param context The context of the {@link Rest}-annotated class.
085    * @param locale The request locale.
086    * @return A new {@link Swagger} object.
087    * @throws Exception If an error occurred producing the Swagger.
088    */
089   @Override /* Overridden from SwaggerProvider */
090   public Swagger getSwagger(RestContext context, Locale locale) throws Exception {
091
092      var c = context.getResourceClass();
093      var ff = nn(fileFinder) ? fileFinder : FileFinder.create(beanStore).cp(c, null, false).build();
094      var mb = nn(messages) ? messages.forLocale(locale) : Messages.create(c).build().forLocale(locale);
095      var vrs = vr.createSession().bean(Messages.class, mb);
096      var session = new BasicSwaggerProviderSession(context, locale, ff, messages, vrs, js.getSession());
097
098      return session.getSwagger();
099   }
100}