Package org.irods.irods4j.high_level.vfs

Class IRODSFilesystem

java.lang.Object

org.irods.irods4j.high_level.vfs.IRODSFilesystem

public class IRODSFilesystem
extends Object

A class providing high-level functions for working with collections and data objects.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IRODSFilesystem.CopyOptions	Defines bitmask values which influence the behavior of a copy operation.
static enum	IRODSFilesystem.RemoveOptions	Defines values which influence the behavior of a remove operation.

Field Summary

Fields

Modifier and Type	Field	Description
static final AdminTag	asAdmin	Instructs the server to execute operations using rodsadmin level privileges.

Constructor Summary

Constructors

Constructor	Description
IRODSFilesystem()

Method Summary

Modifier and Type	Method	Description
static void	copy(IRODSApi.RcComm comm, String from, String to)
static void	copy(IRODSApi.RcComm comm, String from, String to, int copyOptions)
static boolean	copyDataObject(IRODSApi.RcComm comm, String from, String to)
static boolean	copyDataObject(IRODSApi.RcComm comm, String from, String to, int copyOptions)
static boolean	createCollection(IRODSApi.RcComm comm, String path)
static boolean	createCollection(IRODSApi.RcComm comm, String path, String existingPath)
static boolean	createCollections(IRODSApi.RcComm comm, String path)
static String	dataObjectChecksum(IRODSApi.RcComm comm, String path)	TODO
static long	dataObjectSize(IRODSApi.RcComm comm, String path)
static void	enableInheritance(AdminTag adminTag, IRODSApi.RcComm comm, String path, boolean enable)	TODO
static void	enableInheritance(IRODSApi.RcComm comm, String path, boolean enable)	TODO
static boolean	equivalent(IRODSApi.RcComm comm, String path1, String path2)
static boolean	exists(ObjectStatus status)	Checks if a filesystem object is known to the catalog.
static boolean	exists(IRODSApi.RcComm comm, String path)	Checks if a filesystem object is known to the catalog.
static boolean	isCollection(ObjectStatus status)	Checks if the filesystem object is a collection.
static boolean	isCollection(IRODSApi.RcComm comm, String path)
static boolean	isCollectionRegistered(IRODSApi.RcComm comm, String path)
static boolean	isDataObject(ObjectStatus status)
static boolean	isDataObject(IRODSApi.RcComm comm, String path)
static boolean	isDataObjectRegistered(IRODSApi.RcComm comm, String path)
static boolean	isEmpty(IRODSApi.RcComm comm, String path)
static boolean	isOther(ObjectStatus status)
static boolean	isOther(IRODSApi.RcComm comm, String path)
static boolean	isSpecialCollection(IRODSApi.RcComm comm, String path)
static long	lastWriteTime(IRODSApi.RcComm comm, String path)	Returns the time of the last modification to a filesystem object as epoch seconds.
static void	lastWriteTime(IRODSApi.RcComm comm, String path, long newModifyTime)
static void	permissions(AdminTag adminTag, IRODSApi.RcComm comm, String path, String userOrGroup, Permission prms)
static void	permissions(IRODSApi.RcComm comm, String path, String userOrGroup, Permission prms)
static boolean	remove(IRODSApi.RcComm comm, String path)
static boolean	remove(IRODSApi.RcComm comm, String path, IRODSFilesystem.RemoveOptions removeOptions)
static void	removeAll(IRODSApi.RcComm comm, String path)
static void	removeAll(IRODSApi.RcComm comm, String path, IRODSFilesystem.RemoveOptions removeOptions)
static void	rename(IRODSApi.RcComm comm, String oldPath, String newPath)
static ObjectStatus	status(IRODSApi.RcComm comm, String path)	TODO
static boolean	statusKnown(ObjectStatus status)	Checks if the filesystem object's type is known.

Methods inherited from class java.lang.Object

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

Field Details

asAdmin

public static final AdminTag asAdmin

Instructs the server to execute operations using rodsadmin level privileges.

Since:

0.1.0

Constructor Details

IRODSFilesystem

public IRODSFilesystem()

Method Details

copy

public static void copy(IRODSApi.RcComm comm,
 String from,
 String to,
 int copyOptions)
                 throws IRODSFilesystemException,
IOException,
IRODSException

