|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.as400.access.UDFS
public class UDFS extends Object
The UDFS class represents a user-defined file system on the system.
| Modifier and Type | Class and Description |
|---|---|
class |
UDFS.MountedFsInformationStructure
Contains information about a mounted file system. |
class |
UDFS.UdfsInformationStructure
Contains information about a UDFS. |
| Constructor and Description |
|---|
UDFS(AS400 system,
String path)
Constructs a UDFS object. |
| Modifier and Type | Method and Description |
|---|---|
void |
create()
Creates a file system that can be made visible to the rest of the integrated file system name space through the mount() method. |
void |
create(String publicDataAuthority,
String[] publicObjectAuthority,
String auditingValue,
String scanningOption,
boolean specialRestrictions,
String defaultDiskStorageOption,
String defaultMainStorageOption,
String caseSensitivity,
String defaultFileFormat,
String description)
Creates a file system that can be made visible to the rest of the integrated file system name space through the mount() method. |
void |
delete()
Deletes an existing and unmounted user-defined file system (UDFS) and all of the objects within it. |
UDFS.MountedFsInformationStructure |
getMountedFsInformationStructure()
Returns information about a mounted file system. |
UDFS.UdfsInformationStructure |
getUdfsInformationStructure()
Returns information about a UDFS. |
void |
mount(String mountPoint)
Makes the objects in a file system accessible to the integrated file system name space. |
void |
mount(String mountPoint,
boolean rwOption,
boolean suidOption)
Makes the objects in a file system accessible to the integrated file system name space. |
void |
unmount()
Makes a previously mounted file system inaccessible within the integrated file system name space. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public UDFS(AS400 system,
String path)
system - The system object representing the system on which the UDFS exists.path - The path name of the file system. It must be in one of the following two forms:
The name part of the path must be unique within the specified qaspXX or aspname directory.
Wildcard characters such as '*' and '?' are not allowed in this parameter.
| Method Detail |
|---|
public void create()
throws AS400SecurityException,
ErrorCompletingRequestException,
InterruptedException,
IOException
A UDFS is represented by the object type *BLKSF, or block special file.
The public data authority and public object authority will be *INDIR, the auditing value will be *SYSVAL, the scanning option will be *PARENT, rename and unlink will not be restricted, the default disk storage option and the default main storage option will be *NORMAL, the case sensitivity will be *MONO, the default file format will be *TYPE2, and the description will be *BLANK.
Restrictions:
AS400SecurityExceptionErrorCompletingRequestExceptionInterruptedExceptionIOException
public void create(String publicDataAuthority,
String[] publicObjectAuthority,
String auditingValue,
String scanningOption,
boolean specialRestrictions,
String defaultDiskStorageOption,
String defaultMainStorageOption,
String caseSensitivity,
String defaultFileFormat,
String description)
throws AS400SecurityException,
ErrorCompletingRequestException,
InterruptedException,
IOException
A UDFS is represented by the object type *BLKSF, or block special file.
Restrictions:
publicDataAuthority - Specifies the public data authority given to the user for the new user-defined file system (UDFS), or specifies that all authorities are inherited from the directory it is to be created in. Possible values are:
publicObjectAuthority - Specifies the public object authority given to users for the user-defined file system, or specifies that all authorities are inherited from the directory it is to be created in. Possible values for the elements of this array are:
auditingValue - Specifies the auditing value of root directory objects created in this user-defined file system. Possible values are:
scanningOption - Specifies whether the root directory objects created in the user-defined file system will be scanned when exit programs are registered with any of the integrated file system scan-related exit points.
The integrated file system scan-related exit points are:
For details on these exit points, see the System API Reference information in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter.
Even though this attribute can be set for user-defined file systems, only objects which are in *TYPE2 directories in that user-defined file system will actually be scanned, no matter what value is set for this attribute.
Possible values are:
Note: If the Scan file systems control (QSCANFSCTL) value *NOPOSTRST is not specified when an object with this attribute is restored, the object will be scanned at least once after the restore.
Note: If the Scan file systems control (QSCANFSCTL) value *NOPOSTRST is not specified when an object with this attribute is restored, the object will be scanned at least once after the restore.
This parameter is ignored on Version 5 Release 2 and earlier of IBM i.
specialRestrictions - Specifies whether special restrictions apply for rename and unlink operations performed on objects within the root directory of the user-defined file system. This attribute is equivalent to the S_ISVTX mode bit for this directory. true if objects within the root directory of the user-defined file system may be renamed or unlinked only if one or more of the following are true for the user performing the operation:
false if no additional restrictions for renaming or unlinking objects from the root directory of the user-defined file system. This parameter is ignored on Version 5 Release 2 and earlier of IBM i.
defaultDiskStorageOption - Specifies how auxiliary storage will be allocated by the system for the stream files (*STMF) created in this user-defined file system. This option will be ignored for *TYPE1 stream files. Possible values are:
This parameter is ignored on Version 5 Release 4 and earlier of IBM i.
defaultMainStorageOption - Specifies how main storage is allocated and used by the system for the stream files (*STMF) created in this user-defined file system. Possible values are:
This parameter is ignored on Version 5 Release 4 and earlier of IBM i.
caseSensitivity - Specifies the case sensitivity of this file system. Possible values are:
defaultFileFormat - Specifies the format of stream files (*STMF) created in this user-defined file system. Possible values are:
description - Text description for the user-defined file system. Possible values are:
AS400SecurityExceptionErrorCompletingRequestExceptionInterruptedExceptionIOException
public void delete()
throws AS400SecurityException,
ErrorCompletingRequestException,
InterruptedException,
IOException
Restrictions:
AS400SecurityExceptionErrorCompletingRequestExceptionInterruptedExceptionIOException
public void mount(String mountPoint)
throws AS400SecurityException,
ErrorCompletingRequestException,
InterruptedException,
IOException
Restrictions:
mountPoint - Specifies the path name of the existing directory that the file system will be mounted over. This directory gets 'covered' by the mounted file system. This directory must exist.
Multiple file systems can be mounted over the same directory, one on top of the other. However, only the topmost mounted file system is accessible, and the file systems must later be unmounted in the opposite order from which they were mounted (last-in first-out order).
AS400SecurityExceptionErrorCompletingRequestExceptionInterruptedExceptionIOException
public void mount(String mountPoint,
boolean rwOption,
boolean suidOption)
throws AS400SecurityException,
ErrorCompletingRequestException,
InterruptedException,
IOException
Restrictions:
mountPoint - Specifies the path name of the existing directory that the file system will be mounted over. This directory gets 'covered' by the mounted file system. This directory must exist.
Multiple file systems can be mounted over the same directory, one on top of the other. However, only the topmost mounted file system is accessible, and the file systems must later be unmounted in the opposite order from which they were mounted (last-in first-out order).
rwOption - This option specifies the protection for the mounted file system. true if read-write, false if read-only.suidOption - This option specifies whether setuid execution is allowed. true if suid is specified and setuid execution is allowed. This means that bits other than the permission bits may be set. false if nosuid is specified, setuid execution is not allowed. This parameter is ignored on Version 5 Release 2 and earlier of IBM i.AS400SecurityExceptionErrorCompletingRequestExceptionInterruptedExceptionIOException
public void unmount()
throws AS400SecurityException,
ErrorCompletingRequestException,
InterruptedException,
IOException
Restrictions:
AS400SecurityExceptionErrorCompletingRequestExceptionInterruptedExceptionIOException
public UDFS.UdfsInformationStructure getUdfsInformationStructure()
throws AS400SecurityException,
ErrorCompletingRequestException,
InterruptedException,
IOException,
ObjectDoesNotExistException
AS400SecurityExceptionErrorCompletingRequestExceptionInterruptedExceptionIOExceptionObjectDoesNotExistException
public UDFS.MountedFsInformationStructure getMountedFsInformationStructure()
throws AS400SecurityException,
ErrorCompletingRequestException,
InterruptedException,
IOException,
ObjectDoesNotExistException
AS400SecurityExceptionErrorCompletingRequestExceptionInterruptedExceptionIOExceptionObjectDoesNotExistException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||