org.sonar.server.property.InternalProperties Maven / Gradle / Ivy
/*
* SonarQube
* Copyright (C) 2009-2018 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.server.property;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Allows to read and write internal properties.
*/
public interface InternalProperties {
/**
* The UUID of the default organization.
* Can't be null unless SQ is strongly corrupted.
*/
String DEFAULT_ORGANIZATION = "organization.default";
String ORGANIZATION_ENABLED = "organization.enabled";
String SERVER_ID_CHECKSUM = "server.idChecksum";
/**
* Read the value of the specified property.
*
* @return {@link Optional#empty()} if the property does not exist, an empty string if the property is empty,
* otherwise the value of the property as a String.
*
* @throws IllegalArgumentException if {@code propertyKey} is {@code null} or empty
*/
Optional read(String propertyKey);
/**
* Write the value of the specified property.
*
* {@code null} and empty string are valid values which will persist the specified property as empty.
*
*
* @throws IllegalArgumentException if {@code propertyKey} is {@code null} or empty
*/
void write(String propertyKey, @Nullable String value);
}