How to use org.apache.cloudstack.engine.subsystem.api.storage

/**
 * Returns the template UUID with the given id. If the template ID is null, it returns null.
 */
protected String getTemplateUuid(Long templateId) {
  if (templateId == null) {
    return null;
  }
  TemplateInfo templateImage = templateDataFactory.getTemplate(templateId, DataStoreRole.Image);
  return templateImage.getUuid();
}

@Override
public void revokeAccess(DataObject dataObject, Host host, DataStore dataStore) {
  DataStoreDriver dataStoreDriver = dataStore != null ? dataStore.getDriver() : null;
  if (dataStoreDriver instanceof PrimaryDataStoreDriver) {
    ((PrimaryDataStoreDriver)dataStoreDriver).revokeAccess(dataObject, host, dataStore);
  }
}

@Override
public boolean grantAccess(DataObject dataObject, Host host, DataStore dataStore) {
  DataStoreDriver dataStoreDriver = dataStore != null ? dataStore.getDriver() : null;
  if (dataStoreDriver instanceof PrimaryDataStoreDriver) {
    return ((PrimaryDataStoreDriver)dataStoreDriver).grantAccess(dataObject, host, dataStore);
  }
  return false;
}

@Override
public DataObject get(DataObject dataObj, DataStore store) {
  if (dataObj.getType() == DataObjectType.TEMPLATE) {
    return imageFactory.getTemplate(dataObj, store);
  } else if (dataObj.getType() == DataObjectType.VOLUME) {
    return volumeFactory.getVolume(dataObj, store);
  } else if (dataObj.getType() == DataObjectType.SNAPSHOT) {
    return snapshotFactory.getSnapshot(dataObj, store);
  }
  throw new CloudRuntimeException("unknown type");
}

@Override
public boolean isRegionStore(DataStore store) {
  if (store.getScope().getScopeType() == ScopeType.ZONE && store.getScope().getScopeId() == null)
    return true;
  else
    return false;
}

private void handleQualityOfServiceForVolumeMigration(VolumeInfo volumeInfo, PrimaryDataStoreDriver.QualityOfServiceState qualityOfServiceState) {
  try {
    ((PrimaryDataStoreDriver)volumeInfo.getDataStore().getDriver()).handleQualityOfServiceForVolumeMigration(volumeInfo, qualityOfServiceState);
  }
  catch (Exception ex) {
    LOGGER.warn(ex);
  }
}

private long getDataObjectSizeIncludingHypervisorSnapshotReserve(Volume volume, StoragePool pool) {
  DataStoreProvider storeProvider = _dataStoreProviderMgr.getDataStoreProvider(pool.getStorageProviderName());
  DataStoreDriver storeDriver = storeProvider.getDataStoreDriver();
  if (storeDriver instanceof PrimaryDataStoreDriver) {
    PrimaryDataStoreDriver primaryStoreDriver = (PrimaryDataStoreDriver)storeDriver;
    VolumeInfo volumeInfo = volFactory.getVolume(volume.getId());
    return primaryStoreDriver.getDataObjectSizeIncludingHypervisorSnapshotReserve(volumeInfo, pool);
  }
  return volume.getSize();
}

  @Override
  public boolean deleteCacheObject(DataObject data) {
    return data.getDataStore().delete(data);
  }
}

private Scope getZoneScope(Scope destScope) {
  ZoneScope zoneScope = null;
  if (destScope instanceof ClusterScope) {
    ClusterScope clusterScope = (ClusterScope)destScope;
    zoneScope = new ZoneScope(clusterScope.getZoneId());
  } else if (destScope instanceof HostScope) {
    HostScope hostScope = (HostScope)destScope;
    zoneScope = new ZoneScope(hostScope.getZoneId());
  } else {
    zoneScope = (ZoneScope)destScope;
  }
  return zoneScope;
}

