org.osid.filing

Interface Summary
Interface	Description
Directory	`Directory` represents a directory in a file system that may contain other files and directories.
DirectoryAdminSession	This session creates and removes files and directories under the directory associated with this session.
DirectoryEntry	`DirectoryEntry` defines methods in common to both `File` and `Directory` .
DirectoryEntryForm	`DirectoryEntryForm` defines methods in common to both `FileForm` and `DirectoryForm.`
DirectoryEntryQuery	`DirectoryEntryQuery` defines methods in common to both `FileQuery` and `DirectoryQuery.`
DirectoryEntryQueryInspector	`DirectoryEntryQueryInspector` defines methods in common to both `FileQueryInspector` and `DirectoryQueryInspector.`
DirectoryEntrySearchOrder	An interface for specifying the order of search results.
DirectoryForm	This is the form for creating and updating `Directory` objects.
DirectoryList	Like all `OsidLists,` `DirectoryList` provides a means for accessing `Directory` elements sequentially either one at a time or many at a time.
DirectoryLookupSession	This session defines methods for looking up directories in the current directory.
DirectoryNotificationSession	This session defines methods to receive notifications on adds/changes to `Directories.`
DirectoryQuery	This is the query for searching directories.
DirectoryQueryInspector	This is the query inspector for examining directory queries.
DirectoryQuerySession	This session provides methods for searching among `Directory` objects.
DirectoryReceiver	The directory receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted directories.
DirectorySearch	The search interface for gioverning directory searches.
DirectorySearchOrder	An interface for specifying the ordering of search results.
DirectorySearchResults	This interface provides a means to capture results of a search.
DirectorySearchSession	This session provides methods for searching among `Directory` objects.
File	`File` represents a file in a file system.
FileContentSession	This session defines methods forreading and writing files.
FileForm	This is the form for creating and updating `Files.`
FileList	Like all `OsidLists,` `FileList` provides a means for accessing `File` elements sequentially either one at a time or many at a time.
FileLookupSession	This session defines methods for looking up on files in the current directory.
FileNotificationSession	This session defines methods to receive notifications on adds/changes to `Files.`
FileQuery	This is the query for searching files.
FileQueryInspector	This is the query inspector for examining file queries.
FileQuerySession	This session provides methods for searching among files and directories objects.
FileReceiver	The file receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted files.
FileSearch	The search interface for governing file searches.
FileSearchOrder	An interface for specifying the ordering of search results.
FileSearchResults	This interface provides a means to capture results of a search.
FileSearchSession	This session provides methods for searching among files and directories objects.
FileSmartDirectorySession	This session manages queries and sequencing to create "smart" dynamic catalogs.
FileSystemManagementSession	This session defines methods for operating on files and directories.
FileSystemSession	This session defines methods for examining file systems.
FilingManager	The filing manager provides access sessions to retrieve and manage files and directories.
FilingProfile	The filing profile describes the interoperability among filing services.
FilingProxyManager	The filing manager provides access sessions to retrieve and manage files and directories.

Package org.osid.filing Description

The Open Service Interface Definitions for the org.osid.filing service.

The Filing OSID provides a means for managing and accessing files and directories. The Filing OSID is used to abstract assumptions made about using a specific file system, or can be used to provide a file-based application a file system oriented view of other OSIDs.

Files

The Filing OSID defines a file access session that maps to a single File. This is the simplest application of the Filing OSID can be used in circumstances when it is desirable to confine knowledge of directories within a provider.

Directories

Directories are hierarchical OsidCatalogs of Files.

Differences from OSID Patterns

The Filing OSID assumes the pathname and filename of a File or Directory is globally unique. Typically, only the Id field is unique in an OsidObject. In the Filing OSID, there are two unique identifiers for identifying Files and Directories.

The Id is used to conform to existing OSID patterns and more easily create relationships to other auxiliary services such as the Journaling OSID, Relationship OSID, or the Ontology OSID. However, in a file system one is accustomed to traversing a file system using path names.

The standard OsidSessions refer to Files and Directories using their Ids. The file system-oriented and content sessions access and manipulate the file system using path names. Access to these sessions via the OsidManagers provide for both a path name and Directory Id.

The cataloging in the file system and content sessions behave differently than that in other OsidSessions. Typically, one is constrained to OsidObjects within the OsidCatalog, and its children in a federated view. In these sessions which use the path name as a key, Files and Directories outside the local Directory may be accessed with the use of absolute path names.

Finally, there are no hierarchical service patterns in the Directory OsidCatalog and a File or sub-directory may belong to one and only one Directory .

Example

      
      
      FilieSession session = filingManager.getFileContentSession();
      DataInputStream dis = session.getInputStream("/etc/passwd");

Sub Packages

The Filing OSID contains a Filing Allocation OSID for examining and managing file system utilization and user quotas.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may nodify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.