... | ... | @@ -2,20 +2,41 @@ The following functions are included in the rule set _/opt/eudat/b2safe/rulebase |
|
|
|
|
|
- **getEpicApiParameters**(*credStoreType, *credStorePath, *epicApi, *serverID, *epicDebug)
|
|
|
Provides parameters for the connection with the EPIC service (PID registry). They must be configured by the B2SAFE administrator in order to enable the PID registration.
|
|
|
- **credStoreType**: states if the file path is based on irods namespace or on the filesystem [os | irods]
|
|
|
- **credStorePath**: the path to the file containing the credentials to connect to an EPIC service (e.g. /opt/eudat/b2safe/conf/credentials)
|
|
|
- **epicApi**: the reference URL for EPIC API [http://hdl.handle.net/]
|
|
|
- **serverID**: the id related the irods service [irods://hostnameWithFullDomain:1247]
|
|
|
- **epicDebug**: the debug level for the EPIC client scripts [2]
|
|
|
|
|
|
- **getAuthZParameters**(*authZMapPath)
|
|
|
Provides parameters for the [authorization mechanism](https://github.com/EUDAT-B2SAFE/B2SAFE-core/wiki/Documentation#authorization)
|
|
|
- `credStoreType`: states if the file path is based on irods namespace or on the filesystem [os | irods]
|
|
|
- `credStorePath`: the path to the file containing the credentials to connect to an EPIC service (e.g. /opt/eudat/b2safe/conf/credentials)
|
|
|
- `epicApi`: the reference URL for EPIC API [http://hdl.handle.net/]
|
|
|
- `serverID`: the id related the irods service [irods://hostnameWithFullDomain:1247]
|
|
|
- `epicDebug`: the debug level for the EPIC client scripts [2]
|
|
|
|
|
|
- **getAuthZParameters**(*authZMapPath)
|
|
|
Provides parameters for the [authorization mechanism](https://github.com/EUDAT-B2SAFE/B2SAFE-core/wiki/Documentation#authorization)
|
|
|
- `authZMapPath`: the file path to the authorization map, containing the authorization assertions.
|
|
|
|
|
|
- **getLogParameters**(*logConfPath)
|
|
|
Provides parameters for the logging mechanism
|
|
|
- `logConfPath`: the file path to the logging configuration.
|
|
|
|
|
|
- **getConfParameters**(*msiFreeEnabled, *msiCurlEnabled, *authzEnabled)
|
|
|
Provides parameters for some B2SAFE configurations.
|
|
|
The plugin _msifree_microservice_out_ is a bug fixing to avoid memory leak in case of collection replication involving thousands of files and the parameter _msiFreeEnabled_ enables it.
|
|
|
The CURL plugin is an optional component (available [here](http://irods.org/download/)), which is needed if you set to "true" the parameter _msiCurlEnabled_ : it disables the calls to the default python client to connect to the EPIC service (PID registry) directly. It can improve the performance in the creation of PIDs (see the [documentation](https://github.com/EUDAT-B2SAFE/B2SAFE-core/wiki/Documentation#performance))
|
|
|
- `msiFreeEnabled`: if True the msiFree plugin must be deployed
|
|
|
- `msiCurlEnabled`: if True the msiCurl plugin must be deployed
|
|
|
- `authzEnabled`: if True the authorization mechanism enforces the assertions defined in the file retrieved by getAuthZParameters.
|
|
|
|
|
|
***
|
|
|
### Optional configurations
|
|
|
|
|
|
- **getMetaParameters**(*metaConfPath, *enabled)
|
|
|
Provides parameters for the metadata management mechanism
|
|
|
- `metaConfPath`: the file path to the metadata tool configuration.
|
|
|
- `enabled`: boolean value to enable (if true) globally the json metadata writing
|
|
|
|
|
|
- **getMessageParameters**(*msgLogPath, *enabled)
|
|
|
Provides parameters for the message management mechanism
|
|
|
- `msgLogPath`: the file path to the message log file.
|
|
|
- `enabled`: boolean value to enable (if true) globally the the usage of the messaging system
|
|
|
|
|
|
- **parseCredentials** (*baseuri, *username, *prefix, *password)
|
|
|
Parse the credentials to connect to an EPIC server. The same parameters listed [here](https://github.com/EUDAT-B2SAFE/B2SAFE-core/wiki/Python-script-configuration).
|
|
|
|