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 static org.apache.juneau.commons.utils.Utils.*;
020
021import java.util.*;
022
023import org.apache.juneau.bean.swagger.Swagger;
024import org.apache.juneau.cp.*;
025import org.apache.juneau.jsonschema.*;
026import org.apache.juneau.rest.*;
027import org.apache.juneau.rest.annotation.*;
028import org.apache.juneau.svl.*;
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 logger.
049    */
050   public BasicSwaggerProvider(BeanStore beanStore) {
051      // @formatter:off
052      this(
053         SwaggerProvider
054            .create(beanStore)
055            .varResolver(()->beanStore.getBean(VarResolver.class).get())
056            .fileFinder(()->beanStore.getBean(FileFinder.class).get())
057            .messages(()->beanStore.getBean(Messages.class).get())
058            .jsonSchemaGenerator(()->beanStore.getBean(JsonSchemaGenerator.class).get())
059      );
060      // @formatter:on
061   }
062
063   /**
064    * Constructor.
065    *
066    * @param builder The builder containing the settings for this Swagger provider.
067    */
068   public BasicSwaggerProvider(SwaggerProvider.Builder builder) {
069      this.beanStore = builder.beanStore;
070      this.vr = builder.varResolver().orElse(beanStore.getBean(VarResolver.class).orElse(VarResolver.DEFAULT));
071      this.js = builder.jsonSchemaGenerator().orElse(beanStore.getBean(JsonSchemaGenerator.class).orElse(JsonSchemaGenerator.DEFAULT));
072      this.messages = builder.messages().orElse(null);
073      this.fileFinder = builder.fileFinder().orElse(null);
074   }
075
076   /**
077    * Returns the Swagger associated with the specified context of a {@link Rest}-annotated class.
078    *
079    * <p>
080    * Subclasses can override this to provide their own method for generating Swagger.
081    *
082    * @param context The context of the {@link Rest}-annotated class.
083    * @param locale The request locale.
084    * @return A new {@link Swagger} object.
085    * @throws Exception If an error occurred producing the Swagger.
086    */
087   @Override /* Overridden from SwaggerProvider */
088   public Swagger getSwagger(RestContext context, Locale locale) throws Exception {
089
090      var c = context.getResourceClass();
091      var ff = nn(fileFinder) ? fileFinder : FileFinder.create(beanStore).cp(c, null, false).build();
092      var mb = nn(messages) ? messages.forLocale(locale) : Messages.create(c).build().forLocale(locale);
093      var vrs = vr.createSession().bean(Messages.class, mb);
094      var session = new BasicSwaggerProviderSession(context, locale, ff, messages, vrs, js.getSession());
095
096      return session.getSwagger();
097   }
098}