Package org.irods.irods4j.low_level.api

Class IRODSApi

java.lang.Object

org.irods.irods4j.low_level.api.IRODSApi

public class IRODSApi
extends Object

A low-level class providing functions mirroring the iRODS C API. All public API functions share identical names with the C API. Users should prefer the abstractions provided by the high_level package in production code. Use of the functions provided by this class should be a last resort.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IRODSApi.ByteArrayReference	A class acting as a reference to a byte array.
static final class	IRODSApi.ConnectionOptions	A class which enables users to configure various connection options.
static class	IRODSApi.RcComm	The iRODS connection object which enables communication with an iRODS server.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Constructor	Description
IRODSApi()

Method Summary

Modifier and Type	Method	Description
static int	rcAtomicApplyAclOperations(IRODSApi.RcComm comm, String input, Reference<String> output)
static int	rcAtomicApplyMetadataOperations(IRODSApi.RcComm comm, String input, Reference<String> output)
static void	rcAuthenticateClient(IRODSApi.RcComm comm, AuthPlugin authPlugin, String password)
static int	rcCheckAuthCredentials(IRODSApi.RcComm comm, DataObjInp_PI input, Reference<Integer> output)
static int	rcCloseCollection(IRODSApi.RcComm comm, int handle)
static int	rcCollCreate(IRODSApi.RcComm comm, CollInpNew_PI input)
static IRODSApi.RcComm	rcConnect(String host, int port, String clientUsername, String clientUserZone, Optional<String> proxyUsername, Optional<String> proxyUserZone, Optional<IRODSApi.ConnectionOptions> options, Optional<RErrMsg_PI> errorInfo)
static int	rcDataObjChksum(IRODSApi.RcComm comm, DataObjInp_PI input, Reference<String> output)
static int	rcDataObjCopy(IRODSApi.RcComm comm, DataObjCopyInp_PI input, Reference<TransferStat_PI> output)
static int	rcDataObjCreate(IRODSApi.RcComm comm, DataObjInp_PI input)
static int	rcDataObjectModifyInfo(IRODSApi.RcComm comm, ModDataObjMeta_PI input)
static int	rcDataObjLseek(IRODSApi.RcComm comm, OpenedDataObjInp_PI input, Reference<FileLseekOut_PI> output)
static int	rcDataObjRead(IRODSApi.RcComm comm, OpenedDataObjInp_PI input, IRODSApi.ByteArrayReference byteArray)
static int	rcDataObjRename(IRODSApi.RcComm comm, DataObjCopyInp_PI input)
static int	rcDataObjRepl(IRODSApi.RcComm comm, DataObjInp_PI input, Reference<TransferStat_PI> output)
static int	rcDataObjTrim(IRODSApi.RcComm comm, DataObjInp_PI input)
static int	rcDataObjUnlink(IRODSApi.RcComm comm, DataObjInp_PI input)
static int	rcDataObjWrite(IRODSApi.RcComm comm, OpenedDataObjInp_PI input, byte[] buffer)
static int	rcDelayRuleLock(IRODSApi.RcComm comm, DelayRuleLockInput_PI input)
static int	rcDelayRuleUnlock(IRODSApi.RcComm comm, DelayRuleUnlockInput_PI input)
static void	rcDisconnect(IRODSApi.RcComm comm)
static int	rcExecMyRule(IRODSApi.RcComm comm, ExecMyRuleInp_PI input, Reference<MsParamArray_PI> output)
static int	rcGeneralAdmin(IRODSApi.RcComm comm, GeneralAdminInp_PI input)
static int	rcGenQuery(IRODSApi.RcComm comm, GenQueryInp_PI input, Reference<GenQueryOut_PI> output)
static int	rcGenQuery2(IRODSApi.RcComm comm, Genquery2Input_PI input, Reference<String> output)
static int	rcGetDelayRuleInfo(IRODSApi.RcComm comm, String input, Reference<String> output)
static int	rcGetFileDescriptorInfo(IRODSApi.RcComm comm, String input, Reference<String> output)
static int	rcGetGridConfigurationValue(IRODSApi.RcComm comm, GridConfigurationInp_PI input, Reference<GridConfigurationOut_PI> output)
static int	rcGetLibraryFeatures(IRODSApi.RcComm comm, Reference<String> output)
static int	rcGetMiscSvrInfo(IRODSApi.RcComm comm, Reference<MiscSvrInfo_PI> output)
static int	rcGetResourceInfoForOperation(IRODSApi.RcComm comm, DataObjInp_PI input, Reference<String> output)
static int	rcModAccessControl(IRODSApi.RcComm comm, ModAccessControlInp_PI input)
static int	rcModAVUMetadata(IRODSApi.RcComm comm, ModAVUMetadataInp_PI input)
static int	rcModColl(IRODSApi.RcComm comm, CollInpNew_PI input)
static int	rcModDataObjMeta(IRODSApi.RcComm comm, ModDataObjMeta_PI input)
static int	rcObjStat(IRODSApi.RcComm comm, DataObjInp_PI input, Reference<RodsObjStat_PI> output)
static int	rcOpenCollection(IRODSApi.RcComm comm, CollInpNew_PI input)
static int	rcProcStat(IRODSApi.RcComm comm, ProcStatInp_PI input, Reference<GenQueryOut_PI> output)
static int	rcReadCollection(IRODSApi.RcComm comm, int handle, Reference<CollEnt_PI> output)
static int	rcRegisterPhysicalPath(IRODSApi.RcComm comm, DataObjInp_PI input, Reference<String> output)
static int	rcReplicaClose(IRODSApi.RcComm comm, String closeOptions)
static int	rcReplicaOpen(IRODSApi.RcComm comm, DataObjInp_PI input, Reference<String> output)
static int	rcReplicaTruncate(IRODSApi.RcComm comm, DataObjInp_PI input, Reference<String> output)
static int	rcRmColl(IRODSApi.RcComm comm, CollInpNew_PI input, Reference<CollOprStat_PI> output)
static int	rcRuleExecDel(IRODSApi.RcComm comm, RULE_EXEC_DEL_INP_PI input)
static int	rcRuleExecMod(IRODSApi.RcComm comm, RULE_EXEC_MOD_INP_PI input)
static int	rcRuleExecSubmit(IRODSApi.RcComm comm, RULE_EXEC_DEL_INP_PI input, Reference<String> output)
static int	rcSetDelayServerMigrationInfo(IRODSApi.RcComm comm, DelayServerMigrationInp_PI input)
static int	rcSetGridConfigurationValue(IRODSApi.RcComm comm, GridConfigurationInp_PI input)
static int	rcSpecificQuery(IRODSApi.RcComm comm, SpecificQueryInp_PI input, Reference<GenQueryOut_PI> output)
static int	rcSwitchUser(IRODSApi.RcComm comm, SwitchUserInp_PI input)
static int	rcTicketAdmin(IRODSApi.RcComm comm, TicketAdminInp_PI input)
static int	rcTouch(IRODSApi.RcComm comm, String input)
static int	rcUnregDataObj(IRODSApi.RcComm comm, UnregDataObj_PI input)
static int	rcUserAdmin(IRODSApi.RcComm comm, UserAdminInp_PI input)
static int	rcZoneReport(IRODSApi.RcComm comm, Reference<BytesBuf_PI> output)
static void	setApplicationName(String name)	Sets the global application name identifying the client to the iRODS server.

