Package org.osid.filing
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.
Copyright © 2003-2004, 2007 Massachusetts Institute of Technology.
Copyright © 2010, 2014 Ingnescus. All Rights Reserved.
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.
-
InterfacesClassDescription
Directoryrepresents a directory in a file system that may contain other files and directories.This session creates and removes files and directories under the directory associated with this session.DirectoryEntrydefines methods in common to bothFileandDirectory.DirectoryEntryFormdefines methods in common to bothFileFormandDirectoryForm.DirectoryEntryQuerydefines methods in common to bothFileQueryandDirectoryQuery.DirectoryEntryQueryInspectordefines methods in common to bothFileQueryInspectorandDirectoryQueryInspector.An interface for specifying the order of search results.This is the form for creating and updatingDirectoryobjects.Like allOsidLists,DirectoryListprovides a means for accessingDirectoryelements sequentially either one at a time or many at a time.This session defines methods for looking up directories in the current directory.This session defines methods to receive notifications on adds/changes toDirectories.This is the query for searching directories.This is the query inspector for examining directory queries.This session provides methods for searching amongDirectoryobjects.The directory receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted directories.The search interface for gioverning directory searches.An interface for specifying the ordering of search results.This interface provides a means to capture results of a search.This session provides methods for searching amongDirectoryobjects.Filerepresents a file in a file system.This session defines methods forreading and writing files.This is the form for creating and updatingFiles.Like allOsidFormobjects, various data elements may be set here for use in the create and update methods in theFileAdminSession.Like allOsidLists,FileListprovides a means for accessingFileelements sequentially either one at a time or many at a time.This session defines methods for looking up on files in the current directory.This session defines methods to receive notifications on adds/changes toFiles.This is the query for searching files.This is the query inspector for examining file queries.This session provides methods for searching among files and directories objects.The file receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted files.The search interface for governing file searches.An interface for specifying the ordering of search results.This interface provides a means to capture results of a search.This session provides methods for searching among files and directories objects.This session manages queries and sequencing to create "smart" dynamic catalogs.This session defines methods for operating on files and directories.This session defines methods for examining file systems.The filing manager provides access sessions to retrieve and manage files and directories.The filing profile describes the interoperability among filing services.The filing manager provides access sessions to retrieve and manage files and directories.