001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2016 ForgeRock AS.
015 */
016
017package org.forgerock.json.resource;
018
019/**
020 * Declare a CREST Application. This interface binds together the CREST {@link ConnectionFactory} that will
021 * be used to connect to the API, and the API ID and Version that will be used when describing it.
022 */
023public interface CrestApplication {
024    /**
025     * Get the connection factory for the application.
026     * @return The factory.
027     */
028    ConnectionFactory getConnectionFactory();
029
030    /**
031     * Get the API ID, that will be used in the {@link org.forgerock.api.models.ApiDescription}.
032     * @return The ID.
033     */
034    String getApiId();
035
036    /**
037     * Get the API Version, that will be used in the {@link org.forgerock.api.models.ApiDescription}.
038     * @return The Version.
039     */
040    String getApiVersion();
041}