1 files changed, 260 insertions, 0 deletions
diff --git a/config-model-api/src/main/java/com/yahoo/config/application/api/ApplicationPackage.java b/config-model-api/src/main/java/com/yahoo/config/application/api/ApplicationPackage.java
new file mode 100644
index 00000000000..96f58bf140a
--- /dev/null
+++ b/config-model-api/src/main/java/com/yahoo/config/application/api/ApplicationPackage.java
@@ -0,0 +1,260 @@
+// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
+package com.yahoo.config.application.api;
+
+import com.yahoo.config.provision.ProvisionInfo;
+import com.yahoo.config.provision.Version;
+import com.yahoo.config.provision.Zone;
+import com.yahoo.path.Path;
+import com.yahoo.io.IOUtils;
+import com.yahoo.io.reader.NamedReader;
+import com.yahoo.text.XML;
+import com.yahoo.vespa.config.ConfigDefinitionKey;
+import org.w3c.dom.Element;
+import org.xml.sax.SAXException;
+
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.transform.TransformerException;
+import java.io.*;
+import java.util.*;
+import java.util.jar.JarEntry;
+import java.util.jar.JarFile;
+
+/**
+ * Represents an application package, that is, used as input when creating a VespaModel and as
+ * a general reference to all contents in an application.
+ *
+ * The class hides detail as to whether the source is local files or ZooKeeper
+ * data in config server.
+ *
+ * Anyone wanting to access application data should use this interface.
+ *
+ * @author vegardh
+ */
+public interface ApplicationPackage {
+
+    // Caution!! If you add something here it must probably also be added to ZooKeeperClient.feedZKAppPkg
+
+    String HOSTS = "hosts.xml";
+    String SERVICES = "services.xml";
+
+    Path SEARCH_DEFINITIONS_DIR = Path.fromString("searchdefinitions");
+    String COMPONENT_DIR = "components";
+    String TEMPLATES_DIR = "templates";
+    String FILES_DIR = "files";
+    String SEARCHCHAINS_DIR = "search/chains";
+    String DOCPROCCHAINS_DIR = "docproc/chains";
+    String PROCESSORCHAINS_DIR = "processor/chains";
+    String ROUTINGTABLES_DIR = "routing/tables";
+
+    // NOTE: this directory is created in serverdb during deploy, and should not exist in the original user application
+    /** Do not use */
+    String CONFIG_DEFINITIONS_DIR = "configdefinitions";
+
+    Path QUERY_PROFILES_DIR= Path.fromString("search/query-profiles");
+    Path QUERY_PROFILE_TYPES_DIR= Path.fromString("search/query-profiles/types");
+    Path PAGE_TEMPLATES_DIR= Path.fromString("page-templates");
+    Path RULES_DIR = Path.fromString("rules");
+
+    Path DEPLOYMENT_FILE = Path.fromString("deployment.xml");
+    Path VALIDATION_OVERRIDES = Path.fromString("validation-overrides.xml");
+
+    String SD_NAME_SUFFIX = ".sd";
+    String RANKEXPRESSION_NAME_SUFFIX = ".expression";
+    String RULES_NAME_SUFFIX = ".sr";
+    String EXT_DIR = "ext";
+
+    String PERMANENT_SERVICES = "permanent-services.xml";
+
+    /**
+     * The name of the application package
+     *
+     * @return the name of the application (i.e the directory where the application package was deployed from)
+     */
+    String getApplicationName();
+
+    /**
+     * Contents of services.xml. Caller must close reader after use.
+     * @return a Reader, or null if no services.xml/vespa-services.xml present
+     */
+    Reader getServices();
+
+    /**
+     * Contents of hosts.xml. Caller must close reader after use.
+     * @return a Reader, or null if no hosts.xml/vespa-hosts.xml present
+     */
+    Reader getHosts();
+
+    /**
+     * Returns the include dirs given by the user in the services.xml file.
+     */
+    default List<String> getUserIncludeDirs() {
+        throw new UnsupportedOperationException(
+                "This application package does not have special handling for user include dirs.");
+    }
+
+    default void validateIncludeDir(String dirName) {
+        throw new UnsupportedOperationException("" +
+                "This application package does not support validation of include dirs.");
+    }
+
+    /**
+     * Readers for all the search definition files for this.
+     * @return a list of readers for search definitions
+     */
+    Collection<NamedReader> searchDefinitionContents();
+
+    /**
+     * Subclass hook.
+     * Returns a mapping from def key to a file name that can be used for lookup.
+     * @return An mapping of all config definition combos available in this package.
+     */
+    Map<ConfigDefinitionKey, UnparsedConfigDefinition> getAllExistingConfigDefs();
+
+    /**
+     * Returns the files in a directory as readers. The readers <b>must</b>
+     * be closed by the caller.
+     *
+     *
+     * @param  pathFromRoot the relative path string from the root of the application package
+     * @param  suffix the suffix of files to return, or null to return all
+     * @param  recurse return files in all subdirectories (recursively) as well
+     * @return a list of the files at this location, or an empty list (never null)
+     *         if the directory does not exist or is empty. The list gets owned by the caller
+     *         and can be modified freely.
+     */
+    List<NamedReader> getFiles(Path pathFromRoot, String suffix, boolean recurse);
+
+    /** Same as getFiles(pathFromRoot,suffix,false) */
+    default List<NamedReader> getFiles(Path pathFromRoot, String suffix) {
+        return getFiles(pathFromRoot,suffix,false);
+    }
+
+    /** Returns the major version this application is valid for, or empty if it is valid for all versions */
+    default Optional<Integer> getMajorVersion() {
+        Element servicesElement = XML.getDocument(getServices()).getDocumentElement();
+        if (servicesElement == null) return Optional.empty();
+        String majorVersionString = servicesElement.getAttribute("major-version");
+        if (majorVersionString == null || majorVersionString.isEmpty())
+            return Optional.empty();
+        try {
+            return Optional.of(Integer.parseInt(majorVersionString));
+        }
+        catch (NumberFormatException e) {
+            throw new IllegalArgumentException("major-version must be an integer number, not '" + majorVersionString + "'");
+        }
+    }
+
+    /**
+     * Gets a file from the root of the application package
+     *
+     *
+     * @param relativePath The relative path of the file within this application package.
+     * @return reader for file
+     * @throws IllegalArgumentException if the given path does not exist
+     */
+    ApplicationFile getFile(Path relativePath);
+
+    /** Does {@link #getFiles} on the query profile directory and gets all xml files */
+    default List<NamedReader> getQueryProfileFiles() { return getFiles(QUERY_PROFILES_DIR,".xml"); }
+
+    /** Does {@link #getFiles} on the query profile directory and gets all xml files */
+    default List<NamedReader> getQueryProfileTypeFiles() { return getFiles(QUERY_PROFILE_TYPES_DIR,".xml"); }
+
+    /** Does {@link #getFiles} on the page template directory and gets all xml files */
+    default List<NamedReader> getPageTemplateFiles() { return getFiles(PAGE_TEMPLATES_DIR,".xml"); }
+
+    //For generating error messages
+    String getHostSource();
+    String getServicesSource();
+
+    Optional<Reader> getDeployment();
+    Optional<Reader> getValidationOverrides();
+
+    List<ComponentInfo> getComponentsInfo(Version vespaVersion);
+
+    /**
+     * Reads a ranking expression from file to a string and returns it.
+     *
+     * @param name the name of the file to return, relative to the search definition directory in the application package
+     * @return the content of a ranking expression file
+     * @throws IllegalArgumentException if the file was not found or could not be read
+     */
+    Reader getRankingExpression(String name);
+
+    /**
+     * Returns the name-payload pairs of any sd files under path/searchdefinitions/ in the given jar bundle
+     * @param bundle The jar file, which will be closed afterwards by this method.
+     * @param path For example 'complex/'
+     * @return map of the SD payloads
+     * @throws IOException if it is reading sd files fails
+     */
+    static Map<String, String> getBundleSdFiles(String path, JarFile bundle) throws IOException {
+        Map<String,String> ret = new LinkedHashMap<>();
+        for (Enumeration<JarEntry> e = bundle.entries(); e.hasMoreElements();) {
+            JarEntry je=e.nextElement();
+            if (je.getName().startsWith(path+SEARCH_DEFINITIONS_DIR+"/") && je.getName().endsWith(SD_NAME_SUFFIX)) {
+                String contents = IOUtils.readAll(new InputStreamReader(bundle.getInputStream(je)));
+                ret.put(getFileName(je), contents);
+            }
+        }
+        bundle.close();
+        return ret;
+    }
+
+    /**
+     * The name of an SD in a JarEntry
+     */
+    static String getFileName(JarEntry je) {
+        String name = je.getName();
+        name = name.replaceAll(".*/", "");
+        return name;
+    }
+
+    /**
+     * Gets the ApplicationMetaData instance for this application package.
+     * @return an ApplicationMetaData instance
+     */
+    default ApplicationMetaData getMetaData() { return null; }
+
+    default File getFileReference(Path pathRelativeToAppDir) {
+        throw new UnsupportedOperationException("This application package cannot return file references");
+    }
+
+    default void validateXML(DeployLogger logger) throws IOException {
+        throw new UnsupportedOperationException("This application package cannot validate XML");
+    }
+
+    default void validateXML(DeployLogger logger, Optional<Version> vespaVersion) throws IOException {
+        throw new UnsupportedOperationException("This application package cannot validate XML");
+    }
+
+    default void writeMetaData() throws IOException {
+        throw new UnsupportedOperationException("This application package cannot write its metadata");
+    }
+
+    default Map<Version, ProvisionInfo> getProvisionInfoMap() {
+        return Collections.emptyMap();
+    }
+
+    default Map<Version, FileRegistry> getFileRegistryMap() {
+        return Collections.emptyMap();
+    }
+
+    Collection<NamedReader> getSearchDefinitions();
+
+    /**
+     * Preprocess an application for a given zone and return a new application package pointing to the preprocessed
+     * application package. This is the entry point for the multi environment application package support. This method
+     * will not mutate the existing application package.
+     *
+     * @param zone A valid {@link Zone} instance, used to decide which parts of services to keep and remove
+     * @param ruleConfigDeriver ignored
+     * @param logger A {@link DeployLogger} to add output that will be returned to the user
+     *
+     * @return A new application package instance pointing to a new location
+     */
+    default ApplicationPackage preprocess(Zone zone, RuleConfigDeriver ruleConfigDeriver, DeployLogger logger) throws IOException, TransformerException, ParserConfigurationException, SAXException {
+        throw new UnsupportedOperationException("This application package does not support preprocessing");
+    }
+
+}