alluxio.security.authorization

Class Mode

java.lang.Object

alluxio.security.authorization.Mode

@PublicApi
 @NotThreadSafe
public final class Mode
extends Object

POSIX style file/directory access mode.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mode.Bits Mode bits.

Constructor Summary

Constructors

Constructor and Description
Mode(Mode.Bits ownerBits, Mode.Bits groupBits, Mode.Bits otherBits) Constructs an instance of Mode with the given Mode.Bits.
Mode(Mode mode) Copy constructor.
Mode(short mode) Constructs an instance of Mode with the given mode.

Method Summary

Modifier and Type	Method and Description
static Mode	and(Mode mode1, Mode mode2)
static Mode	createFullAccess() Creates the "full access" mode.
static Mode	createNoAccess() Creates the "no access" mode.
static Mode	defaults() Gets the default mode.
boolean	equals(Object obj)
static Mode.Bits	extractGroupBits(short mode)
static Mode.Bits	extractOtherBits(short mode)
static Mode.Bits	extractOwnerBits(short mode)
static Mode	fromProto(PMode pMode) Creates Mode from proto PMode.
void	fromShort(short n) Sets Mode bits using a digital representation.
Mode.Bits	getGroupBits()
Mode.Bits	getOtherBits()
Mode.Bits	getOwnerBits()
int	hashCode()
void	setGroupBits(Mode.Bits bits) Sets group bits.
void	setOtherBits(Mode.Bits bits) Sets other bits.
void	setOwnerBits(Mode.Bits bits) Sets owner bits.
PMode	toProto()
short	toShort() Encodes the object as a short.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Mode

public Mode(Mode.Bits ownerBits,
            Mode.Bits groupBits,
            Mode.Bits otherBits)

Constructs an instance of Mode with the given Mode.Bits.

Parameters:

ownerBits - the owner Mode.Bits

groupBits - the group Mode.Bits

otherBits - the other Mode.Bits

Mode

public Mode(short mode)

Constructs an instance of Mode with the given mode.

Parameters:

mode - the digital representation of a Mode

See Also:

toShort()

Mode

public Mode(Mode mode)

Copy constructor.

Parameters:

mode - another Mode

Method Detail

defaults

public static Mode defaults()

Gets the default mode.

Returns:

the default Mode

createNoAccess

public static Mode createNoAccess()

Creates the "no access" mode.

Returns:

the none Mode

createFullAccess

public static Mode createFullAccess()

Creates the "full access" mode.

Returns:

the none Mode

and

public static Mode and(Mode mode1,
                       Mode mode2)

Parameters:

mode1 - first mode of the and operation

mode2 - second mode of the and operation

Returns:

the AND result of the two Modes

getOwnerBits

public Mode.Bits getOwnerBits()

Returns:

the owner Mode.Bits

extractOwnerBits

public static Mode.Bits extractOwnerBits(short mode)

Parameters:

mode - the digital representation of a Mode

Returns:

the owner Mode.Bits

setOwnerBits

public void setOwnerBits(Mode.Bits bits)

Sets owner bits.

Parameters:

bits - the owner bits to set

getGroupBits

public Mode.Bits getGroupBits()

Returns:

the group Mode.Bits

extractGroupBits

public static Mode.Bits extractGroupBits(short mode)

Parameters:

mode - the digital representation of a Mode

Returns:

the group Mode.Bits

setGroupBits

public void setGroupBits(Mode.Bits bits)

Sets group bits.

Parameters:

bits - the group bits to set

getOtherBits

public Mode.Bits getOtherBits()

Returns:

the other Mode.Bits

extractOtherBits

public static Mode.Bits extractOtherBits(short mode)

Parameters:

mode - the digital representation of a Mode

Returns:

the other Mode.Bits

setOtherBits

public void setOtherBits(Mode.Bits bits)

Sets other bits.

Parameters:

bits - the other bits to set

fromShort

public void fromShort(short n)

Sets Mode bits using a digital representation.

Parameters:

n - the digital representation of a Mode

toShort

public short toShort()

Encodes the object as a short.

Returns:

the digital representation of this Mode

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

fromProto

public static Mode fromProto(PMode pMode)

Creates Mode from proto PMode.

Parameters:

pMode - proto mode

Returns:

created mode

toProto

public PMode toProto()

Returns:

proto representation of this mode instance