Class AdminInterface

services/src/main/java/io/grpc/services/AdminInterface.java:37–73

Admin Interface provides a class of services for exposing the overall state of gRPC activity in a given binary. It aims to be a convenient API that provides available admin services.

 * services.
 */
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/7929")
@ThreadSafe
public final class AdminInterface {
  private static final int DEFAULT_CHANNELZ_MAX_PAGE_SIZE = 100;
  private static final Logger logger = Logger.getLogger(AdminInterface.class.getName());

  // Do not instantiate.
  private AdminInterface() {}

  /**
   * Returns a list of gRPC's built-in admin services.
   *
   * @return list of standard admin services
   */
  public static List<ServerServiceDefinition> getStandardServices() {
    List<ServerServiceDefinition> services = new ArrayList<>();
    services.add(ChannelzService.newInstance(DEFAULT_CHANNELZ_MAX_PAGE_SIZE).bindService());
    BindableService csds = null;
    try {
      Class<?> clazz = Class.forName("io.grpc.xds.CsdsService");
      Method m = clazz.getMethod("newInstance");
      csds = (BindableService) m.invoke(null);
    } catch (ClassNotFoundException e) {
      logger.log(Level.FINE, "Unable to find CSDS service", e);
    } catch (NoSuchMethodException e) {
      logger.log(Level.FINE, "Unable to load CSDS service", e);
    } catch (IllegalAccessException e) {
      logger.log(Level.FINE, "Unable to load CSDS service", e);
    } catch (InvocationTargetException e) {
      logger.log(Level.FINE, "Unable to load CSDS service", e);
    }
    if (csds != null) {
      services.add(csds.bindService());
    }
    return Collections.unmodifiableList(services);
  }
}