com.yahoo.vespa.config.server.RequestHandler Maven / Gradle / Ivy
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.config.server;
import com.yahoo.component.Version;
import com.yahoo.config.FileReference;
import com.yahoo.config.provision.ApplicationId;
import com.yahoo.vespa.config.ConfigKey;
import com.yahoo.vespa.config.GetConfigRequest;
import com.yahoo.vespa.config.protocol.ConfigResponse;
import java.util.Optional;
import java.util.Set;
/**
* Instances of this can serve misc config related requests
*
* @author Ulf Lilleengen
*/
public interface RequestHandler {
/**
* Resolves a config. Mandatory subclass hook for getConfig().
*
* @param appId The application id to use
* @param req a config request
* @param vespaVersion vespa version
* @return The resolved config if it exists, else null.
*/
ConfigResponse resolveConfig(ApplicationId appId, GetConfigRequest req, Optional vespaVersion);
/**
* Lists all configs (name, configKey) in the config model.
*
* @param appId application id to use
* @param vespaVersion optional vespa version
* @param recursive If true descend into all levels
* @return set of keys
*/
Set> listConfigs(ApplicationId appId, Optional vespaVersion, boolean recursive);
/**
* Lists all configs (name, configKey) of the given key. The config id of the key is interpreted as a prefix to match.
*
* @param appId application id to use
* @param vespaVersion optional vespa version
* @param key def key to match
* @param recursive If true descend into all levels
* @return set of keys
*/
Set> listNamedConfigs(ApplicationId appId, Optional vespaVersion, ConfigKey key, boolean recursive);
/**
* Lists all available configs produced
*
* @param appId application id to use
* @param vespaVersion optional vespa version
* @return set of keys
*/
Set> allConfigsProduced(ApplicationId appId, Optional vespaVersion);
/**
* List all config ids present
*
* @param appId application id to use
* @param vespaVersion optional vespa version
* @return a Set containing all config ids available
*/
Set allConfigIds(ApplicationId appId, Optional vespaVersion);
/**
* True if application loaded
*
* @param appId The application id to use
* @param vespaVersion optional vespa version
* @return true if app loaded
*/
boolean hasApplication(ApplicationId appId, Optional vespaVersion);
/**
* Resolve {@link ApplicationId} for a given hostname. Returns a default {@link ApplicationId} if no applications
* are found for that host.
*
* @param hostName hostname of client.
* @return an {@link ApplicationId} instance.
*/
ApplicationId resolveApplicationId(String hostName);
/**
* Returns the set of file references from the application's Vespa models, aggregated across all application versions.
*
* @param applicationId application id to use
* @return set of file references that is owned by the application
*/
Set listFileReferences(ApplicationId applicationId);
/** Returns whether the latest deployed version of application is compatible with given vespaVersion */
boolean compatibleWith(Optional vespaVersion, ApplicationId application);
}