Methods inherited from class java.lang.Object

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

Field Details

log

public static final org.apache.logging.log4j.Logger log

Constructor Details

IRODSApi

public IRODSApi()

Method Details

setApplicationName

public static void setApplicationName(String name)

Sets the global application name identifying the client to the iRODS server. This function is designed to be called only once. Attempting to call it more than one time will result in an exception. All connections made to the iRODS server will share the name set by this function. Users of this library should call this function before establishing any connections to an iRODS server.

Parameters:

name - The name used by the iRODS server to identify the client application.

Since:

0.1.0

rcConnect

public static IRODSApi.RcComm rcConnect(String host,
 int port,
 String clientUsername,
 String clientUserZone,
 Optional<String> proxyUsername,
 Optional<String> proxyUserZone,
 Optional<IRODSApi.ConnectionOptions> options,
 Optional<RErrMsg_PI> errorInfo)
                                 throws Exception

Throws:

Exception

rcDisconnect

public static void rcDisconnect(IRODSApi.RcComm comm)
                         throws IOException

Throws:

IOException

rcAuthenticateClient

public static void rcAuthenticateClient(IRODSApi.RcComm comm,
 AuthPlugin authPlugin,
 String password)
                                 throws Exception

Throws:

Exception

rcObjStat

public static int rcObjStat(IRODSApi.RcComm comm,
 DataObjInp_PI input,
 Reference<RodsObjStat_PI> output)
                     throws IOException

Throws:

IOException

rcGenQuery

public static int rcGenQuery(IRODSApi.RcComm comm,
 GenQueryInp_PI input,
 Reference<GenQueryOut_PI> output)
                      throws IOException

Throws:

IOException

rcGenQuery2

public static int rcGenQuery2(IRODSApi.RcComm comm,
 Genquery2Input_PI input,
 Reference<String> output)
                       throws IOException

Throws:

IOException

rcReplicaOpen

public static int rcReplicaOpen(IRODSApi.RcComm comm,
 DataObjInp_PI input,
 Reference<String> output)
                         throws IOException

