org.jclouds.abiquo.features.services.MonitoringService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of abiquo Show documentation
jclouds components to access an implementation of Abiquo
There is a newer version: 1.6.0
/**
 * Licensed to jclouds, Inc. (jclouds) under one or more
 * contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  jclouds licenses this file
 * to you 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.jclouds.abiquo.features.services;

import java.util.concurrent.TimeUnit;

import org.jclouds.abiquo.events.handlers.AbstractEventHandler;
import org.jclouds.abiquo.internal.BaseMonitoringService;
import org.jclouds.abiquo.monitor.AsyncTaskMonitor;
import org.jclouds.abiquo.monitor.ConversionMonitor;
import org.jclouds.abiquo.monitor.MonitorStatus;
import org.jclouds.abiquo.monitor.VirtualApplianceMonitor;
import org.jclouds.abiquo.monitor.VirtualMachineMonitor;

import com.google.common.base.Function;
import com.google.inject.ImplementedBy;

/**
 * Utility service to monitor asynchronous operations.
 * 
 * @author Ignasi Barrera
 * @author Francesc Montserrat
 */
@ImplementedBy(BaseMonitoringService.class)
public interface MonitoringService {

   /*************** Generic monitoring methods ***************/

   /**
    * Monitor the given objects using the given complete condition.
    * 
    * @param completeCondition
    *           The function that will be used to decide if the asynchronous
    *           operations have finished.
    * @param objects
    *           The objects to monitor.
    */
   public  void awaitCompletion(final Function completeCondition, final T... objects);

   /**
    * Monitor the given objects using the given complete condition.
    * 
    * @param maxWait
    *           The maximum time to wait.
    * @param timeUnit
    *           The time unit for the maxWait parameter.
    * @param completeCondition
    *           The function that will be used to decide if the asynchronous
    *           operations have finished.
    * @param objects
    *           The objects to monitor.
    */
   public  void awaitCompletion(final Long maxWait, final TimeUnit timeUnit,
         final Function completeCondition, final T... objects);

   /**
    * Monitor the given objects using the given complete condition.
    * 
    * @param completeCondition
    *           The function that will be used to decide if the asynchronous
    *           operations have finished.
    * @param objects
    *           The objects to monitor.
    */
   public  void monitor(final Function completeCondition, final T... objects);

   /**
    * Monitor the given objects using the given complete condition.
    * 
    * @param maxWait
    *           The maximum time to wait.
    * @param timeUnit
    *           The time unit for the maxWait parameter.
    * @param completeCondition
    *           The function that will be used to decide if the asynchronous
    *           operations have finished.
    * @param objects
    *           The objects to monitor.
    */
   public  void monitor(final Long maxWait, final TimeUnit timeUnit,
         final Function completeCondition, final T... objects);

   /*************** Handler registration methods ***************/

   /**
    * Registers the given event handler.
    * 
    * @param 
    *           The type of event handler to register.
    * @param handler
    *           The event handler to register.
    */
   public > void register(T handler);

   /**
    * Unregisters the given event handler.
    * 
    * @param 
    *           The type of event handler to unregister.
    * @param handler
    *           The event handler to unregister.
    */
   public > void unregister(T handler);

   /*************** Delegating monitors ***************/

   /**
    * Gets the virtual machine monitor service.
    * 
    * @return The virtual machine monitor service.
    */
   public VirtualMachineMonitor getVirtualMachineMonitor();

   /**
    * Gets the virtual appliance monitor service.
    * 
    * @return The virtual appliance monitor service.
    */
   public VirtualApplianceMonitor getVirtualApplianceMonitor();

   /**
    * Gets the asynchronous task monitor service.
    * 
    * @return The asynchronous task monitor service.
    */
   public AsyncTaskMonitor getAsyncTaskMonitor();

   /**
    * Gets the conversion monitor service.
    * 
    * @return The conversion monitor service.
    */
   public ConversionMonitor getConversionMonitor();
}