Parameters:

comm -

from -

to -

copyOptions -

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

copy

public static void copy(IRODSApi.RcComm comm,
 String from,
 String to)
                 throws IRODSFilesystemException,
IOException,
IRODSException

Parameters:

comm -

from -

to -

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

copyDataObject

public static boolean copyDataObject(IRODSApi.RcComm comm,
 String from,
 String to,
 int copyOptions)
                              throws IRODSFilesystemException,
IOException,
IRODSException

Parameters:

comm -

from -

to -

copyOptions -

Returns:

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

copyDataObject

public static boolean copyDataObject(IRODSApi.RcComm comm,
 String from,
 String to)
                              throws IRODSFilesystemException,
IOException,
IRODSException

Parameters:

comm -

from -

to -

Returns:

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

createCollection

public static boolean createCollection(IRODSApi.RcComm comm,
 String path)
                                throws IOException,
IRODSFilesystemException

Parameters:

comm -

path -

Returns:

Throws:

IOException

IRODSFilesystemException

Since:

0.1.0

createCollection

public static boolean createCollection(IRODSApi.RcComm comm,
 String path,
 String existingPath)
                                throws IRODSFilesystemException,
IOException,
IRODSException

Parameters:

comm -

path -

existingPath -

Returns:

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

createCollections

public static boolean createCollections(IRODSApi.RcComm comm,
 String path)
                                 throws IRODSFilesystemException,
IOException,
IRODSException

Parameters:

comm -

path -

Returns:

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

exists

public static boolean exists(ObjectStatus status)

Checks if a filesystem object is known to the catalog.

Parameters:

status - The ObjectStatus of the filesystem object.

Since:

0.1.0

exists

public static boolean exists(IRODSApi.RcComm comm,
 String path)
                      throws IRODSFilesystemException,
IOException,
IRODSException

Checks if a filesystem object is known to the catalog.

Parameters:

comm - A connection to the iRODS server.

path - A path identifying the filesystem object.

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

isCollectionRegistered

public static boolean isCollectionRegistered(IRODSApi.RcComm comm,
 String path)
                                      throws IOException,
IRODSException

Parameters:

comm -

path -

Returns:

Throws:

IOException

IRODSException

Since:

0.1.0

isDataObjectRegistered

public static boolean isDataObjectRegistered(IRODSApi.RcComm comm,
 String path)
                                      throws IOException,
IRODSException

Parameters:

comm -

path -

Returns:

Throws:

IOException

IRODSException

Since:

0.1.0

equivalent

public static boolean equivalent(IRODSApi.RcComm comm,
 String path1,
 String path2)
                          throws IOException,
IRODSException

Parameters:

comm -

path1 -

path2 -

Returns:

Throws:

IOException

IRODSException

Since:

0.1.0

dataObjectSize

public static long dataObjectSize(IRODSApi.RcComm comm,
 String path)
                           throws IRODSFilesystemException,
IOException,
IRODSException

Parameters:

comm -

path -

Returns:

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

isCollection

public static boolean isCollection(ObjectStatus status)

Checks if the filesystem object is a collection.

Parameters:

status - The ObjectStatus of the filesystem object.

Since:

0.1.0

isCollection

public static boolean isCollection(IRODSApi.RcComm comm,
 String path)
                            throws IRODSFilesystemException,
IOException,
IRODSException

Parameters:

comm -

path -

Returns:

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

isDataObject

public static boolean isDataObject(ObjectStatus status)

Parameters:

status -

Since:

0.1.0

isDataObject

public static boolean isDataObject(IRODSApi.RcComm comm,
 String path)
                            throws IRODSFilesystemException,
IOException,
IRODSException

Parameters:

comm -

path -

Returns:

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

isOther

public static boolean isOther(ObjectStatus status)

Parameters:

status -

Since:

0.1.0

isOther

public static boolean isOther(IRODSApi.RcComm comm,
 String path)
                       throws IRODSFilesystemException,
IOException,
IRODSException

Parameters:

comm -

path -

Returns:

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

isSpecialCollection

public static boolean isSpecialCollection(IRODSApi.RcComm comm,
 String path)
                                   throws IOException,
IRODSException

Parameters:

comm -

path -

Returns:

Throws:

IOException

IRODSException

Since:

0.1.0