Throws:

IOException

rcReplicaTruncate

public static int rcReplicaTruncate(IRODSApi.RcComm comm,
 DataObjInp_PI input,
 Reference<String> output)
                             throws IOException

Throws:

IOException

rcDataObjLseek

public static int rcDataObjLseek(IRODSApi.RcComm comm,
 OpenedDataObjInp_PI input,
 Reference<FileLseekOut_PI> output)
                          throws IOException

Throws:

IOException

rcDataObjRead

public static int rcDataObjRead(IRODSApi.RcComm comm,
 OpenedDataObjInp_PI input,
 IRODSApi.ByteArrayReference byteArray)
                         throws IOException

Throws:

IOException

rcDataObjWrite

public static int rcDataObjWrite(IRODSApi.RcComm comm,
 OpenedDataObjInp_PI input,
 byte[] buffer)
                          throws IOException

Throws:

IOException

rcReplicaClose

public static int rcReplicaClose(IRODSApi.RcComm comm,
 String closeOptions)
                          throws IOException

Throws:

IOException

rcAtomicApplyMetadataOperations

public static int rcAtomicApplyMetadataOperations(IRODSApi.RcComm comm,
 String input,
 Reference<String> output)
                                           throws IOException

Throws:

IOException

rcAtomicApplyAclOperations

public static int rcAtomicApplyAclOperations(IRODSApi.RcComm comm,
 String input,
 Reference<String> output)
                                      throws IOException

Throws:

IOException

rcTouch

public static int rcTouch(IRODSApi.RcComm comm,
 String input)
                   throws IOException

Throws:

IOException

rcGetGridConfigurationValue

public static int rcGetGridConfigurationValue(IRODSApi.RcComm comm,
 GridConfigurationInp_PI input,
 Reference<GridConfigurationOut_PI> output)
                                       throws IOException

Throws:

IOException

rcSetGridConfigurationValue

public static int rcSetGridConfigurationValue(IRODSApi.RcComm comm,
 GridConfigurationInp_PI input)
                                       throws IOException

Throws:

IOException

rcSetDelayServerMigrationInfo

public static int rcSetDelayServerMigrationInfo(IRODSApi.RcComm comm,
 DelayServerMigrationInp_PI input)
                                         throws IOException

Throws:

IOException

rcGetDelayRuleInfo

public static int rcGetDelayRuleInfo(IRODSApi.RcComm comm,
 String input,
 Reference<String> output)
                              throws IOException

Throws:

IOException

rcGetFileDescriptorInfo

public static int rcGetFileDescriptorInfo(IRODSApi.RcComm comm,
 String input,
 Reference<String> output)
                                   throws IOException

Throws:

IOException

rcSwitchUser

public static int rcSwitchUser(IRODSApi.RcComm comm,
 SwitchUserInp_PI input)
                        throws IOException

Throws:

IOException

rcCheckAuthCredentials

public static int rcCheckAuthCredentials(IRODSApi.RcComm comm,
 DataObjInp_PI input,
 Reference<Integer> output)
                                  throws IOException

Throws:

IOException

rcRegisterPhysicalPath

public static int rcRegisterPhysicalPath(IRODSApi.RcComm comm,
 DataObjInp_PI input,
 Reference<String> output)
                                  throws IOException

Throws:

IOException

rcModAVUMetadata

public static int rcModAVUMetadata(IRODSApi.RcComm comm,
 ModAVUMetadataInp_PI input)
                            throws IOException

Throws:

IOException

rcModAccessControl

public static int rcModAccessControl(IRODSApi.RcComm comm,
 ModAccessControlInp_PI input)
                              throws IOException

Throws:

IOException

rcModDataObjMeta

public static int rcModDataObjMeta(IRODSApi.RcComm comm,
 ModDataObjMeta_PI input)
                            throws IOException

Throws:

IOException

rcDataObjectModifyInfo

public static int rcDataObjectModifyInfo(IRODSApi.RcComm comm,
 ModDataObjMeta_PI input)
                                  throws IOException

Throws:

IOException

rcDataObjRename

public static int rcDataObjRename(IRODSApi.RcComm comm,
 DataObjCopyInp_PI input)
                           throws IOException

Throws:

IOException

rcDataObjCopy

public static int rcDataObjCopy(IRODSApi.RcComm comm,
 DataObjCopyInp_PI input,
 Reference<TransferStat_PI> output)
                         throws IOException

Throws:

IOException

rcDataObjRepl

public static int rcDataObjRepl(IRODSApi.RcComm comm,
 DataObjInp_PI input,
 Reference<TransferStat_PI> output)
                         throws IOException

Throws:

IOException

rcDataObjCreate

public static int rcDataObjCreate(IRODSApi.RcComm comm,
 DataObjInp_PI input)
                           throws IOException

