Package org.irods.irods4j.high_level.policy

Class IRODSRules

java.lang.Object

org.irods.irods4j.high_level.policy.IRODSRules

public class IRODSRules
extends Object

A class providing high-level functions for executing iRODS rule code against rule engine plugins.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IRODSRules.RuleArguments	A class used to describe inputs to executeRule(org.irods.irods4j.low_level.api.IRODSApi.RcComm, org.irods.irods4j.high_level.policy.IRODSRules.RuleArguments).

Constructor Summary

Constructors

Constructor	Description
IRODSRules()

Method Summary

Modifier and Type	Method	Description
static Map<String,String>	executeRule(IRODSApi.RcComm comm, IRODSRules.RuleArguments args)	Executes rule text/code against the connected server.
static List<String>	getAvailableRuleEnginePluginInstances(IRODSApi.RcComm comm)	Queries the connected server for usable rule engine plugin instances.

Methods inherited from class java.lang.Object

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

Constructor Details

IRODSRules

public IRODSRules()

Method Details

getAvailableRuleEnginePluginInstances

public static List<String> getAvailableRuleEnginePluginInstances(IRODSApi.RcComm comm)
                                                          throws IOException,
IRODSException

Queries the connected server for usable rule engine plugin instances.

Parameters:

comm - A connection to a iRODS server.

Returns:

A list of usable rule engine plugin instances.

Throws:

IOException - If a network error occurs.

IRODSException - If the iRODS API operation fails.

Since:

0.1.0

executeRule

public static Map<String,String> executeRule(IRODSApi.RcComm comm,
 IRODSRules.RuleArguments args)
                                      throws IOException,
IRODSException

Executes rule text/code against the connected server. Targeting a specific rule engine plugin instance is recommended so that error information is returned by the server. If no rule engine plugin instance is explicitly targeted, the server will never return any error information. Use getAvailableRuleEnginePluginInstances to get the list of available rule engine plugin instances.

Parameters:

comm - A connection to a iRODS server.

args - A structure which describes what to execute.

Returns:

A map containing the values of requested variables.

Throws:

IOException - If a network error occurs.

IRODSException - If the iRODS API operation fails.

Since:

0.1.0