Package org.apache.hadoop.fs.permission

Class PermissionStatus

java.lang.Object

org.apache.hadoop.fs.permission.PermissionStatus

All Implemented Interfaces:

Writable

@LimitedPrivate({"HDFS","MapReduce"})
@Unstable
public class PermissionStatus
extends java.lang.Object
implements Writable

Store permission related information.

Constructor Summary

Constructors

Constructor	Description
PermissionStatus(java.lang.String user, java.lang.String group, FsPermission permission)	Constructor.

Method Summary

Modifier and Type	Method	Description
static PermissionStatus	createImmutable(java.lang.String user, java.lang.String group, FsPermission permission)	Create an immutable PermissionStatus object.
java.lang.String	getGroupName()	Return group name.
FsPermission	getPermission()	Return permission.
java.lang.String	getUserName()	Return user name.
static PermissionStatus	read(java.io.DataInput in)	Create and initialize a PermissionStatus from DataInput.
void	readFields(java.io.DataInput in)	Deserialize the fields of this object from in.
java.lang.String	toString()
void	write(java.io.DataOutput out)	Serialize the fields of this object to out.
static void	write(java.io.DataOutput out, java.lang.String username, java.lang.String groupname, FsPermission permission)	Serialize a PermissionStatus from its base components.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PermissionStatus

public PermissionStatus(java.lang.String user,
                        java.lang.String group,
                        FsPermission permission)

Constructor.

Parameters:

user - user.

group - group.

permission - permission.

Method Detail

createImmutable

public static PermissionStatus createImmutable(java.lang.String user,
                                               java.lang.String group,
                                               FsPermission permission)

Create an immutable PermissionStatus object.

Parameters:

user - user.

group - group.

permission - permission.

Returns:

PermissionStatus.

getUserName

public java.lang.String getUserName()

Return user name.

Returns:

user name.

getGroupName

public java.lang.String getGroupName()

Return group name.

Returns:

group name.

getPermission

public FsPermission getPermission()

Return permission.

Returns:

FsPermission.

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException

Description copied from interface: Writable

Deserialize the fields of this object from in.

For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Specified by:

readFields in interface Writable

Parameters:

in - DataInput to deseriablize this object from.

Throws:

java.io.IOException - any other problem for readFields.

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Description copied from interface: Writable

Serialize the fields of this object to out.

Specified by:

write in interface Writable

Parameters:

out - DataOuput to serialize this object into.

Throws:

java.io.IOException - any other problem for write.

read

public static PermissionStatus read(java.io.DataInput in)
                             throws java.io.IOException

Create and initialize a PermissionStatus from DataInput.

Parameters:

in - data input.

Returns:

PermissionStatus.

Throws:

java.io.IOException - raised on errors performing I/O.

write

public static void write(java.io.DataOutput out,
                         java.lang.String username,
                         java.lang.String groupname,
                         FsPermission permission)
                  throws java.io.IOException

Serialize a PermissionStatus from its base components.

Parameters:

out - out.

username - username.

groupname - groupname.

permission - FsPermission.

Throws:

java.io.IOException - raised on errors performing I/O.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object