Throws:

IOException

rcDataObjChksum

public static int rcDataObjChksum(IRODSApi.RcComm comm,
 DataObjInp_PI input,
 Reference<String> output)
                           throws IOException

Throws:

IOException

rcDataObjUnlink

public static int rcDataObjUnlink(IRODSApi.RcComm comm,
 DataObjInp_PI input)
                           throws IOException

Throws:

IOException

rcDataObjTrim

public static int rcDataObjTrim(IRODSApi.RcComm comm,
 DataObjInp_PI input)
                         throws IOException

Throws:

IOException

rcDelayRuleLock

public static int rcDelayRuleLock(IRODSApi.RcComm comm,
 DelayRuleLockInput_PI input)
                           throws IOException

Throws:

IOException

rcDelayRuleUnlock

public static int rcDelayRuleUnlock(IRODSApi.RcComm comm,
 DelayRuleUnlockInput_PI input)
                             throws IOException

Throws:

IOException

rcCollCreate

public static int rcCollCreate(IRODSApi.RcComm comm,
 CollInpNew_PI input)
                        throws IOException

Throws:

IOException

rcModColl

public static int rcModColl(IRODSApi.RcComm comm,
 CollInpNew_PI input)
                     throws IOException

Throws:

IOException

rcOpenCollection

public static int rcOpenCollection(IRODSApi.RcComm comm,
 CollInpNew_PI input)
                            throws IOException

Throws:

IOException

rcReadCollection

public static int rcReadCollection(IRODSApi.RcComm comm,
 int handle,
 Reference<CollEnt_PI> output)
                            throws IOException

Throws:

IOException

rcCloseCollection

public static int rcCloseCollection(IRODSApi.RcComm comm,
 int handle)
                             throws IOException

Throws:

IOException

rcRmColl

public static int rcRmColl(IRODSApi.RcComm comm,
 CollInpNew_PI input,
 Reference<CollOprStat_PI> output)
                    throws IOException

Throws:

IOException

rcTicketAdmin

public static int rcTicketAdmin(IRODSApi.RcComm comm,
 TicketAdminInp_PI input)
                         throws IOException

Throws:

IOException

rcUnregDataObj

public static int rcUnregDataObj(IRODSApi.RcComm comm,
 UnregDataObj_PI input)
                          throws IOException

Throws:

IOException

rcUserAdmin

public static int rcUserAdmin(IRODSApi.RcComm comm,
 UserAdminInp_PI input)
                       throws IOException

Throws:

IOException

rcSpecificQuery

public static int rcSpecificQuery(IRODSApi.RcComm comm,
 SpecificQueryInp_PI input,
 Reference<GenQueryOut_PI> output)
                           throws IOException

Throws:

IOException

rcGetResourceInfoForOperation

public static int rcGetResourceInfoForOperation(IRODSApi.RcComm comm,
 DataObjInp_PI input,
 Reference<String> output)
                                         throws IOException

Throws:

IOException

rcZoneReport

public static int rcZoneReport(IRODSApi.RcComm comm,
 Reference<BytesBuf_PI> output)
                        throws IOException

Throws:

IOException

rcGetMiscSvrInfo

public static int rcGetMiscSvrInfo(IRODSApi.RcComm comm,
 Reference<MiscSvrInfo_PI> output)
                            throws IOException

Throws:

IOException

rcGeneralAdmin

public static int rcGeneralAdmin(IRODSApi.RcComm comm,
 GeneralAdminInp_PI input)
                          throws IOException

Throws:

IOException

rcExecMyRule

public static int rcExecMyRule(IRODSApi.RcComm comm,
 ExecMyRuleInp_PI input,
 Reference<MsParamArray_PI> output)
                        throws IOException

Throws:

IOException

rcProcStat

public static int rcProcStat(IRODSApi.RcComm comm,
 ProcStatInp_PI input,
 Reference<GenQueryOut_PI> output)
                      throws IOException

Throws:

IOException

rcRuleExecSubmit

public static int rcRuleExecSubmit(IRODSApi.RcComm comm,
 RULE_EXEC_DEL_INP_PI input,
 Reference<String> output)
                            throws IOException

Throws:

IOException

rcRuleExecMod

public static int rcRuleExecMod(IRODSApi.RcComm comm,
 RULE_EXEC_MOD_INP_PI input)
                         throws IOException

Throws:

IOException

rcRuleExecDel

public static int rcRuleExecDel(IRODSApi.RcComm comm,
 RULE_EXEC_DEL_INP_PI input)
                         throws IOException

Throws:

IOException

rcGetLibraryFeatures

public static int rcGetLibraryFeatures(IRODSApi.RcComm comm,
 Reference<String> output)
                                throws IOException

Throws:

IOException