package io.eguan.rest.container;
/*
* #%L
* Project eguan
* %%
* Copyright (C) 2012 - 2017 Oodrive
* %%
* Licensed 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.
* #L%
*/
import io.eguan.configuration.StringConfigKey;
/**
* Key defining the root to which to bind the REST web application context.
*
* <table border='1'>
* <tr>
* <th>NAME</th>
* <th>DESCRIPTION</th>
* <th>REQUIRED</th>
* <th>UNIT</th>
* <th>TYPE</th>
* <th>DEFAULT</th>
* <th>MIN</th>
* <th>MAX</th>
* </tr>
* <tr>
* <td>{@value #NAME}</td>
* <td>The path to which to bind the REST web application context.</td>
* <td>FALSE</td>
* <td>URI path</td>
* <td>String</td>
* <td>/*</td>
* <td>N/A</td>
* <td>N/A</td>
* </tr>
* </table>
*
* @author oodrive
* @author pwehrle
* @author ebredzinski
*
*/
public final class RestContextPathConfigKey extends StringConfigKey {
protected static final String NAME = "rest.contextpath";
private static final String DEFAULT_VALUE = "/storage";
private static final RestContextPathConfigKey INSTANCE = new RestContextPathConfigKey();
/**
* Gets the predefined singleton instance.
*
* @return the singleton instance constructed by {@link #ServletRootPathConfigKey()}
*/
public static final RestContextPathConfigKey getInstance() {
return INSTANCE;
}
private RestContextPathConfigKey() {
super(NAME);
}
@Override
protected final String getDefaultValue() {
return DEFAULT_VALUE;
}
}