clj-icat-direct.icat — org.cyverse/clj-icat-direct 2.9.1

file-permissions-for-user clj

(file-permissions-for-user user file-path)

Returns the highest permission value for the specified user on the file.

folder-path-listing clj

(folder-path-listing user zone folder-path)

Returns a complete folder listing for everything visible to a given user.

Parameters: user - the name of the user zone - the authentication zone of the user folder-path - the absolute path to the folder

Returns: It returns a sequence of paths.

folder-permissions-for-user clj

(folder-permissions-for-user user folder-path)

Returns the highest permission value for the specified user on the folder.

get-item clj

(get-item dirname basename group-ids)

(get-item dirname basename user zone)

icat clj

icat-db-spec clj

(icat-db-spec hostname user pass & {:keys [port db] :or {port 5432 db "ICAT"}})

Creates a Korma db spec for the ICAT.

list-files-under-folder clj

(list-files-under-folder folder-path)

Lists all of the files in the current folder and all descendants, without regard to file or folder permissions. Use of this function should be restricted to administrative endpoints.

list-folders-in-folder clj

(list-folders-in-folder user zone folder-path)

Returns a listing of the folders contained in the specified folder that the user has access to.

number-of-all-items-under-folder clj

(number-of-all-items-under-folder user zone folder-path)

Returns the total number of files and folders in the specified folder and all sub-folders that the user has access to.

number-of-bad-items-in-folder clj

(number-of-bad-items-in-folder &
                               {:keys [user zone folder-path entity-type
                                       info-types bad-chars bad-names
                                       bad-paths]})

Returns the total number of files and folders in the specified folder that the user has access to and where the files have the given info types, but should be marked as having a bad name in the client.

Parameters: user - the username of the authorized user zone - the user's authentication zone folder-path - The absolute path to the folder of interest entity-type - the type of entities to return (:any|:file|:folder), :any means both files and folders info-types - the info-types of the files to count, if empty, all files are considered bad-chars - If a name contains one or more of these characters, the item will be marked as bad bad-names - This is a sequence of names that are bad bad-paths - This is an array of paths to items that will be marked as badr.

Returns: It returns the total.

number-of-files-in-folder clj

(number-of-files-in-folder user zone folder-path)

Returns the number of files in a folder that the user has access to.

number-of-folders-in-folder clj

(number-of-folders-in-folder user zone folder-path)

Returns the number of folders in the specified folder that the user has access to.

number-of-items-in-folder clj

(number-of-items-in-folder user zone folder-path entity-type & [info-types])

Returns the total number of files and folders in the specified folder that the user has access to and where the files have the given info types.

Parameters: user - the username of the user zone - the user's authentication zone folder-path - the absolute path to the folder being inspected entity-type - the type of entities to return (:any|:file|:folder), :any means both files and folders info-types - the info-types of the files to count, if empty, all files are counted

Returns: It returns the total number of folders combined with the total number of files with the given info types.

number-of-uuids-in-folder clj

(number-of-uuids-in-folder user zone uuids file-types)

Returns the number of entities that have provided UUIDs, are visible to the given user and are a folder or have one of the given file types.

Parameters: user - the name of the user determining visibility zone - the authentication zone of the user uuids - the list of UUIDS to look up. file-types - the info types of interest

Returns: The result set

paged-folder-listing clj

(paged-folder-listing &
                      {:keys [user zone folder-path entity-type sort-column
                              sort-direction limit offset info-types
                              transaction? user-group-ids]
                       :or {transaction? true}})

Returns a page from a folder listing.

Parameters: user - the name of the user determining access privileges zone - the authentication zone of the user folder-path - the folder to list the contents of entity-type - the type of entities to return (:any|:file|:folder), :any means both files and folders sort-column - the column to sort by (:type|:modify-ts|:create-ts|:data-size|:base-name|:full-path) sort-direction - the sorting direction (:asc|:desc) limit - the maximum number of results to return offset - the number of results to skip after sorting and before returning results file-types - the info types of interest

Returns: It returns a page of results.

Throws: It throws an exception if a validation fails.

paged-uuid-listing clj

(paged-uuid-listing user
                    zone
                    sort-column
                    sort-order
                    limit
                    offset
                    uuids
                    file-types)

Returns a page of filesystem entries corresponding to a list a set of UUIDs.

Parameters: user - the name of the user determining access privileges zone - the authentication zone of the user sort-column - the column to sort by (type|modify-ts|create-ts|data-size|base-name|full-path) sort-order - the sorting direction (asc|desc) limit - the maximum number of results to return offset - the number of results to skip after sorting and before returning results uuids - the list of UUIDS to look up. file-types - the info types of interest

Returns: The result set

path-for-uuid clj

(path-for-uuid uuid)

prefixed-files-without-attr clj

(prefixed-files-without-attr uuid-prefix attr)

select-files-with-uuids clj

(select-files-with-uuids uuids)

Given a set of UUIDs, it returns a list of UUID-path pairs for each UUID that corresponds to a file.

select-folders-with-uuids clj

(select-folders-with-uuids uuids)

Given a set of UUIDs, it returns a list of UUID-path pairs for each UUID that corresponds to a folder.

setup-icat clj

(setup-icat icat-db-spec)

Defines the icat database. Pass in the return value of icat-db-spec.

user clj

(user username zone)

Get a representation of a user with their ID, username, type name, zone, 'info', 'comment', and create/modify timestamps.

user-group-ids clj

(user-group-ids user zone)

Get user group IDs, including the user's ID

with-icat-transaction clj macro

(with-icat-transaction & body)