pathological.attributes — io.logicblocks/pathological 0.1.22-RC4

*file-attribute-view-factories* clj

A mapping of available file attribute view types to factory functions for materialised records.

By default, includes factories for :basic, :owner, :posix, :dos, :user and :acl file attribute views. Since the file attribute view framework is extensible and implementation dependent in Java NIO2, this var is dynamic and can be altered / rebound to support additional file attribute views.

->acl-file-attribute-view clj

(->acl-file-attribute-view path view)

Converts the AclFileAttributeView instance to a materialised record.

The returned record includes:

• :path: the path to the file,
• :owner: the user principal acting as owner of the file,
• :acl: the set of ACL entries associated with the file,
• :delegate: the underlying instance.

The :acl attribute in the returned record is a set of ACL entry maps. See pathological.utils/<-acl-entry for more details on ACL entry maps.

The returned record implements ReloadFileAttributes and UpdateFileAcl.

->basic-file-attribute-map clj

(->basic-file-attribute-map attributes)

Extracts all attributes from the BasicFileAttributes instance into a map.

The returned map includes:

• :file-key: an object that uniquely identifies the file,
• :size: the size of the file in bytes,
• :last-modified-time: the last modified time of the file, as a string,
• :last-access-time: the last access time of the file, as a string,
• :creation-time: the creation time of the file, as a string,
• :regular-file?: whether or not the file is a regular file, as a boolean,
• :directory?: whether or not the file is a directory, as a boolean,
• :symbolic-link?: whether or not the file is a symbolic link, as a boolean,
• :other?: whether the file is something other than a regular file, directory or symbolic link, as a boolean.

For more details on each attribute, see the Java documentation for BasicFileAttributes.

->basic-file-attribute-view clj

(->basic-file-attribute-view path view)

Converts the BasicFileAttributeView instance to a materialised record.

The returned record includes:

• :path: the path to the file,
• :file-key: an object that uniquely identifies the file,
• :size: the size of the file in bytes,
• :last-modified-time: the last modified time of the file, as a string,
• :last-access-time: the last access time of the file, as a string,
• :creation-time: the creation time of the file, as a string,
• :regular-file?: whether the file is a regular file, as a boolean,
• :directory?: whether the file is a directory, as a boolean,
• :symbolic-link?: whether the file is a symbolic link, as a boolean,
• :other?: whether the file is something other than a regular file, directory or symbolic link, as a boolean,
• :delegate: the underlying instance.

The returned record implements ReloadFileAttributes and UpdateFileTimes.

->dos-file-attribute-view clj

(->dos-file-attribute-view path view)

Converts the DosFileAttributeView instance to a materialised record.

The returned record includes:

• :path: the path to the file,
• :file-key: an object that uniquely identifies the file,
• :size: the size of the file in bytes,
• :last-modified-time: the last modified time of the file, as a string,
• :last-access-time: the last access time of the file, as a string,
• :creation-time: the creation time of the file, as a string,
• :regular-file?: whether or not the file is a regular file, as a boolean,
• :directory?: whether or not the file is a directory, as a boolean,
• :symbolic-link?: whether or not the file is a symbolic link, as a boolean,
• :other?: whether the file is something other than a regular file, directory or symbolic link, as a boolean,
• :read-only?: whether or not the file is read only, as a boolean,
• :hidden?: whether or not the file is hidden, as a boolean,
• :archive?: whether or not the file is an archive, as a boolean,
• :system?: whether or not the file is a system file, as a boolean,
• :delegate: the underlying instance.

The returned record implements ReloadFileAttributes, UpdateFileTimes and UpdateDosFileAttributes.

->file-attribute-view-factory clj

(->file-attribute-view-factory type)

Returns a file attribute view factory for building materialised records for the supplied file attribute view type when available. If no factory is available, an identity factory is returned which leaves the provided view unchanged.

See *file-attribute-view-factories* for details on supported types.

->owner-file-attribute-view clj

(->owner-file-attribute-view path view)

Converts the FileOwnerAttributeView instance to a materialised record.

The returned record includes:

• :path: the path to the file,
• :owner: the user principal that owns the file,
• :delegate: the underlying instance.

The returned record implements ReloadFileAttributes and UpdateFileOwner.

->posix-file-attribute-view clj

(->posix-file-attribute-view path view)

Converts the PosixFileAttributeView instance to a materialised record.

The returned record includes:

• :path: the path to the file,
• :file-key: an object that uniquely identifies the file,
• :size: the size of the file in bytes,
• :owner: the user principal acting as owner of the file,
• :group: the group principal acting as group for the file,
• :permissions: the POSIX permissions associated with the file,
• :last-modified-time: the last modified time of the file, as a string,
• :last-access-time: the last access time of the file, as a string,
• :creation-time: the creation time of the file, as a string,
• :regular-file?: whether the file is a regular file, as a boolean,
• :directory?: whether the file is a directory, as a boolean,
• :symbolic-link?: whether the file is a symbolic link, as a boolean,
• :other?: whether the file is something other than a regular file, directory or symbolic link, as a boolean,
• :delegate: the underlying instance.

