irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

rodsKeyWdDef.h
Go to the documentation of this file.
1 
3 /* rodsKeyWdDef.h - global definition for client API */
4 
5 #ifndef RODS_KEYWD_DEF_H__
6 #define RODS_KEYWD_DEF_H__
7 
8 /* The following are the keyWord definition for the condInput key/value pair */
9 
10 #define ALL_KW "all" /* operation done on all replica */
11 #define COPIES_KW "copies" /* the number of copies */
12 #define EXEC_LOCALLY_KW "execLocally" /* execute locally */
13 #define FORCE_FLAG_KW "forceFlag" /* force update */
14 #define CLI_IN_SVR_FIREWALL_KW "cliInSvrFirewall" /* cli behind same firewall */
15 #define REG_CHKSUM_KW "regChksum" /* register checksum */
16 #define VERIFY_CHKSUM_KW "verifyChksum" /* verify checksum */
17 #define VERIFY_BY_SIZE_KW "verifyBySize" /* verify by size - used by irsync */
18 #define OBJ_PATH_KW "objPath" /* logical path of the object */
19 #define RESC_NAME_KW "rescName" /* resource name */
20 #define DEST_RESC_NAME_KW "destRescName" /* destination resource name */
21 #define DEF_RESC_NAME_KW "defRescName" /* default resource name */
22 #define BACKUP_RESC_NAME_KW "backupRescName" /* destination resource name */
23 #define DATA_TYPE_KW "dataType" /* data type */
24 #define DATA_SIZE_KW "dataSize"
25 #define CHKSUM_KW "chksum"
26 #define ORIG_CHKSUM_KW "orig_chksum"
27 #define VERSION_KW "version"
28 #define FILE_PATH_KW "filePath" /* the physical file path */
29 #define BUN_FILE_PATH_KW "bunFilePath" /* the physical bun file path */ // JMC - backport 4768
30 #define REPL_NUM_KW "replNum" /* replica number */
31 #define WRITE_FLAG_KW "writeFlag" /* whether it is opened for write */
32 #define REPL_STATUS_KW "replStatus" /* status of the replica */
33 #define ALL_REPL_STATUS_KW "allReplStatus" /* update all replStatus */
34 #define METADATA_INCLUDED_KW "metadataIncluded" /* for atomic puts of data / metadata */
35 #define ACL_INCLUDED_KW "aclIncluded" /* for atomic puts of data / metadata */
36 #define DATA_INCLUDED_KW "dataIncluded" /* data included in the input buffer */
37 #define DATA_OWNER_KW "dataOwner"
38 #define DATA_OWNER_ZONE_KW "dataOwnerZone"
39 #define DATA_EXPIRY_KW "dataExpiry"
40 #define DATA_COMMENTS_KW "dataComments"
41 #define DATA_CREATE_KW "dataCreate"
42 #define DATA_MODIFY_KW "dataModify"
43 #define DATA_ACCESS_KW "dataAccess"
44 #define DATA_ACCESS_INX_KW "dataAccessInx"
45 #define NO_OPEN_FLAG_KW "noOpenFlag"
46 #define PHYOPEN_BY_SIZE_KW "phyOpenBySize"
47 #define STREAMING_KW "streaming"
48 #define DATA_ID_KW "dataId"
49 #define COLL_ID_KW "collId"
50 #define DATA_MODE_KW "dataMode"
51 #define DATA_NAME_KW "data_name"
52 #define STATUS_STRING_KW "statusString"
53 #define DATA_MAP_ID_KW "dataMapId"
54 #define NO_PARA_OP_KW "noParaOpr"
55 #define LOCAL_PATH_KW "localPath"
56 #define RSYNC_MODE_KW "rsyncMode"
57 #define RSYNC_DEST_PATH_KW "rsyncDestPath"
58 #define RSYNC_CHKSUM_KW "rsyncChksum"
59 #define CHKSUM_ALL_KW "ChksumAll"
60 #define FORCE_CHKSUM_KW "forceChksum"
61 #define COLLECTION_KW "collection"
62 #define ADMIN_KW "irodsAdmin"
63 #define ADMIN_RMTRASH_KW "irodsAdminRmTrash"
64 #define UNREG_KW "unreg"
65 #define RMTRASH_KW "irodsRmTrash"
66 #define RECURSIVE_OPR__KW "recursiveOpr"
67 #define COLLECTION_TYPE_KW "collectionType"
68 #define COLLECTION_INFO1_KW "collectionInfo1"
69 #define COLLECTION_INFO2_KW "collectionInfo2"
70 #define COLLECTION_MTIME_KW "collectionMtime"
71 #define SEL_OBJ_TYPE_KW "selObjType"
72 #define STRUCT_FILE_OPR_KW "structFileOpr"
73 #define ALL_MS_PARAM_KW "allMsParam"
74 #define UNREG_COLL_KW "unregColl"
75 #define UPDATE_REPL_KW "updateRepl"
76 #define RBUDP_TRANSFER_KW "rbudpTransfer"
77 #define VERY_VERBOSE_KW "veryVerbose"
78 #define RBUDP_SEND_RATE_KW "rbudpSendRate"
79 #define RBUDP_PACK_SIZE_KW "rbudpPackSize"
80 #define ZONE_KW "zone"
81 #define REMOTE_ZONE_OPR_KW "remoteZoneOpr"
82 #define REPL_DATA_OBJ_INP_KW "replDataObjInp"
83 #define CROSS_ZONE_CREATE_KW "replDataObjInp" /* use the same for backward compatibility */
84 #define VERIFY_VAULT_SIZE_EQUALS_DATABASE_SIZE_KW "verifyVaultSizeEqualsDatabaseSize"
85 #define QUERY_BY_DATA_ID_KW "queryByDataID"
86 #define SU_CLIENT_USER_KW "suClientUser"
87 #define RM_BUN_COPY_KW "rmBunCopy"
88 #define KEY_WORD_KW "keyWord" /* the msKeyValStr is a keyword */
89 #define CREATE_MODE_KW "createMode" /* a msKeyValStr keyword */
90 #define OPEN_FLAGS_KW "openFlags" /* a msKeyValStr keyword */
91 #define OFFSET_KW "offset" /* a msKeyValStr keyword */
92 /* DATA_SIZE_KW already defined */
93 #define NUM_THREADS_KW "numThreads" /* a msKeyValStr keyword */
94 #define OPR_TYPE_KW "oprType" /* a msKeyValStr keyword */
95 #define OPEN_TYPE_KW "openType"
96 #define COLL_FLAGS_KW "collFlags" /* a msKeyValStr keyword */
97 #define TRANSLATED_PATH_KW "translatedPath" /* the path translated */
98 #define NO_TRANSLATE_LINKPT_KW "noTranslateMntpt" /* don't translate mntpt */
99 #define BULK_OPR_KW "bulkOpr" /* the bulk operation */
100 #define NON_BULK_OPR_KW "nonBulkOpr" /* non bulk operation */
101 #define EXEC_CMD_RULE_KW "execCmdRule" /* the rule that invoke execCmd */
102 #define EXEC_MY_RULE_KW "execMyRule" /* the rule is invoked by rsExecMyRule */
103 #define STREAM_STDOUT_KW "streamStdout" /* the stream stdout for
104 * execCmd */
105 #define REG_REPL_KW "regRepl" /* register replica */
106 #define AGE_KW "age" /* age of the file for itrim */
107 #define DRYRUN_KW "dryrun" /* do a dry run */
108 #define ACL_COLLECTION_KW "aclCollection" /* the collection from which
109 * the ACL should be used */
110 #define NO_CHK_COPY_LEN_KW "noChkCopyLen" /* Don't check the len
111 * when transfering */
112 #define TICKET_KW "ticket" /* for ticket-based-access */
113 #define PURGE_CACHE_KW "purgeCache" /* purge the cache copy right JMC - backport 4537
114 * after the operation */
115 #define EMPTY_BUNDLE_ONLY_KW "emptyBundleOnly" /* delete emptyBundleOnly */ // JMC - backport 4552
116 
117 // =-=-=-=-=-=-=-
118 // JMC - backport 4599
119 #define LOCK_TYPE_KW "lockType" /* valid values are READ_LOCK_TYPE
120 * WRITE_LOCK_TYPE and UNLOCK_TYPE */
121 #define LOCK_CMD_KW "lockCmd" /* valid values are SET_LOCK_WAIT_CMD,
122 * SET_LOCK_CMD and GET_LOCK_CMD */
123 #define LOCK_FD_KW "lockFd" /* Lock file desc for unlock */
124 #define MAX_SUB_FILE_KW "maxSubFile" /* max number of files for tar file bundles */
125 #define MAX_BUNDLE_SIZE_KW "maxBunSize" /* max size of a tar bundle in Gbs */
126 #define NO_STAGING_KW "noStaging"
127 
128 // =-=-=-=-=-=-=-
129 #define MAX_SUB_FILE_KW "maxSubFile" /* max number of files for tar file bundles */ // JMC - backport 4771
130 
131 /* OBJ_PATH_KW already defined */
132 
133 /* OBJ_PATH_KW already defined */
134 /* COLL_NAME_KW already defined */
135 #define FILE_UID_KW "fileUid"
136 #define FILE_OWNER_KW "fileOwner"
137 #define FILE_GID_KW "fileGid"
138 #define FILE_GROUP_KW "fileGroup"
139 #define FILE_MODE_KW "fileMode"
140 #define FILE_CTIME_KW "fileCtime"
141 #define FILE_MTIME_KW "fileMtime"
142 #define FILE_SOURCE_PATH_KW "fileSourcePath"
143 #define EXCLUDE_FILE_KW "excludeFile"
144 
145 /* The following are the keyWord definition for the rescCond key/value pair */
146 /* RESC_NAME_KW is defined above */
147 
148 #define RESC_ZONE_KW "zoneName"
149 #define RESC_LOC_KW "rescLoc" /* resc_net in DB */
150 #define RESC_TYPE_KW "rescType"
151 #define RESC_CLASS_KW "rescClass"
152 #define RESC_VAULT_PATH_KW "rescVaultPath" /* resc_def_path in DB */
153 #define RESC_STATUS_KW "rescStatus"
154 #define GATEWAY_ADDR_KW "gateWayAddr"
155 #define RESC_MAX_OBJ_SIZE_KW "rescMaxObjSize"
156 #define FREE_SPACE_KW "freeSpace"
157 #define FREE_SPACE_TIME_KW "freeSpaceTime"
158 #define FREE_SPACE_TIMESTAMP_KW "freeSpaceTimeStamp"
159 #define QUOTA_LIMIT_KW "quotaLimit"
160 #define RESC_INFO_KW "rescInfo"
161 #define RESC_TYPE_INX_KW "rescTypeInx"
162 #define RESC_CLASS_INX_KW "rescClassInx"
163 #define RESC_ID_KW "rescId"
164 #define RESC_COMMENTS_KW "rescComments"
165 #define RESC_CREATE_KW "rescCreate"
166 #define RESC_MODIFY_KW "rescModify"
167 
168 /* The following are the keyWord definition for the userCond key/value pair */
169 
170 #define USER_NAME_CLIENT_KW "userNameClient"
171 #define RODS_ZONE_CLIENT_KW "rodsZoneClient"
172 #define HOST_CLIENT_KW "hostClient"
173 #define CLIENT_ADDR_KW "clientAddr"
174 #define USER_TYPE_CLIENT_KW "userTypeClient"
175 #define AUTH_STR_CLIENT_KW "authStrClient" /* user distin name */
176 #define USER_AUTH_SCHEME_CLIENT_KW "userAuthSchemeClient"
177 #define USER_INFO_CLIENT_KW "userInfoClient"
178 #define USER_COMMENT_CLIENT_KW "userCommentClient"
179 #define USER_CREATE_CLIENT_KW "userCreateClient"
180 #define USER_MODIFY_CLIENT_KW "userModifyClient"
181 #define USER_NAME_PROXY_KW "userNameProxy"
182 #define RODS_ZONE_PROXY_KW "rodsZoneProxy"
183 #define HOST_PROXY_KW "hostProxy"
184 #define USER_TYPE_PROXY_KW "userTypeProxy"
185 #define AUTH_STR_PROXY_KW "authStrProxy" /* dn */
186 #define USER_AUTH_SCHEME_PROXY_KW "userAuthSchemeProxy"
187 #define USER_INFO_PROXY_KW "userInfoProxy"
188 #define USER_COMMENT_PROXY_KW "userCommentProxy"
189 #define USER_CREATE_PROXY_KW "userCreateProxy"
190 #define USER_MODIFY_PROXY_KW "userModifyProxy"
191 #define ACCESS_PERMISSION_KW "accessPermission"
192 #define NO_CHK_FILE_PERM_KW "noChkFilePerm"
193 
194 /* The following are the keyWord definition for the collCond key/value pair */
195 
196 #define COLL_NAME_KW "collName"
197 #define COLL_PARENT_NAME_KW "collParentName" /* parent_coll_name in DB */
198 #define COLL_OWNER_NAME_KW "collOwnername"
199 #define COLL_OWNER_ZONE_KW "collOwnerZone"
200 #define COLL_MAP_ID_KW "collMapId"
201 #define COLL_INHERITANCE_KW "collInheritance"
202 #define COLL_COMMENTS_KW "collComments"
203 #define COLL_EXPIRY_KW "collExpiry"
204 #define COLL_CREATE_KW "collCreate"
205 #define COLL_MODIFY_KW "collModify"
206 #define COLL_ACCESS_KW "collAccess"
207 #define COLL_ACCESS_INX_KW "collAccessInx"
208 #define COLL_ID_KW "collId"
209 
210 /*
211  The following are the keyWord definitions for the keyValPair_t input
212  to chlModRuleExec.
213 */
214 #define RULE_NAME_KW "ruleName"
215 #define RULE_REI_FILE_PATH_KW "reiFilePath"
216 #define RULE_USER_NAME_KW "userName"
217 #define RULE_EXE_ADDRESS_KW "exeAddress"
218 #define RULE_EXE_TIME_KW "exeTime"
219 #define RULE_EXE_FREQUENCY_KW "exeFrequency"
220 #define RULE_PRIORITY_KW "priority"
221 #define RULE_ESTIMATE_EXE_TIME_KW "estimateExeTime"
222 #define RULE_NOTIFICATION_ADDR_KW "notificationAddr"
223 #define RULE_LAST_EXE_TIME_KW "lastExeTime"
224 #define RULE_EXE_STATUS_KW "exeStatus"
225 
226 #define EXCLUDE_FILE_KW "excludeFile"
227 #define AGE_KW "age" /* age of the file for itrim */
228 
229 // =-=-=-=-=-=-=-
230 // irods general keywords definitions
231 #define RESC_HIER_STR_KW "resc_hier"
232 #define DEST_RESC_HIER_STR_KW "dest_resc_hier"
233 #define IN_PDMO_KW "in_pdmo"
234 #define STAGE_OBJ_KW "stage_object"
235 #define SYNC_OBJ_KW "sync_object"
236 #define IN_REPL_KW "in_repl"
237 
238 // =-=-=-=-=-=-=-
239 // irods tcp keyword definitions
240 #define SOCKET_HANDLE_KW "tcp_socket_handle"
241 
242 // =-=-=-=-=-=-=-
243 // irods ssl keyword definitions
244 #define SSL_HOST_KW "ssl_host"
245 #define SSL_SHARED_SECRET_KW "ssl_shared_secret"
246 #define SSL_KEY_SIZE_KW "ssl_key_size"
247 #define SSL_SALT_SIZE_KW "ssl_salt_size"
248 #define SSL_NUM_HASH_ROUNDS_KW "ssl_num_hash_rounds"
249 #define SSL_ALGORITHM_KW "ssl_algorithm"
250 
251 // =-=-=-=-=-=-=-
252 // irods data_object keyword definitions
253 #define PHYSICAL_PATH_KW "physical_path"
254 #define MODE_KW "mode_kw"
255 #define FLAGS_KW "flags_kw"
256 #define OBJ_COUNT_KW "object_count"
257 // borrowed RESC_HIER_STR_KW
258 
259 // =-=-=-=-=-=-=-
260 // irods file_object keyword definitions
261 #define LOGICAL_PATH_KW "logical_path"
262 #define FILE_DESCRIPTOR_KW "file_descriptor"
263 #define L1_DESC_IDX_KW "l1_desc_idx"
264 #define SIZE_KW "file_size"
265 #define REPL_REQUESTED_KW "repl_requested"
266 // borrowed IN_PDMO_KW
267 
268 // =-=-=-=-=-=-=-
269 // irods structured_object keyword definitions
270 #define HOST_ADDR_KW "host_addr"
271 #define ZONE_NAME_KW "zone_name"
272 #define PORT_NUM_KW "port_num"
273 #define SUB_FILE_PATH_KW "sub_file_path"
274 // borrowed OFFSET_KW
275 // borrowed DATA_TYPE_KW
276 // borrowed OPR_TYPE_KW
277 
278 // =-=-=-=-=-=-=-
279 // irods spec coll keyword definitions
280 #define SPEC_COLL_CLASS_KW "spec_coll_class"
281 #define SPEC_COLL_TYPE_KW "spec_coll_type"
282 #define SPEC_COLL_OBJ_PATH_KW "spec_coll_obj_path"
283 #define SPEC_COLL_RESOURCE_KW "spec_coll_resource"
284 #define SPEC_COLL_RESC_HIER_KW "spec_coll_resc_hier"
285 #define SPEC_COLL_PHY_PATH_KW "spec_coll_phy_path"
286 #define SPEC_COLL_CACHE_DIR_KW "spec_coll_cache_dir"
287 #define SPEC_COLL_CACHE_DIRTY "spec_coll_cache_dirty"
288 #define SPEC_COLL_REPL_NUM "spec_coll_repl_num"
289 
290 #define KEY_VALUE_PASSTHROUGH_KW "key_value_passthrough"
291 #define DISABLE_STRICT_ACL_KW "disable_strict_acls"
292 
293 #define INSTANCE_NAME_KW "instance_name"
294 
295 
296 
297 
298 #endif // RODS_KEYWD_DEF_H__