isEmpty

public static boolean isEmpty(IRODSApi.RcComm comm,
 String path)
                       throws IRODSFilesystemException,
IOException,
IRODSException

Parameters:

comm -

path -

Returns:

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

lastWriteTime

public static long lastWriteTime(IRODSApi.RcComm comm,
 String path)
                          throws IRODSFilesystemException,
IOException,
IRODSException

Returns the time of the last modification to a filesystem object as epoch seconds. If the filesystem object identifies a data object, only good replicas will be considered. If no good replicas exists, an exception will be thrown.

Parameters:

comm - A connection to the iRODS server.

path - The logical path identifying a collection or data object.

Returns:

The modification time as seconds since epoch.

Throws:

IRODSFilesystemException

IOException

IRODSException

Since:

0.1.0

lastWriteTime

public static void lastWriteTime(IRODSApi.RcComm comm,
 String path,
 long newModifyTime)
                          throws IOException,
IRODSException

Parameters:

comm -

path -

newModifyTime -

Throws:

IOException

IRODSException

Since:

0.1.0

remove

public static boolean remove(IRODSApi.RcComm comm,
 String path,
 IRODSFilesystem.RemoveOptions removeOptions)
                      throws IOException,
IRODSException

Parameters:

comm -

path -

removeOptions -

Returns:

Throws:

IOException

IRODSException

remove

public static boolean remove(IRODSApi.RcComm comm,
 String path)
                      throws IOException,
IRODSException

Parameters:

comm -

path -

Returns:

Throws:

IOException

IRODSException

removeAll

public static void removeAll(IRODSApi.RcComm comm,
 String path,
 IRODSFilesystem.RemoveOptions removeOptions)
                      throws IOException,
IRODSException

Parameters:

comm -

path -

removeOptions -

Throws:

IOException

IRODSException

removeAll

public static void removeAll(IRODSApi.RcComm comm,
 String path)
                      throws IOException,
IRODSException

Parameters:

comm -

path -

Throws:

IOException

IRODSException

permissions

public static void permissions(IRODSApi.RcComm comm,
 String path,
 String userOrGroup,
 Permission prms)
                        throws IRODSFilesystemException,
IOException

Parameters:

comm -

path -

userOrGroup -

prms -

Throws:

IRODSFilesystemException

IOException

Since:

0.1.0

permissions

public static void permissions(AdminTag adminTag,
 IRODSApi.RcComm comm,
 String path,
 String userOrGroup,
 Permission prms)
                        throws IRODSFilesystemException,
IOException

Parameters:

adminTag -

comm -

path -

userOrGroup -

prms -

Throws:

IRODSFilesystemException

IOException

Since:

0.1.0

enableInheritance

public static void enableInheritance(IRODSApi.RcComm comm,
 String path,
 boolean enable)
                              throws IOException,
IRODSException

TODO

Parameters:

comm -

path -

enable -

Throws:

IOException

IRODSException

Since:

0.1.0

enableInheritance

public static void enableInheritance(AdminTag adminTag,
 IRODSApi.RcComm comm,
 String path,
 boolean enable)
                              throws IOException,
IRODSException

TODO

Parameters:

adminTag -

comm -

path -

enable -

Throws:

IOException

IRODSException

Since:

0.1.0

rename

public static void rename(IRODSApi.RcComm comm,
 String oldPath,
 String newPath)
                   throws IOException,
IRODSException

Throws:

IOException

IRODSException

status

public static ObjectStatus status(IRODSApi.RcComm comm,
 String path)
                           throws IOException,
IRODSException,
IRODSFilesystemException

TODO

Parameters:

comm -

path -

Returns:

Throws:

IOException

IRODSException

IRODSFilesystemException

Since:

0.1.0

statusKnown

public static boolean statusKnown(ObjectStatus status)

Checks if the filesystem object's type is known.

Parameters:

status - The filesystem object's status.

Since:

0.1.0

dataObjectChecksum

public static String dataObjectChecksum(IRODSApi.RcComm comm,
 String path)
                                 throws IRODSFilesystemException,
NumberFormatException,
IOException,
IRODSException

TODO

Parameters:

comm -

path -

Returns:

Throws:

IRODSFilesystemException

IRODSException

IOException

NumberFormatException

Since:

0.1.0