JongoFactory.java

/**
 * 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.jooby.mongodb;

import org.jongo.Jongo;

/**
 * Allow to access to a custom or alternate database.
 *
 * <pre>
 * {
 *   use(new Mongodb());
 *   use(new Jongoby());
 *
 *   get("/", req {@literal ->} {
 *     Jongo jongo = req.require(JongoFactory.class).get("alternate-db");
 *     // work with jongo...
 *   });
 * }
 * </pre>
 *
 * @author edgar
 * @since 0.8.0
 */
public interface JongoFactory {

  /**
   * Get a {@link Jongo} instance for the provided database.
   *
   * @param db A database.
   * @return A new {@link Jongo} instance.
   */
  Jongo get(String db);
}