com.vmware.vim.cf.CacheInstance Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yavijava Show documentation
Java library for VMware vSphere
There is a newer version: 6.0.05
/*================================================================================
Copyright (c) 2008 VMware, Inc. All Rights Reserved.

Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, 
this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, 
this list of conditions and the following disclaimer in the documentation 
and/or other materials provided with the distribution.

* Neither the name of VMware, Inc. nor the names of its contributors may be used
to endorse or promote products derived from this software without specific prior 
written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
IN NO EVENT SHALL VMWARE, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
================================================================================*/

package com.vmware.vim.cf;
import java.util.Map;

import com.vmware.vim25.ManagedObjectReference;
import com.vmware.vim25.PropertyFilterSpec;
import com.vmware.vim25.mo.ManagedObject;
import com.vmware.vim25.mo.ServiceInstance;

/**
 * @author Steve JIN ([email protected])
 */

public class CacheInstance 
{
  ServiceInstance si = null;
	ManagedObjectWatcher mom = null;
	ManagedObjectCache cache = null;
	Thread mThread = null;
	
	public CacheInstance(ServiceInstance si)
	{
	  this.si = si;
		mom = new ManagedObjectWatcher(si.getPropertyCollector());
		cache = new ManagedObjectCache(si);
		mom.addObserver(cache);
	}
	
	/**
	 * Add the managed objects and their properties to be watched.
	 * @param mos array of managed objects. 
	 * @param props array of properties to watch
	 */
	public void watch(ManagedObject[] mos, String[] props)
	{
		mom.watch(mos, props);
	}

  /**
   * Add PropertyFilterSpec for advanced settings
   * @param pfs the property filter spec which specifies
   * the managed objects and properties to watch.
   */
	public void watch(PropertyFilterSpec pfs)
	{
		mom.watch(pfs);
	}

	/**
	 * Get a copy of the cached property. You can change the returned
	 * object as you like
	 * @param mo Managed object
	 * @param propName property name
	 * @return the data object identified by the propName.
	 * NullObject.NULL if the data object is really null
	 */
	public Object getCopy(ManagedObject mo, String propName)
  {
     Object obj = get(mo.getMOR(), propName);
     try
     {
       obj = DeepCopier.deepCopy(obj);
     } catch(Exception e)
     {
       throw new RuntimeException(e);
     }
     return obj;
   }

	/**
	 * Get a copy of the cached property. You can change the returned
	 * object as you like
	 * @param mor Managed object reference
	 * @param propName property name
	 * @return the data object identified by the propName.
	 * NullObject.NULL if the data object is really null
	 */
  public Object getCopy(ManagedObjectReference mor, String propName)
  {
    return getCopy(mor, propName);
  }
   
  /**
   * Get the value of cached property whose name is propName.
   * You should NEVER change the returned data object.
   * @param mo Managed object on which the cached property is requested
   * @param propName Property name, can include "."
   * @return the data object identified by the propName.
   * NullObject.NULL if the data object is really null
   */
	public Object get(ManagedObject mo, String propName)
	{
		return get(mo.getMOR(), propName);
	}
	
	/**
	 * Get the value of cached property whose name is propName.
	 * You should NEVER change the returned data object.
	 * @param mor Managed object reference pointing to the managed object
	 * @param propName Property name
	 * @return the data object identified by the propName.
   * NullObject.NULL if the data object is really null
	 */
	public Object get(ManagedObjectReference mor, String propName)
	{
	  Map> items = cache.getCachedItems();
	  
    Map moMap =  items.get(mor);
	  if(moMap!=null)
	  {
		  return moMap.get(propName);
	  }
	  return null;
	}
	
	/**
	 * Start the caching service. Called after specifying the managed
	 * objects and their properties to watch.
	 */
	public void start()
	{
	  mThread = new Thread(mom);
	  mThread.setName("MonitorThead for " + si.getServerConnection().getUrl());
	  mThread.start();
	}
	
	/**
	 * Destrory the caching service when no longer needed.
	 */
	public void destroy()
	{
		mom.cleanUp();
		mThread.stop();
		si = null;
		mom = null;
		cache = null;
		mThread = null;
	}
	
	/**
	 * Get the corresponding ServiceInstance
	 * @return ServiceInstance object
	 */
	public ServiceInstance getServiceInstance()
	{
	  return si;
	}
	/**
	 * Check if the CacheInstance is ready for retrieval
	 * @return true if ready; false otherwise
	 */
	public boolean isReady()
	{
		return cache.isReady();
	}
}