HDDS-690. Javadoc build fails in hadoop-ozone.
Contributed by Takanobu Asanuma.
This commit is contained in:
Anu Engineer
parent
c64018026e
commit
f8d61b9fc2
|
|
@ -74,7 +74,7 @@ public final class BucketArgs {
|
|||
|
||||
/**
|
||||
* Returns the ACL's associated with this bucket.
|
||||
* @return List<OzoneAcl>
|
||||
* @return {@literal List<OzoneAcl>}
|
||||
*/
|
||||
public List<OzoneAcl> getAcls() {
|
||||
return acls;
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@ public final class OmBucketArgs implements Auditable {
|
|||
|
||||
/**
|
||||
* Returns the ACL's that are to be added.
|
||||
* @return List<OzoneAclInfo>
|
||||
* @return {@literal List<OzoneAclInfo>}
|
||||
*/
|
||||
public List<OzoneAcl> getAddAcls() {
|
||||
return addAcls;
|
||||
|
|
@ -108,7 +108,7 @@ public final class OmBucketArgs implements Auditable {
|
|||
|
||||
/**
|
||||
* Returns the ACL's that are to be removed.
|
||||
* @return List<OzoneAclInfo>
|
||||
* @return {@literal List<OzoneAclInfo>}
|
||||
*/
|
||||
public List<OzoneAcl> getRemoveAcls() {
|
||||
return removeAcls;
|
||||
|
|
|
|||
|
|
@ -101,7 +101,7 @@ public final class OmBucketInfo implements Auditable {
|
|||
|
||||
/**
|
||||
* Returns the ACL's associated with this bucket.
|
||||
* @return List<OzoneAcl>
|
||||
* @return {@literal List<OzoneAcl>}
|
||||
*/
|
||||
public List<OzoneAcl> getAcls() {
|
||||
return acls;
|
||||
|
|
|
|||
|
|
@ -119,7 +119,6 @@ public final class OmKeyInfo {
|
|||
* This will be called when the key is being committed to OzoneManager.
|
||||
*
|
||||
* @param locationInfoList list of locationInfo
|
||||
* @throws IOException
|
||||
*/
|
||||
public void updateLocationInfoList(List<OmKeyLocationInfo> locationInfoList) {
|
||||
long latestVersion = getLatestVersionLocations().getVersion();
|
||||
|
|
|
|||
|
|
@ -60,7 +60,8 @@ public class VolumeHandler implements Volume {
|
|||
* Creates a volume.
|
||||
*
|
||||
* @param volume Volume Name, this has to be unique at Ozone cluster level
|
||||
* @param quota Quota for this Storage Volume - <int>(<BYTES|MB|GB|TB>)
|
||||
* @param quota Quota for this Storage Volume
|
||||
* - {@literal <int>(<BYTES|MB|GB|TB>)}
|
||||
* @param req Request Object
|
||||
* @param uriInfo URI info
|
||||
* @param headers Http Headers
|
||||
|
|
@ -114,7 +115,8 @@ public class VolumeHandler implements Volume {
|
|||
* with neither of these actions, update just returns 200 OK.
|
||||
*
|
||||
* @param volume Volume Name, this has to be unique at Ozone Level
|
||||
* @param quota Quota for this volume - <int>(<BYTES|MB|GB|TB>)|remove
|
||||
* @param quota Quota for this volume
|
||||
* - {@literal <int>(<BYTES|MB|GB|TB>)}|remove
|
||||
* @param req - Request Object
|
||||
* @param uriInfo - URI info
|
||||
* @param headers Http Headers
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ package org.apache.hadoop.ozone.web.interfaces;
|
|||
* TODO : Technically we need to report bucket creation and deletion too
|
||||
* since the bucket names and metadata consume storage.
|
||||
* <p>
|
||||
* TODO : We should separate out reporting metadata & data --
|
||||
* TODO : We should separate out reporting metadata & data --
|
||||
* <p>
|
||||
* In some cases end users will only want to account for the data they are
|
||||
* storing since metadata is mostly a cost of business.
|
||||
|
|
|
|||
|
|
@ -54,11 +54,12 @@ public interface Volume {
|
|||
*
|
||||
* Params :
|
||||
* Quota - Specifies the Maximum usable size by the user
|
||||
* the valid parameters for quota are <int>(<BYTES| MB|GB|TB>) | remove.
|
||||
* For example 10GB or "remove".
|
||||
* the valid parameters for quota are {@literal <int>(<BYTES| MB|GB|TB>)}
|
||||
* | remove. For example 10GB or "remove".
|
||||
*
|
||||
* @param volume Volume Name, this has to be unique at Ozone Level
|
||||
* @param quota Quota for this Storage Volume - <int>(<MB|GB|TB>) | remove
|
||||
* @param quota Quota for this Storage Volume - {@literal <int>(<MB|GB|TB>)}
|
||||
* | remove
|
||||
* @param req - Request Object - Request Object
|
||||
* @param uriInfo - Http UriInfo
|
||||
* @param headers Http Headers HttpHeaders
|
||||
|
|
@ -91,11 +92,12 @@ public interface Volume {
|
|||
* Params :
|
||||
* Owner - Specifies the name of the owner
|
||||
* Quota - Specifies the Maximum usable size by the user
|
||||
* the valid parameters for quota are <int>(<MB|GB|TB>) | remove.
|
||||
* the valid parameters for quota are {@literal <int>(<MB|GB|TB>)} | remove.
|
||||
* For example 10GB or "remove".
|
||||
*
|
||||
* @param volume Volume Name, this has to be unique at Ozone Level
|
||||
* @param quota Quota for this Storage Volume - <int>(<MB|GB|TB>) | remove
|
||||
* @param quota Quota for this Storage Volume - {@literal <int>(<MB|GB|TB>)}
|
||||
* | remove
|
||||
* @param req - Request Object - Request Object
|
||||
* @param headers Http Headers HttpHeaders
|
||||
*
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ public interface KeyManager {
|
|||
*
|
||||
* @param args the args of the key provided by client.
|
||||
* @return a OpenKeySession instance client uses to talk to container.
|
||||
* @throws Exception
|
||||
* @throws IOException
|
||||
*/
|
||||
OpenKeySession openKey(OmKeyArgs args) throws IOException;
|
||||
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ import static org.apache.hadoop.ozone.OzoneConsts.OM_USER_PREFIX;
|
|||
* We also maintain lock hierarchy, based on the weight.
|
||||
*
|
||||
* <table>
|
||||
* <caption></caption>
|
||||
* <tr>
|
||||
* <td><b> WEIGHT </b></td> <td><b> LOCK </b></td>
|
||||
* </tr>
|
||||
|
|
@ -53,9 +54,9 @@ import static org.apache.hadoop.ozone.OzoneConsts.OM_USER_PREFIX;
|
|||
* <p>
|
||||
* For example:
|
||||
* <br>
|
||||
* -> acquireVolumeLock (will work)<br>
|
||||
* +-> acquireBucketLock (will work)<br>
|
||||
* +--> acquireUserLock (will throw Exception)<br>
|
||||
* {@literal ->} acquireVolumeLock (will work)<br>
|
||||
* {@literal +->} acquireBucketLock (will work)<br>
|
||||
* {@literal +-->} acquireUserLock (will throw Exception)<br>
|
||||
* </p>
|
||||
* <br>
|
||||
* To acquire a user lock you should not hold any Volume/Bucket lock. Similarly
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ import java.io.PrintWriter;
|
|||
*
|
||||
* The return format is of JSON and in the form
|
||||
* <p>
|
||||
* <code><pre>
|
||||
* <pre><code>
|
||||
* {
|
||||
* "services" : [
|
||||
* {
|
||||
|
|
@ -54,7 +54,7 @@ import java.io.PrintWriter;
|
|||
* }
|
||||
* ]
|
||||
* }
|
||||
* </pre></code>
|
||||
* </code></pre>
|
||||
* <p>
|
||||
*
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ import java.util.List;
|
|||
* This tool generates an ozone-site.xml with minimally required configs.
|
||||
* This tool can be invoked as follows:<br>
|
||||
* <ul>
|
||||
* <li>ozone genconf <Path to output file></li>
|
||||
* <li>ozone genconf {@literal <Path to output file>}</li>
|
||||
* <li>ozone genconf --help</li>
|
||||
* <li>ozone genconf -h</li>
|
||||
* </ul>
|
||||
|
|
|
|||
Loading…
Reference in New Issue