jfilesyslib.data

Class UnixPermissions

java.lang.Object

jfilesyslib.data.UnixPermissions

public class UnixPermissions
extends java.lang.Object

Represents unix permissions

Author:

Marc Miltenberger

Field Summary

Fields

Modifier and Type	Field and Description
static UnixPermissions	DefaultDirectoryPermissions The default directory permissions
static UnixPermissions	DefaultFilePermissions The default file permissions

Constructor Summary

Constructors

Constructor and Description
UnixPermissions(boolean ownerR, boolean ownerW, boolean ownerX, boolean groupR, boolean groupW, boolean groupX, boolean othersR, boolean othersW, boolean othersX, boolean suid, boolean sgid, boolean sticky) Creates a new UnixPermissions object
UnixPermissions(boolean ownerR, boolean ownerW, boolean ownerX, boolean groupR, boolean groupW, boolean groupX, boolean othersR, boolean othersW, boolean othersX, boolean suid, boolean sgid, boolean sticky, int uid, int gid) Creates a new UnixPermissions object
UnixPermissions(int permissions) Creates a new UnixPermissions object
UnixPermissions(int permissions, int uid, int gid) Creates a new UnixPermissions object

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getGid() Sets the owner group id
int	getPermissions() Returns the permissions as a number
int	getUid() Returns the owner user id
int	hashCode()
boolean	isGroupExecute() Returns true if the group may execute
boolean	isGroupRead() Returns true if the group may read
boolean	isGroupWrite() Returns true if the group may write
boolean	isOthersExecute() Returns true if the others may execute
boolean	isOthersRead() Returns true if the others may read
boolean	isOthersWrite() Returns true if the others may write
boolean	isOwnerExecute() Returns true if the owner may execute
boolean	isOwnerRead() Returns true if the owner may read
boolean	isOwnerWrite() Returns true if the owner may write
boolean	isSgid() Returns the sgid bit.
boolean	isSticky() Returns the sticky bit
boolean	isSuid() Returns the suid bit.
void	setGid(int gid) Returns the owner group id
void	setGroupExecute(boolean groupExecute) Sets the group execute permission
void	setGroupRead(boolean groupRead) Sets the group read permission
void	setGroupWrite(boolean groupWrite) Sets the group write permission
void	setOthersExecute(boolean othersExecute) Sets the others execute permission
void	setOthersRead(boolean othersRead) Sets the others read permission
void	setOthersWrite(boolean othersWrite) Sets the others write permission
void	setOwnerExecute(boolean ownerExecute) Sets the owner execute permission
void	setOwnerRead(boolean ownerRead) Sets the owner read permission
void	setOwnerWrite(boolean ownerWrite) Sets the owner write permission
void	setPermissions(int permissions) Sets the permissions (but not the user id or group id).
void	setSgid(boolean sgid) Sets the sgid bit.
void	setSticky(boolean sticky) Sets the sticky bit
void	setSuid(boolean suid) Sets the suid bit.
void	setUid(int uid) Sets the owner user id
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DefaultDirectoryPermissions

public static final UnixPermissions DefaultDirectoryPermissions

The default directory permissions

DefaultFilePermissions

public static final UnixPermissions DefaultFilePermissions

The default file permissions

Constructor Detail

UnixPermissions

public UnixPermissions(int permissions)

Creates a new UnixPermissions object

Parameters:

permissions - the permissions

UnixPermissions

public UnixPermissions(int permissions,
               int uid,
               int gid)

Creates a new UnixPermissions object

Parameters:

permissions - the permissions

uid - the owner user id

gid - the owner group id

UnixPermissions

public UnixPermissions(boolean ownerR,
               boolean ownerW,
               boolean ownerX,
               boolean groupR,
               boolean groupW,
               boolean groupX,
               boolean othersR,
               boolean othersW,
               boolean othersX,
               boolean suid,
               boolean sgid,
               boolean sticky)

Creates a new UnixPermissions object

Parameters:

ownerR - whether the owner may read

ownerW - whether the owner may write

ownerX - whether the owner may execute a file/read a directory

groupR - whether the group may read

groupW - whether the group may write

groupX - whether the group may execute a file/read a directory

othersR - whether others may read

othersW - whether others may write

othersX - whether others may execute a file/read a directory

suid - the SUID bit

sgid - the SGID bit

sticky - the sticky bit

UnixPermissions

public UnixPermissions(boolean ownerR,
               boolean ownerW,
               boolean ownerX,
               boolean groupR,
               boolean groupW,
               boolean groupX,
               boolean othersR,
               boolean othersW,
               boolean othersX,
               boolean suid,
               boolean sgid,
               boolean sticky,
               int uid,
               int gid)

