org.terracotta.management.registry.ManagementProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of management-registry Show documentation
The newest version!
/*
 * Copyright Terracotta, Inc.
 *
 * 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.
 */
package org.terracotta.management.registry;

import org.terracotta.management.model.call.Parameter;
import org.terracotta.management.model.capabilities.Capability;
import org.terracotta.management.model.capabilities.context.CapabilityContext;
import org.terracotta.management.model.capabilities.descriptors.Descriptor;
import org.terracotta.management.model.context.Context;
import org.terracotta.management.model.stats.Statistic;

import java.util.Collection;
import java.util.Map;

/**
 * Interface to a provider of management capabilities for certain object class.
 *
 * @author Ludovic Orban
 */
public interface ManagementProvider {

  /**
   * The class of managed objects.
   *
   * @return a class.
   */
  Class getManagedType();

  /**
   * Register an object for management in the current provider.
   *
   * @param managedObject the object to manage.
   */
  void register(T managedObject);

  /**
   * Unregister a managed object from the current provider.
   *
   * @param managedObject the managed object.
   */
  void unregister(T managedObject);

  /**
   * Get the set of capability descriptors the current provider provides.
   *
   * @return the set of capability descriptors.
   */
  Collection getDescriptors();

  /**
   * Get the context that the provided capabilities need to run.
   *
   * @return the context requirements.
   */
  CapabilityContext getCapabilityContext();

  /**
   * @return The full capability of this management provider
   */
  Capability getCapability();

  /**
   * @return The name of this capability
   */
  String getCapabilityName();

  /**
   * Collect statistics, if the provider supports this.
   *
   * @param context        the context.
   * @param statisticNames the statistic names to collect.
   * @param since          The unix time in ms from where to return the statistics for statistics based on samples.
   * @return the statistic map, the key being the statistic namesø.
   */
  Map> collectStatistics(Context context, Collection statisticNames, long since);

  /**
   * Call an action, if the provider supports this.
   *
   * @param context    the context.
   * @param methodName the method name.
   * @param parameters the action method's parameters (objects and class names)
   * @param returnType The expected return type
   * @param  the expected response type
   * @return the action's return value.
   */
   V callAction(Context context, String methodName, Class returnType, Parameter... parameters);

  /**
   * Call an action, if the provider supports this.
   *
   * @param context    the context.
   * @param methodName the method name.
   * @param parameters the action method's parameters (objects and class names)
   */
  void callAction(Context context, String methodName, Parameter... parameters);

  /**
   * Check wheter this management provider supports the given context
   *
   * @param context The management context
   * @return true if the context is supported by this management provider
   */
  boolean supports(Context context);

  /**
   * Closes the management provider.
   */
  void close();
}