org.eclipse.jetty.start.config.ConfigSource Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995-2014 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.start.config;
import org.eclipse.jetty.start.Props;
import org.eclipse.jetty.start.RawArgs;
/**
* A Configuration Source
*/
public interface ConfigSource
{
/**
* The identifier for this source.
*
* Used in end-user display of the source.
*
* @return the configuration source identifier.
*/
public String getId();
/**
* The weight of this source, used for proper ordering of the config source search order.
*
* Recommended Weights:
*
* -1 = the command line
* 0 = the ${jetty.base} source
* [1..n] = include-jetty-dir entries from command line
* [n+1..n] = include-jetty-dir entries from start.ini (or start.d/*.ini)
* 9999999 = the ${jetty.home} source
*
*
* @return the weight of the config source. (lower value is more important)
*/
public int getWeight();
/**
* The list of Arguments for this ConfigSource
*
* @return the list of Arguments for this ConfigSource
*/
public RawArgs getArgs();
/**
* The properties for this ConfigSource
*
* @return the properties for this ConfigSource
*/
public Props getProps();
/**
* Return the value of the specified property.
*
* @param key the key to lookup
* @return the value of the property, or null if not found
*/
public String getProperty(String key);
}