You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by wa...@apache.org on 2014/07/30 07:57:55 UTC
svn commit: r1614547 - in
/hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs:
AbstractFileSystem.java FileContext.java FileSystem.java
Author: wang
Date: Wed Jul 30 05:57:55 2014
New Revision: 1614547
URL: http://svn.apache.org/r1614547
Log:
HDFS-6778. The extended attributes javadoc should simply refer to the user docs. Contributed by Charles Lamb.
Modified:
hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/AbstractFileSystem.java
hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileContext.java
hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileSystem.java
Modified: hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/AbstractFileSystem.java
URL: http://svn.apache.org/viewvc/hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/AbstractFileSystem.java?rev=1614547&r1=1614546&r2=1614547&view=diff
==============================================================================
--- hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/AbstractFileSystem.java (original)
+++ hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/AbstractFileSystem.java Wed Jul 30 05:57:55 2014
@@ -1040,21 +1040,10 @@ public abstract class AbstractFileSystem
/**
* Set an xattr of a file or directory.
- * The name must be prefixed with user/trusted/security/system and
- * followed by ".". For example, "user.attr".
+ * The name must be prefixed with the namespace followed by ".". For example,
+ * "user.attr".
* <p/>
- * A regular user can only set an xattr for the "user" namespace.
- * The super user can set an xattr of either the "user" or "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * The access permissions of an xattr in the "user" namespace are
- * defined by the file and directory permission bits.
- * An xattr can only be set when the logged-in user has the correct permissions.
- * If the xattr exists, it will be replaced.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to modify
* @param name xattr name.
@@ -1069,21 +1058,10 @@ public abstract class AbstractFileSystem
/**
* Set an xattr of a file or directory.
- * The name must be prefixed with user/trusted/security/system and
- * followed by ".". For example, "user.attr".
- * <p/>
- * A regular user can only set an xattr for the "user" namespace.
- * The super user can set an xattr of either the "user" or "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * The access permissions of an xattr in the "user" namespace are
- * defined by the file and directory permission bits.
- * An xattr can only be set when the logged-in user has the correct permissions.
- * If the xattr exists, it will be replaced.
+ * The name must be prefixed with the namespace followed by ".". For example,
+ * "user.attr".
* <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to modify
* @param name xattr name.
@@ -1099,18 +1077,10 @@ public abstract class AbstractFileSystem
/**
* Get an xattr for a file or directory.
- * The name must be prefixed with user/trusted/security/system and
- * followed by ".". For example, "user.attr".
- * <p/>
- * A regular user can only get an xattr for the "user" namespace.
- * The super user can get an xattr of either the "user" or "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * An xattr will only be returned when the logged-in user has the correct permissions.
+ * The name must be prefixed with the namespace followed by ".". For example,
+ * "user.attr".
* <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to get extended attribute
* @param name xattr name.
@@ -1127,13 +1097,7 @@ public abstract class AbstractFileSystem
* Only those xattrs for which the logged-in user has permissions to view
* are returned.
* <p/>
- * A regular user can only get xattrs for the "user" namespace.
- * The super user can only get xattrs for "user" and "trusted" namespaces.
- * The xattr of "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to get extended attributes
* @return Map<String, byte[]> describing the XAttrs of the file or directory
@@ -1149,13 +1113,7 @@ public abstract class AbstractFileSystem
* Only those xattrs for which the logged-in user has permissions to view
* are returned.
* <p/>
- * A regular user can only get xattrs for the "user" namespace.
- * The super user can only get xattrs for "user" and "trusted" namespaces.
- * The xattr of "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to get extended attributes
* @param names XAttr names.
@@ -1173,14 +1131,7 @@ public abstract class AbstractFileSystem
* Only the xattr names for which the logged-in user has permissions to view
* are returned.
* <p/>
- * A regular user can only get xattr names for the "user" namespace.
- * The super user can only get xattr names for the "user" and "trusted"
- * namespaces.
- * The xattr names in the "security" and "system" namespaces are only
- * used/exposed internally by/to the FS impl.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to get extended attributes
* @return Map<String, byte[]> describing the XAttrs of the file or directory
@@ -1194,21 +1145,10 @@ public abstract class AbstractFileSystem
/**
* Remove an xattr of a file or directory.
- * The name must be prefixed with user/trusted/security/system and
- * followed by ".". For example, "user.attr".
- * <p/>
- * A regular user can only remove an xattr for the "user" namespace.
- * The super user can remove an xattr of either the "user" or "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * The access permissions of an xattr in the "user" namespace are
- * defined by the file and directory permission bits.
- * An xattr can only be set when the logged-in user has the correct permissions.
- * If the xattr exists, it will be replaced.
+ * The name must be prefixed with the namespace followed by ".". For example,
+ * "user.attr".
* <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to remove extended attribute
* @param name xattr name
Modified: hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileContext.java
URL: http://svn.apache.org/viewvc/hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileContext.java?rev=1614547&r1=1614546&r2=1614547&view=diff
==============================================================================
--- hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileContext.java (original)
+++ hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileContext.java Wed Jul 30 05:57:55 2014
@@ -2297,21 +2297,10 @@ public final class FileContext {
/**
* Set an xattr of a file or directory.
- * The name must be prefixed with user/trusted/security/system and
- * followed by ".". For example, "user.attr".
+ * The name must be prefixed with the namespace followed by ".". For example,
+ * "user.attr".
* <p/>
- * A regular user can only set an xattr for the "user" namespace.
- * The super user can set an xattr of either the "user" or "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * The access permissions of an xattr in the "user" namespace are
- * defined by the file and directory permission bits.
- * An xattr can only be set when the logged-in user has the correct permissions.
- * If the xattr exists, it will be replaced.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to modify
* @param name xattr name.
@@ -2326,21 +2315,10 @@ public final class FileContext {
/**
* Set an xattr of a file or directory.
- * The name must be prefixed with user/trusted/security/system and
- * followed by ".". For example, "user.attr".
- * <p/>
- * A regular user can only set an xattr for the "user" namespace.
- * The super user can set an xattr of either the "user" or "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * The access permissions of an xattr in the "user" namespace are
- * defined by the file and directory permission bits.
- * An xattr can only be set when the logged-in user has the correct permissions.
- * If the xattr exists, it will be replaced.
+ * The name must be prefixed with the namespace followed by ".". For example,
+ * "user.attr".
* <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to modify
* @param name xattr name.
@@ -2363,19 +2341,10 @@ public final class FileContext {
/**
* Get an xattr for a file or directory.
- * The name must be prefixed with user/trusted/security/system and
- * followed by ".". For example, "user.attr".
- * <p/>
- *
- * A regular user can only get an xattr for the "user" namespace.
- * The super user can get an xattr of either the "user" or "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * An xattr will only be returned when the logged-in user has the correct permissions.
+ * The name must be prefixed with the namespace followed by ".". For example,
+ * "user.attr".
* <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to get extended attribute
* @param name xattr name.
@@ -2398,13 +2367,7 @@ public final class FileContext {
* Only those xattrs for which the logged-in user has permissions to view
* are returned.
* <p/>
- * A regular user can only get xattrs for the "user" namespace.
- * The super user can only get xattrs for "user" and "trusted" namespaces.
- * The xattr of "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to get extended attributes
* @return Map<String, byte[]> describing the XAttrs of the file or directory
@@ -2426,13 +2389,7 @@ public final class FileContext {
* Only those xattrs for which the logged-in user has permissions to view
* are returned.
* <p/>
- * A regular user can only get xattrs for the "user" namespace.
- * The super user can only get xattrs for "user" and "trusted" namespaces.
- * The xattr of "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to get extended attributes
* @param names XAttr names.
@@ -2453,21 +2410,10 @@ public final class FileContext {
/**
* Remove an xattr of a file or directory.
- * The name must be prefixed with user/trusted/security/system and
- * followed by ".". For example, "user.attr".
+ * The name must be prefixed with the namespace followed by ".". For example,
+ * "user.attr".
* <p/>
- * A regular user can only remove an xattr for the "user" namespace.
- * The super user can remove an xattr of either the "user" or "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * The access permissions of an xattr in the "user" namespace are
- * defined by the file and directory permission bits.
- * An xattr can only be set when the logged-in user has the correct permissions.
- * If the xattr exists, it will be replaced.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to remove extended attribute
* @param name xattr name
@@ -2490,14 +2436,7 @@ public final class FileContext {
* Only those xattr names which the logged-in user has permissions to view
* are returned.
* <p/>
- * A regular user can only get xattr names for the "user" namespace.
- * The super user can only get xattr names for "user" and "trusted"
- * namespaces.
- * The xattrs of the "security" and "system" namespaces are only
- * used/exposed internally by/to the FS impl.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to get extended attributes
* @return List<String> of the XAttr names of the file or directory
Modified: hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileSystem.java
URL: http://svn.apache.org/viewvc/hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileSystem.java?rev=1614547&r1=1614546&r2=1614547&view=diff
==============================================================================
--- hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileSystem.java (original)
+++ hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileSystem.java Wed Jul 30 05:57:55 2014
@@ -2364,21 +2364,10 @@ public abstract class FileSystem extends
/**
* Set an xattr of a file or directory.
- * The name must be prefixed with user/trusted/security/system and
- * followed by ".". For example, "user.attr".
+ * The name must be prefixed with the namespace followed by ".". For example,
+ * "user.attr".
* <p/>
- * A regular user can only set an xattr for the "user" namespace.
- * The super user can set an xattr of either the "user" or "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * The access permissions of an xattr in the "user" namespace are
- * defined by the file and directory permission bits.
- * An xattr can only be set when the logged-in user has the correct permissions.
- * If the xattr exists, it will be replaced.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to modify
* @param name xattr name.
@@ -2393,21 +2382,10 @@ public abstract class FileSystem extends
/**
* Set an xattr of a file or directory.
- * The name must be prefixed with user/trusted/security/system and
- * followed by ".". For example, "user.attr".
- * <p/>
- * A regular user can only set an xattr for the "user" namespace.
- * The super user can set an xattr of either the "user" or "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
+ * The name must be prefixed with the namespace followed by ".". For example,
+ * "user.attr".
* <p/>
- * The access permissions of an xattr in the "user" namespace are
- * defined by the file and directory permission bits.
- * An xattr can only be set if the logged-in user has the correct permissions.
- * If the xattr exists, it is replaced.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to modify
* @param name xattr name.
@@ -2423,20 +2401,10 @@ public abstract class FileSystem extends
/**
* Get an xattr name and value for a file or directory.
- * The name must be prefixed with user/trusted/security/system and
- * followed by ".". For example, "user.attr".
- * <p/>
- *
- * A regular user can only get an xattr for the "user" namespace.
- * The super user can get an xattr of either the "user" or "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
+ * The name must be prefixed with the namespace followed by ".". For example,
+ * "user.attr".
* <p/>
- * An xattr will only be returned if the logged-in user has the
- * correct permissions.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to get extended attribute
* @param name xattr name.
@@ -2453,13 +2421,7 @@ public abstract class FileSystem extends
* Only those xattrs which the logged-in user has permissions to view
* are returned.
* <p/>
- * A regular user can only get xattrs for the "user" namespace.
- * The super user can only get xattrs for "user" and "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to get extended attributes
* @return Map<String, byte[]> describing the XAttrs of the file or directory
@@ -2475,13 +2437,7 @@ public abstract class FileSystem extends
* Only those xattrs which the logged-in user has permissions to view
* are returned.
* <p/>
- * A regular user can only get xattrs for the "user" namespace.
- * The super user can only get xattrs for "user" and "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to get extended attributes
* @param names XAttr names.
@@ -2499,14 +2455,7 @@ public abstract class FileSystem extends
* Only those xattr names which the logged-in user has permissions to view
* are returned.
* <p/>
- * A regular user can only get xattr names for the "user" namespace.
- * The super user can only get xattr names for "user" and "trusted"
- * namespaces.
- * The xattrs of the "security" and "system" namespaces are only
- * used/exposed internally by/to the FS impl.
- * <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to get extended attributes
* @return List<String> of the XAttr names of the file or directory
@@ -2519,21 +2468,10 @@ public abstract class FileSystem extends
/**
* Remove an xattr of a file or directory.
- * The name must be prefixed with user/trusted/security/system and
- * followed by ".". For example, "user.attr".
- * <p/>
- * A regular user can only remove an xattr for the "user" namespace.
- * The super user can remove an xattr of either the "user" or "trusted" namespaces.
- * The xattrs of the "security" and "system" namespaces are only used/exposed
- * internally by/to the FS impl.
- * <p/>
- * The access permissions of an xattr in the "user" namespace are
- * defined by the file and directory permission bits.
- * An xattr can only be set when the logged-in user has the correct permissions.
- * If the xattr exists, it will be replaced.
+ * The name must be prefixed with the namespace followed by ".". For example,
+ * "user.attr".
* <p/>
- * @see <a href="http://en.wikipedia.org/wiki/Extended_file_attributes">
- * http://en.wikipedia.org/wiki/Extended_file_attributes</a>
+ * Refer to the HDFS extended attributes user documentation for details.
*
* @param path Path to remove extended attribute
* @param name xattr name