| /** |
| * 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 |
| * <p> |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * <p> |
| * 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.hadoop.ozone.om; |
| |
| import org.apache.hadoop.ozone.om.helpers.OmVolumeArgs; |
| |
| import java.io.IOException; |
| import java.util.List; |
| |
| /** |
| * OM volume manager interface for read operations on a volume. |
| */ |
| public interface VolumeManager extends IOzoneAcl { |
| |
| /** |
| * Gets the volume information. |
| * @param volume - Volume name. |
| * @return VolumeArgs or exception is thrown. |
| * @throws IOException |
| */ |
| OmVolumeArgs getVolumeInfo(String volume) throws IOException; |
| |
| /** |
| * Returns a list of volumes owned by a given user; if user is null, |
| * returns all volumes. |
| * |
| * @param userName |
| * volume owner |
| * @param prefix |
| * the volume prefix used to filter the listing result. |
| * @param startKey |
| * the start volume name determines where to start listing from, |
| * this key is excluded from the result. |
| * @param maxKeys |
| * the maximum number of volumes to return. |
| * @return a list of {@link OmVolumeArgs} |
| * @throws IOException |
| */ |
| List<OmVolumeArgs> listVolumes(String userName, String prefix, |
| String startKey, int maxKeys) throws IOException; |
| |
| } |