Creates a new UnixPermissions object

Parameters:

ownerR - whether the owner may read

ownerW - whether the owner may write

ownerX - whether the owner may execute a file/read a directory

groupR - whether the group may read

groupW - whether the group may write

groupX - whether the group may execute a file/read a directory

othersR - whether others may read

othersW - whether others may write

othersX - whether others may execute a file/read a directory

suid - the SUID bit

sgid - the SGID bit

sticky - the sticky bit

uid - the owner user id

gid - the owner group id

Method Detail

getUid

public int getUid()

Returns the owner user id

Returns:

the uid

setUid

public void setUid(int uid)

Sets the owner user id

Parameters:

uid - the uid to set

getGid

public int getGid()

Sets the owner group id

Returns:

the gid

setGid

public void setGid(int gid)

Returns the owner group id

Parameters:

gid - the gid to set

isOwnerRead

public boolean isOwnerRead()

Returns true if the owner may read

Returns:

true if the owner may read

setOwnerRead

public void setOwnerRead(boolean ownerRead)

Sets the owner read permission

Parameters:

ownerRead - whether the owner may read

isOwnerWrite

public boolean isOwnerWrite()

Returns true if the owner may write

Returns:

true if the owner may write

setOwnerWrite

public void setOwnerWrite(boolean ownerWrite)

Sets the owner write permission

Parameters:

ownerWrite - whether the owner may read

isOwnerExecute

public boolean isOwnerExecute()

Returns true if the owner may execute

Returns:

true if the owner may execute

setOwnerExecute

public void setOwnerExecute(boolean ownerExecute)

Sets the owner execute permission

Parameters:

ownerExecute - whether the owner may execute

isGroupRead

public boolean isGroupRead()

Returns true if the group may read

Returns:

true if the group may read

setGroupRead

public void setGroupRead(boolean groupRead)

Sets the group read permission

Parameters:

groupRead - whether the group may read

isGroupWrite

public boolean isGroupWrite()

Returns true if the group may write

Returns:

true if the group may write

setGroupWrite

public void setGroupWrite(boolean groupWrite)

Sets the group write permission

Parameters:

groupWrite - whether the group may read

isGroupExecute

public boolean isGroupExecute()

Returns true if the group may execute

Returns:

true if the group may execute

setGroupExecute

public void setGroupExecute(boolean groupExecute)

Sets the group execute permission

Parameters:

groupExecute - whether the group may execute

isOthersRead

public boolean isOthersRead()

Returns true if the others may read

Returns:

true if the others may read

setOthersRead

public void setOthersRead(boolean othersRead)

Sets the others read permission

Parameters:

othersRead - whether the others may read

isOthersWrite

public boolean isOthersWrite()

Returns true if the others may write

Returns:

true if the others may write

setOthersWrite

public void setOthersWrite(boolean othersWrite)

Sets the others write permission

Parameters:

othersWrite - whether the others may read

isOthersExecute

public boolean isOthersExecute()

Returns true if the others may execute

Returns:

true if the others may execute

setOthersExecute

public void setOthersExecute(boolean othersExecute)

Sets the others execute permission

Parameters:

othersExecute - whether the others may execute

isSuid

public boolean isSuid()

Returns the suid bit.

Returns:

the suid

See Also:

https://en.wikipedia.org/wiki/Setuid

setSuid

public void setSuid(boolean suid)

Sets the suid bit.

Parameters:

suid - the suid bit

See Also:

https://en.wikipedia.org/wiki/Setuid

isSgid

public boolean isSgid()

Returns the sgid bit.

Returns:

the sgid

See Also:

https://en.wikipedia.org/wiki/Setuid

setSgid

public void setSgid(boolean sgid)

Sets the sgid bit.

Parameters:

suid - the sgid bit

See Also:

https://en.wikipedia.org/wiki/Setuid

isSticky

public boolean isSticky()

Returns the sticky bit

Returns:

the sticky

See Also:

https://en.wikipedia.org/wiki/Sticky_bit

setSticky

public void setSticky(boolean sticky)

Sets the sticky bit

Parameters:

sticky - the sticky bit

See Also:

https://en.wikipedia.org/wiki/Sticky_bit

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setPermissions

public void setPermissions(int permissions)

Sets the permissions (but not the user id or group id).

Parameters:

permissions - the permissions in numeric notation

See Also:

https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation

getPermissions

public int getPermissions()

Returns the permissions as a number

Returns:

the permissions in numeric notation

See Also:

https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object