@Override
public ChapInfo getChapInfo(DataObject dataObject, DataStore dataStore) {
  DataStoreDriver dataStoreDriver = dataStore.getDriver();
  if (dataStoreDriver instanceof PrimaryDataStoreDriver) {
    return ((PrimaryDataStoreDriver)dataStoreDriver).getChapInfo(dataObject);
  }
  return null;
}

@Override
public String getSecondaryStorageURL(long zoneId) {
  DataStore secStore = _dataStoreMgr.getImageStore(zoneId);
  if (secStore == null) {
    return null;
  }
  return secStore.getUri();
}

protected boolean moveBetweenImages(DataStore srcStore, DataStore destStore) {
  DataStoreRole srcRole = srcStore.getRole();
  DataStoreRole destRole = destStore.getRole();
  if (srcRole == DataStoreRole.Image && destRole == DataStoreRole.Image) {
    return true;
  } else {
    return false;
  }
}

private DataObject cacheSnapshotChain(SnapshotInfo snapshot, Scope scope) {
  DataObject leafData = null;
  DataStore store = cacheMgr.getCacheStorage(snapshot, scope);
  while (snapshot != null) {
    DataObject cacheData = cacheMgr.createCacheObject(snapshot, store);
    if (leafData == null) {
      leafData = cacheData;
    }
    snapshot = snapshot.getParent();
  }
  return leafData;
}

private long getBytesRequiredForTemplate(VMTemplateVO tmpl, StoragePool pool) {
  DataStoreProvider storeProvider = _dataStoreProviderMgr.getDataStoreProvider(pool.getStorageProviderName());
  DataStoreDriver storeDriver = storeProvider.getDataStoreDriver();
  if (storeDriver instanceof PrimaryDataStoreDriver) {
    PrimaryDataStoreDriver primaryStoreDriver = (PrimaryDataStoreDriver)storeDriver;
    TemplateInfo templateInfo = tmplFactory.getReadyTemplateOnImageStore(tmpl.getId(), pool.getDataCenterId());
    return primaryStoreDriver.getBytesRequiredForTemplate(templateInfo, pool);
  }
  return tmpl.getSize();
}

protected void releaseSnapshotCacheChain(SnapshotInfo snapshot) {
  while (snapshot != null) {
    cacheMgr.releaseCacheObject(snapshot);
    snapshot = snapshot.getParent();
  }
}

protected void deleteSnapshotCacheChain(SnapshotInfo snapshot) {
  while (snapshot != null) {
    cacheMgr.deleteCacheObject(snapshot);
    snapshot = snapshot.getParent();
  }
}

@Override
public SnapshotInfo takeSnapshot(SnapshotInfo snapshot) {
  return snapshotSvr.takeSnapshot(snapshot).getSnapshot();
}

@Override
public void revokeAccess(DataObject dataObject, Host host, DataStore dataStore) {
  DataStoreDriver dataStoreDriver = dataStore != null ? dataStore.getDriver() : null;
  if (dataStoreDriver instanceof PrimaryDataStoreDriver) {
    ((PrimaryDataStoreDriver)dataStoreDriver).revokeAccess(dataObject, host, dataStore);
  }
}

private Scope getZoneScope(Scope scope) {
  ZoneScope zoneScope;
  if (scope instanceof ClusterScope) {
    ClusterScope clusterScope = (ClusterScope)scope;
    zoneScope = new ZoneScope(clusterScope.getZoneId());
  } else if (scope instanceof HostScope) {
    HostScope hostScope = (HostScope)scope;
    zoneScope = new ZoneScope(hostScope.getZoneId());
  } else {
    zoneScope = (ZoneScope)scope;
  }
  return zoneScope;
}

protected DataObject cacheSnapshotChain(SnapshotInfo snapshot, Scope scope) {
  DataObject leafData = null;
  DataStore store = cacheMgr.getCacheStorage(snapshot, scope);
  while (snapshot != null) {
    DataObject cacheData = cacheMgr.createCacheObject(snapshot, store);
    if (leafData == null) {
      leafData = cacheData;
    }
    snapshot = snapshot.getParent();
  }
  return leafData;
}