1   /*
2    * Copyright 2023 LINE Corporation
3    *
4    * LINE Corporation licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package com.linecorp.centraldogma.server;
17  
18  import java.util.List;
19  
20  /**
21   * A converter that converts a value of certain configuration properties in {@link CentralDogmaConfig}.
22   * Here is the list of the properties that this converter supports:
23   * <ul>
24   *     <li>{@code replication.secret}</li>
25   *     <li>{@code tls.keyCertChain}</li>
26   *     <li>{@code tls.key}</li>
27   *     <li>{@code tls.keyPassword}</li>
28   *     <li>{@code authentication.properties.keyStore.password} (when SAML is used)</li>
29   *     <li>{@code authentication.properties.keyStore.keyPasswords} (when SAML is used)</li>
30   * </ul>
31   * Implement this interface and register it via SPI to convert a value of the properties.
32   */
33  public interface ConfigValueConverter {
34  
35      /**
36       * Returns the list of prefixes of the properties that this converter supports.
37       */
38      List<String> supportedPrefixes();
39  
40      /**
41       * Returns the converted value of the property. It must not return {@code null}.
42       */
43      String convert(String prefix, String value);
44  }