| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF 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.apache.cloudstack.engine.subsystem.api.storage; |
| |
| import com.cloud.agent.api.Answer; |
| import java.util.Map; |
| |
| import org.apache.cloudstack.engine.cloud.entity.api.VolumeEntity; |
| import org.apache.cloudstack.framework.async.AsyncCallFuture; |
| import org.apache.cloudstack.storage.command.CommandResult; |
| |
| import com.cloud.agent.api.to.VirtualMachineTO; |
| import com.cloud.exception.StorageAccessException; |
| import com.cloud.host.Host; |
| import com.cloud.hypervisor.Hypervisor.HypervisorType; |
| import com.cloud.offering.DiskOffering; |
| import com.cloud.storage.Volume; |
| import com.cloud.user.Account; |
| import com.cloud.utils.Pair; |
| |
| public interface VolumeService { |
| class VolumeApiResult extends CommandResult { |
| private final VolumeInfo volume; |
| |
| public VolumeApiResult(VolumeInfo volume) { |
| super(); |
| this.volume = volume; |
| } |
| |
| public VolumeInfo getVolume() { |
| return this.volume; |
| } |
| } |
| |
| ChapInfo getChapInfo(DataObject dataObject, DataStore dataStore); |
| |
| boolean grantAccess(DataObject dataObject, Host host, DataStore dataStore); |
| |
| void revokeAccess(DataObject dataObject, Host host, DataStore dataStore); |
| |
| boolean requiresAccessForMigration(DataObject dataObject, DataStore dataStore); |
| |
| /** |
| * Creates the volume based on the given criteria |
| * |
| * @return the volume object |
| */ |
| AsyncCallFuture<VolumeApiResult> createVolumeAsync(VolumeInfo volume, DataStore store); |
| |
| /** |
| * Delete volume |
| */ |
| AsyncCallFuture<VolumeApiResult> expungeVolumeAsync(VolumeInfo volume); |
| |
| void ensureVolumeIsExpungeReady(long volumeId); |
| |
| boolean cloneVolume(long volumeId, long baseVolId); |
| |
| AsyncCallFuture<VolumeApiResult> createVolumeFromSnapshot(VolumeInfo volume, DataStore store, SnapshotInfo snapshot); |
| |
| VolumeEntity getVolumeEntity(long volumeId); |
| |
| TemplateInfo createManagedStorageTemplate(long srcTemplateId, long destDataStoreId, long destHostId) throws StorageAccessException; |
| |
| AsyncCallFuture<VolumeApiResult> createManagedStorageVolumeFromTemplateAsync(VolumeInfo volumeInfo, long destDataStoreId, TemplateInfo srcTemplateInfo, long destHostId) throws StorageAccessException; |
| |
| AsyncCallFuture<VolumeApiResult> createVolumeFromTemplateAsync(VolumeInfo volume, long dataStoreId, TemplateInfo template); |
| |
| AsyncCallFuture<VolumeApiResult> copyVolume(VolumeInfo srcVolume, DataStore destStore); |
| |
| AsyncCallFuture<VolumeApiResult> migrateVolume(VolumeInfo srcVolume, DataStore destStore); |
| |
| AsyncCallFuture<CommandResult> migrateVolumes(Map<VolumeInfo, DataStore> volumeMap, VirtualMachineTO vmTo, Host srcHost, Host destHost); |
| |
| void destroyVolume(long volumeId); |
| |
| AsyncCallFuture<VolumeApiResult> registerVolume(VolumeInfo volume, DataStore store); |
| |
| public Pair<EndPoint, DataObject> registerVolumeForPostUpload(VolumeInfo volume, DataStore store); |
| |
| AsyncCallFuture<VolumeApiResult> resize(VolumeInfo volume); |
| |
| void resizeVolumeOnHypervisor(long volumeId, long newSize, long destHostId, String instanceName); |
| |
| void handleVolumeSync(DataStore store); |
| |
| SnapshotInfo takeSnapshot(VolumeInfo volume); |
| |
| VolumeInfo updateHypervisorSnapshotReserveForVolume(DiskOffering diskOffering, long volumeId, HypervisorType hyperType); |
| |
| void unmanageVolume(long volumeId); |
| |
| /** |
| * After volume migration, copies snapshot policies from the source volume to destination volume; then, it destroys and expunges the source volume. |
| * @return If no exception happens, it will return false, otherwise true. |
| */ |
| boolean copyPoliciesBetweenVolumesAndDestroySourceVolumeAfterMigration(ObjectInDataStoreStateMachine.Event destinationEvent, Answer destinationEventAnswer, |
| VolumeInfo sourceVolume, VolumeInfo destinationVolume, boolean retryExpungeVolumeAsync); |
| |
| void moveVolumeOnSecondaryStorageToAnotherAccount(Volume volume, Account sourceAccount, Account destAccount); |
| } |