The returned record implements ReloadFileAttributes, UpdateFileTimes, UpdateFileOwner, UpdateFileGroup and UpdatePosixFilePermissions.

->user-defined-file-attribute-view clj

(->user-defined-file-attribute-view path view)

Converts the UserDefinedFileAttributeView instance to a materialised record.

The returned record includes:

• :path: the path to the file,
• :attributes: a map of user defined file attributes with keyword keys and byte array values,
• :delegate: the underlying instance.

The returned record implements ReloadFileAttributes and UpdateUserDefinedFileAttributes.

register-conversion clj

(register-conversion direction selector-spec converter)

Registers an attribute conversion to or from the specified attribute.

Takes 3 arguments:

• A direction, one of :to or :from,
• A selector spec, a tuple of the view and name of the attribute, as keywords,
• A converter function of arity 1, taking the value to convert.

Either the view or the name can be the wildcard, :* matching all attribute views or names respectively. Conversions registered for attributes that already have conversions defined take precedence.

In terms of conversion precedence taking wildcards into account, the order of precedence is:

1. Specific conversions,
2. Wildcard name conversions,
3. Wildcard view conversions,
4. All wildcard conversions.

ReloadFileAttributes clj protocol

A protocol allowing file attribute views to be reloaded from the backing file system.

reload clj

(reload view)

Reloads all attributes of the view.

UpdateDosFileAttributes clj protocol

A protocol allowing DOS file attributes to be updated.

For more details see the Java documentation.

set-archive clj

(set-archive view value)

Sets the archive attribute on the path to which the view corresponds to the boolean value.

set-hidden clj

(set-hidden view value)

Sets the hidden attribute on the path to which the view corresponds to the boolean value.

set-read-only clj

(set-read-only view value)

Sets the read-only attribute on the path to which the view corresponds to the boolean value.

set-system clj

(set-system view value)

Sets the system attribute on the path to which the view corresponds to the boolean value.

UpdateFileAcl clj protocol

A protocol allowing the access control list (ACL) of a file to be updated.

For more details see the Java documentation.

set-acl clj

(set-acl view acl-entries)

Sets the ACL of the path to which the view corresponds to the set of ACL entries.

Each ACL entry should be an ACL entry map. See pathological.utils/->acl-entry for more details on permissible values.

UpdateFileGroup clj protocol

A protocol allowing file groups to be updated.

For more details, see the Java documentation.

set-group clj

(set-group view group)

Sets the group on the path to which the view corresponds.

The group argument must implement GroupPrincipal. To aid in constructing such an instance, see pathological.principals/->group-principal.

UpdateFileOwner clj protocol

A protocol allowing file owners to be updated.

For more details, see the Java documentation.

set-owner clj

(set-owner view owner)

Sets the owner on the path to which the view corresponds.

The owner argument must implement UserPrincipal. To aid in constructing such an instance, see pathological.principals/->user-principal.

UpdateFileTimes clj protocol

A protocol allowing file times to be updated individually or all at once.

In each case, the time argument(s) should be strings or FileTime instances. To aid in constructing times, see pathological.utils/->file-time.

For more details, see the Java documentation.

set-creation-time clj

(set-creation-time view creation-time)

Sets the creation time on the path to which the view corresponds. If the time is nil, it should be left unmodified.

set-last-access-time clj

(set-last-access-time view last-access-time)

Sets the last access time on the path to which the view corresponds. If the time is nil, it should be left unmodified.

set-last-modified-time clj

(set-last-modified-time view last-modified-time)

Sets the last modified time on the path to which the view corresponds. If the time is nil, it should be left unmodified.

set-times clj

(set-times view last-modified-time last-access-time creation-time)

Sets the last modified, last access and creation times on the path to which the view corresponds. If any time is nil, it should be left unmodified.

UpdatePosixFilePermissions clj protocol

A protocol allowing file permissions to be updated.

For more details see the Java documentation.

set-permissions clj

(set-permissions view permissions)

Sets the permissions on the path to which the view corresponds.

The permissions argument should be a permission string or permission set. See pathological.utils/->posix-file-permissions for more details on permissible values.

UpdateUserDefinedFileAttributes clj protocol

A protocol allowing user defined file attributes to be updated.

For more details see the Java documentation.

delete-attribute clj

(delete-attribute view name)

Deletes the user defined attribute with the given name from the path to which the view corresponds.

write-attribute clj

(write-attribute view name value)

Writes the user defined attribute with the given name to the value on the path to which the view corresponds.

The attribute value can be a string, an array of bytes or a byte buffer. See pathological.utils/->byte-buffer for more details on permissible values.