1   /*
2    * Copyright 2017 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  
17  package com.linecorp.centraldogma.client.armeria;
18  
19  import com.linecorp.armeria.client.ClientBuilder;
20  import com.linecorp.centraldogma.client.CentralDogma;
21  
22  /**
23   * Configures the underlying <a href="https://line.github.io/armeria/">Armeria</a> client of
24   * {@link CentralDogma}. Can be used to register arbitrary client decorators. e.g.
25   *
26   * <pre>{@code
27   * CentralDogmaBuilder builder = new CentralDogmaBuilder();
28   * builder.clientConfigurator(cb -> {
29   *     // Collect the client-side metrics under the meter name 'dogma.client'
30   *     cb.decorator(HttpRequest.class, HttpResponse.class,
31   *                  MetricCollectingClient.newDecorator(
32   *                          MeterIdFunction.ofDefault("dogma.client")));
33   * });
34   * ...
35   * }</pre>
36   */
37  @FunctionalInterface
38  public interface ArmeriaClientConfigurator {
39      /**
40       * Configures the client using the specified {@link ClientBuilder}.
41       */
42      void configure(ClientBuilder cb);
43  }