com.ibm.as400.access

Class FileAttributes

  • java.lang.Object
    • com.ibm.as400.access.FileAttributes


  • public class FileAttributes
    extends java.lang.Object
    Represents the set of file attributes that can be retrieved and set through the Qp0lGetAttr() and Qp0lSetAttr() API's. The object must exist and the caller must have authority to it. Only attributes supported by the specific file system, object type, and operating system release can be retrieved or set.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int DIRECTORY_FORMAT_TYPE1
      Constant indicating that the directory has format type 1.
      static int DIRECTORY_FORMAT_TYPE2
      Constant indicating that the directory has format type 2.
      static int FILE_FORMAT_TYPE1
      Constant indicating that the file has format type 1.
      static int FILE_FORMAT_TYPE2
      Constant indicating that the file has format type 2.
      static int JOURNAL_AFTER_IMAGES
      Constant indicating that when journaling is active, the image of the object after a change is journaled.
      static int JOURNAL_BEFORE_IMAGES
      Constant indicating that when journaling is active, the image of the object prior to a change is journaled.
      static int JOURNAL_OPTIONAL_ENTRIES
      Constant indicating that when journaling is active, entries that are considered optional are journaled.
      static int JOURNAL_SUBTREE
      Constant indicating that this object is a directory with IFS journaling subtree semantics.
      static int LOCAL_OBJECT
      Constant indicating that the object's data is stored locally.
      static int REMOTE_OBJECT
      Constant indicating that the object's data is on a remote system.
      static int SCAN_FAILURE
      Constant indicating that the object has been scanned by a scan-related exit program, and at the time of that last scan request, the object failed the scan and the operation did not complete.
      static int SCAN_NOT_REQUIRED
      Constant indicating that the object does not require any scanning because the object is marked to not be scanned.
      static int SCAN_PENDING_CONVERSION
      Constant indicating that the object is in a file system that has not completely converted to the *TYPE2 directory format, and therefore will not be scanned until the file system is completely converted.
      static int SCAN_REQUIRED
      Constant indicating that a scan is required for the object either because it has not yet been scanned by the scan-related exit programs, or because the objects data or CCSID has been modified since it was last scanned.
      static int SCAN_SUCCESS
      Constant indicating that the object has been scanned by a scan-related exit program, and at the time of that last scan request, the object did not fail the scan.
      static int SCANNING_CHANGE_ONLY
      Constant indicating that the object will be scanned only if the object has been modified since the last time the object was scanned.
      static int SCANNING_NO
      Constant indicating that the object will not be scanned.
      static int SCANNING_YES
      Constant indicating that the object will be scanned.
      static int STORAGE_DYNAMIC
      Constant indicating that the system will dynamically determine the optimum storage allocation for the object.
      static int STORAGE_MINIMIZE
      Constant indicating that storage will be allocated to minimize the space used by the object.
      static int STORAGE_NORMAL
      Constant indicating that storage will be allocated normally.
      static int SYSTEM_USE_NETWORK_SERVER_STORAGE
      Constant indicating that the file is a network server storage space.
      static int SYSTEM_USE_NONE
      Constant indicating that the file is a generic stream file.
      static int SYSTEM_USE_VIRTUAL_VOLUME
      Constant indicating that the file is a virtual volume.
      static int UDFS_DEFAULT_TYPE1
      Constant indicating that the default file format of stream files created in the user-defined file system is format type 1.
      static int UDFS_DEFAULT_TYPE2
      Constant indicating that the default file format of stream files created in the user-defined file system is format type 2.
      static int UDFS_PREFERRED_STORAGE_UNIT_ANY
      Constant indicating that no storage media is preferred.
      static int UDFS_PREFERRED_STORAGE_UNIT_SSD
      Constant indicating that solid state drive storage media is preferred.
    • Constructor Summary

      Constructors 
      Constructor and Description
      FileAttributes(AS400 system, java.lang.String path)
      Constructs a FileAttributes object.
      FileAttributes(AS400 system, java.lang.String path, boolean followSymbolicLink)
      Constructs a FileAttributes object.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean containsTemporaryObjects()
      Returns whether the objects in the user-defined file system (UDFS) are temporary system objects.
      java.util.Date getAccessTime()
      Returns the time that the object's data was last accessed.
      long getAllocatedSize()
      Returns the number of bytes that have been allocated for this object.
      short getAsp()
      Returns the auxiliary storage pool in which the object is stored.
      java.lang.String getAudit()
      Returns the auditing value associated with the object.
      java.lang.String getAuthorizationListName()
      Returns the name of the authorization list that is used to secure the named object.
      int getCcsid()
      Returns the CCSID of the data and extended attributes of the object.
      java.util.Date getChangeTime()
      Returns the time that the object's data or attributes were last changed.
      java.lang.String getCheckedOutUser()
      Returns the user who has the object checked out.
      java.util.Date getCheckOutTime()
      Returns the time the object was checked out.
      int getCodePage()
      Returns the code page derived from the coded character set identifier (CCSID) used for the data in the file or the extended attributes of the directory.
      java.lang.String getCreateObjectAuditing()
      Returns the create object auditing value associated with the directory.
      int getCreateObjectScan()
      Returns whether the objects created in a directory will be scanned when exit programs are registered with any of the integrated file system scan-related exit points.
      java.util.Date getCreateTime()
      Returns the time the object was created.
      long getDataSize()
      Returns the size in bytes of the data in this object.
      int getDaysUsedCount()
      Returns the number of days an object has been used.
      int getDirectoryFormat()
      Returns the format of the specified directory object.
      int getDiskStorageOption()
      Returns how auxiliary storage is allocated by the system for the specified object.
      long getExtendedAttributeSize()
      Returns the total number of extended attribute bytes.
      int getFileFormat()
      Returns the format of the stream file.
      byte[] getFileId()
      Returns the identifier associated with the referred to object.
      java.util.Date getJounalingStartTime()
      Deprecated. 
      java.lang.String getJournal()
      Returns the fully qualified integrated file system path name of the current or last journal.
      byte[] getJournalIdentifier()
      Returns the field that associates the object being journaled with an identifier that can be used on various journaling-related commands and APIs.
      int getJournalingOptions()
      Returns the current journaling options.
      java.util.Date getJournalingStartTime()
      Returns the last date and time for which the object had journaling started for it.
      java.util.Date getLastUsedDate()
      Returns the date the object was last used.
      int getLocalRemote()
      Returns whether the object is stored locally or stored on a remote system.
      int getMainStorageOption()
      Returns how main storage is allocated and used by the system for the specified object.
      java.util.Date getModifyTime()
      Returns the time that the object's data was last changed.
      java.lang.String getObjectOwner()
      Returns the name of the user profile that is the owner of the object.
      java.lang.String getObjectType()
      Returns the object type.
      java.lang.String getPrimaryGroup()
      Returns the name of the user profile that is the primary group of the object.
      java.util.Date getResetDate()
      Returns the date the days used count was last reset to zero (0).
      int getScan()
      Returns whether the object will be scanned when exit programs are registered with any of the integrated file system scan-related exit points.
      int getScanCcsid1()
      Returns the CCSID value that the object has been scanned in if it was previously scanned in a CCSID.
      int getScanCcsid2()
      Returns the CCSID value that the object has been scanned in if it was previously scanned in a CCSID.
      int getScanStatus()
      Returns the scan status associated with this object.
      java.lang.String getStartingJournalReceiverAspDevice()
      Returns the name of the ASP for the library that contains the starting journal receiver.
      java.lang.String getStartingJournalReceiverForApply()
      Returns the fully qualified integrated file system path name of the starting journal receiver for apply.
      int getSystemUse()
      Returns whether the file has a special use by the system.
      int getUdfsDefaultFormat()
      Returns the default file format of stream files (*STMF) created in the user-defined file system.
      int getUdfsPreferredStorageUnit()
      Returns the preferred storage media for the objects in the UDFS.
      boolean isAllowCheckpointWrite()
      Returns whether a stream file (*STMF) can be shared with readers and writers during the save-while-active checkpoint processing.
      boolean isAllowSave()
      Returns whether the object can be saved or not.
      boolean isApplyJournaledChangesRequired()
      Returns whether the object was restored with partial transactions which would require an Apply Journaled Changes (APYJRNCHG) command to complete the transaction.
      boolean isBinaryScan()
      Returns whether the object has been scanned in binary mode when it was previously scanned.
      boolean isCheckedOut()
      Returns whether the object is checked out or not.
      boolean isInheritAllowCheckpointWrite()
      Returns whether new objects created within a directory should inherit the save-while-active checkpoint processing options of its parent.
      boolean isJournalingStatus()
      Returns whether the object is currently being journaled.
      boolean isMultipleSignatures()
      Returns whether the object has more than one IBM i digital signature.
      boolean isPcArchive()
      Returns whether the object has changed since the last time the file was examined.
      boolean isPcHidden()
      Returns whether the object can be displayed using an ordinary directory listing.
      boolean isPcReadOnly()
      Returns whether the object can be written to or deleted, have its extended attributes changed or deleted, or have its size changed.
      boolean isPcSystem()
      Returns whether the object is a system file and is excluded from normal directory searches.
      boolean isRestrictedRenameAndUnlink()
      Returns whether renames and unlinks are restricted for objects within a directory.
      boolean isRollbackWasEnded()
      Returns whether the object had rollback ended prior to completion of a request to roll back a transaction.
      boolean isScanSignaturesDifferent()
      Returns whether the scan signatures are different.
      boolean isSetEffectiveGroupId()
      Returns whether the effective group ID (GID) is set at execution time.
      boolean isSetEffectiveUserId()
      Returns whether the effective user ID (UID) is set at execution time.
      boolean isSigned()
      Returns whether the object has an IBM i digital signature.
      boolean isStorageFree()
      Returns whether the object's data has been moved offline, freeing its online storage.
      boolean isSysRestrictSave()
      Returns whether the object can be written to or deleted, have its extended attributes changed or deleted, or have its size changed.
      boolean isSystemArchive()
      Returns whether the object has changed and needs to be saved.
      boolean isSystemSigned()
      Returns whether the object was signed by a source that is trusted by the system.
      boolean isTemporaryObject()
      Returns whether the object is a temporary system object.
      void refresh()
      Refreshes the attributes from the system.
      void resetDate()
      Resets the count of the number of days an object has been used.
      void setAccessTime(java.util.Date accessTime)
      Sets the time that the object's data was last accessed.
      void setAllowCheckpointWrite(boolean allowCheckpointWrite)
      Sets whether a stream file (*STMF) can be shared with readers and writers during the save-while-active checkpoint processing.
      void setAllowSave(boolean allowSave)
      Sets whether the object can be saved or not.
      void setCcsid(int ccsid)
      Sets the CCSID of the data and extended attributes of the object.
      void setCodePage(int codePage)
      Sets the code page used to derive a coded character set identifier (CCSID) used for the data in the file or the extended attributes of the directory.
      void setCreateObjectAuditing(java.lang.String createObjectAuditing)
      Sets the create object auditing value associated with the directory.
      void setCreateObjectScan(int createObjectScan)
      Sets whether the objects created in a directory will be scanned when exit programs are registered with any of the integrated file system scan-related exit points.
      void setCreateTime(java.util.Date createTime)
      Sets the time the object was created.
      void setDiskStorageOption(int diskStorageOption)
      Sets which option should be used to determine how auxiliary storage is allocated by the system for the specified object.
      void setInheritAllowCheckpointWrite(boolean inheritAllowCheckpointWrite)
      Sets whether new objects created within a directory should inherit the save-while-active checkpoint processing options of its parent.
      void setMainStorageOption(int mainStorageOption)
      Sets which option should be used to determine how main storage is allocated and used by the system for the specified object.
      void setModifyTime(java.util.Date modifyTime)
      Sets the time that the object's data was last changed.
      void setPcArchive(boolean pcArchive)
      Sets whether the object has changed since the last time the file was saved or reset by a PC client.
      void setPcHidden(boolean pcHidden)
      Sets the whether the object can be displayed using an ordinary directory listing.
      void setPcReadOnly(boolean pcReadOnly)
      Sets whether the object can be written to or deleted, have its extended attributes changed or deleted, or have its size changed.
      void setPcSystem(boolean pcSystem)
      Sets whether the object is a system file and is excluded from normal directory searches.
      void setRestrictedRenameAndUnlink(boolean restrictedRenameAndUnlink)
      Sets whether renames and unlinks are restricted for objects within a directory.
      void setScan(int scan)
      Sets the whether the object will be scanned when exit programs are registered with any of the integrated file system scan-related exit points.
      void setSetEffectiveGroupId(boolean setEffectiveGroupId)
      Sets whether the effective group ID (GID) is set at execution time.
      void setSetEffectiveUserId(boolean setEffectiveUserId)
      Sets whether the effective user ID (UID) is set at execution time.
      void setSystemArchive(boolean systemArchive)
      Sets whether the object has changed and needs to be saved.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • UDFS_DEFAULT_TYPE1

        public static final int UDFS_DEFAULT_TYPE1
        Constant indicating that the default file format of stream files created in the user-defined file system is format type 1.
        See Also:
        getUdfsDefaultFormat(), Constant Field Values
      • UDFS_DEFAULT_TYPE2

        public static final int UDFS_DEFAULT_TYPE2
        Constant indicating that the default file format of stream files created in the user-defined file system is format type 2.
        See Also:
        getUdfsDefaultFormat(), Constant Field Values
      • UDFS_PREFERRED_STORAGE_UNIT_ANY

        public static final int UDFS_PREFERRED_STORAGE_UNIT_ANY
        Constant indicating that no storage media is preferred. Storage will be allocated from any available storage media.
        See Also:
        getUdfsPreferredStorageUnit(), Constant Field Values
      • UDFS_PREFERRED_STORAGE_UNIT_SSD

        public static final int UDFS_PREFERRED_STORAGE_UNIT_SSD
        Constant indicating that solid state drive storage media is preferred. Storage should be allocated from solid state drive storage media, if available.
        See Also:
        getUdfsPreferredStorageUnit(), Constant Field Values
      • SCAN_REQUIRED

        public static final int SCAN_REQUIRED
        Constant indicating that a scan is required for the object either because it has not yet been scanned by the scan-related exit programs, or because the objects data or CCSID has been modified since it was last scanned. Examples of object data or CCSID modifications are: writing to the object, directly or through memory mapping; truncating the object; clearing the object; and changing the objects CCSID attribute etc..
        See Also:
        getScanStatus(), Constant Field Values
      • SCAN_SUCCESS

        public static final int SCAN_SUCCESS
        Constant indicating that the object has been scanned by a scan-related exit program, and at the time of that last scan request, the object did not fail the scan.
        See Also:
        getScanStatus(), Constant Field Values
      • SCAN_FAILURE

        public static final int SCAN_FAILURE
        Constant indicating that the object has been scanned by a scan-related exit program, and at the time of that last scan request, the object failed the scan and the operation did not complete. Once an object has been marked as a failure, it will not be scanned again until the object's scan signature is different than the global scan key signature or independent ASP group scan key signature as appropriate. Therefore, subsequent requests to work with the object will fail with a scan failure indication if that access meets the criteria for when an object is to be scanned. Examples of requests which will fail are opening the object with more than write-only access, changing the CCSID of the object, copying the object etc.. See Integrated File System Scan on Open Exit Programs and Integrated File System Scan on Close Exit Programs for the criteria for when an object is to be scanned. Note: 1. If scanning has been turned off using the QSCANFS system value, or if no exit programs are registered for a specific exit point, then any requests which trigger that specific exit point will return a scan failure indication. 2. If the scan attribute is set to not scan the object, then requests to work with the object will not fail with a scan failure indication.
        See Also:
        getScanStatus(), Constant Field Values
      • SCAN_PENDING_CONVERSION

        public static final int SCAN_PENDING_CONVERSION
        Constant indicating that the object is in a file system that has not completely converted to the *TYPE2 directory format, and therefore will not be scanned until the file system is completely converted. For information on the *TYPE2 directory format, see the Convert Directory (CVTDIR) command and the Integrated file system information in the Files and file systems topic.
        See Also:
        getScanStatus(), Constant Field Values
      • SCAN_NOT_REQUIRED

        public static final int SCAN_NOT_REQUIRED
        Constant indicating that the object does not require any scanning because the object is marked to not be scanned.
        See Also:
        getScanStatus(), Constant Field Values
      • JOURNAL_SUBTREE

        public static final int JOURNAL_SUBTREE
        Constant indicating that this object is a directory with IFS journaling subtree semantics. New objects created within this directory's subtree will inherit the journaling attributes and options from this directory.
        See Also:
        getJournalingOptions(), Constant Field Values
      • JOURNAL_OPTIONAL_ENTRIES

        public static final int JOURNAL_OPTIONAL_ENTRIES
        Constant indicating that when journaling is active, entries that are considered optional are journaled. The list of optional journal entries varies for each object type. See the Integrated file system information in the Files and file systems topic for information regarding these optional entries for various objects.
        See Also:
        getJournalingOptions(), Constant Field Values
      • JOURNAL_AFTER_IMAGES

        public static final int JOURNAL_AFTER_IMAGES
        Constant indicating that when journaling is active, the image of the object after a change is journaled.
        See Also:
        getJournalingOptions(), Constant Field Values
      • JOURNAL_BEFORE_IMAGES

        public static final int JOURNAL_BEFORE_IMAGES
        Constant indicating that when journaling is active, the image of the object prior to a change is journaled.
        See Also:
        getJournalingOptions(), Constant Field Values
      • SYSTEM_USE_VIRTUAL_VOLUME

        public static final int SYSTEM_USE_VIRTUAL_VOLUME
        Constant indicating that the file is a virtual volume. Examples include tape and optical virtual volumes.
        See Also:
        getSystemUse(), Constant Field Values
      • SYSTEM_USE_NETWORK_SERVER_STORAGE

        public static final int SYSTEM_USE_NETWORK_SERVER_STORAGE
        Constant indicating that the file is a network server storage space.
        See Also:
        getSystemUse(), Constant Field Values
    • Constructor Detail

      • FileAttributes

        public FileAttributes(AS400 system,
                      java.lang.String path)
        Constructs a FileAttributes object. If the file specified by path is a symbolic link, the link is followed to its destination.
        Parameters:
        system - The system object representing the system on which the file exists.
        path - The path name of the object for which attribute information is retrieved or set.
      • FileAttributes

        public FileAttributes(AS400 system,
                      java.lang.String path,
                      boolean followSymbolicLink)
        Constructs a FileAttributes object.
        Parameters:
        system - The system object representing the system on which the file exists.
        path - The path name of the object for which attribute information is retrieved or set.
        followSymbolicLink - If the last component in the path is a symbolic link, indicates if the symbolic link is followed. true to operate on the attributes of the object contained in the symbolic link, false to operate on the symbolic link.
    >
    • Method Detail

      • isCheckedOut

        public boolean isCheckedOut()
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    java.lang.InterruptedException,
                                    java.io.IOException,
                                    ObjectDoesNotExistException
        Returns whether the object is checked out or not. When an object is checked out, other users can read and copy the object. Only the user who has the object checked out can change the object.
        Returns:
        true if object is checked out; false otherwise.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getLocalRemote

        public int getLocalRemote()
                           throws AS400SecurityException,
                                  ErrorCompletingRequestException,
                                  java.lang.InterruptedException,
                                  java.io.IOException,
                                  ObjectDoesNotExistException
        Returns whether the object is stored locally or stored on a remote system. The decision of whether a file is local or remote varies according to the respective file system rules. Objects in file systems that do not carry either a local or remote indicator are treated as remote.
        Returns:
        The location of an object's storage. Possible values are:
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getObjectOwner

        public java.lang.String getObjectOwner()
                                        throws AS400SecurityException,
                                               ErrorCompletingRequestException,
                                               java.lang.InterruptedException,
                                               java.io.IOException,
                                               ObjectDoesNotExistException
        Returns the name of the user profile that is the owner of the object.
        Returns:
        The name of the user profile that is the owner of the object or the special value "*NOUSRPRF" which is an indication by the Network File System that there is no user profile on the local IBM i system with a user ID (UID) matching the UID of the remote object.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getPrimaryGroup

        public java.lang.String getPrimaryGroup()
                                         throws AS400SecurityException,
                                                ErrorCompletingRequestException,
                                                java.lang.InterruptedException,
                                                java.io.IOException,
                                                ObjectDoesNotExistException
        Returns the name of the user profile that is the primary group of the object.
        Returns:
        The name of the user profile that is the primary group of the object or the following special values:
        • "*NONE" - The object does not have a primary group.
        • "*NOUSRPRF" - This special value is used by the Network File System to indicate that there is no user profile on the local system with a group ID (GID) matching the GID of the remote object.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getAuthorizationListName

        public java.lang.String getAuthorizationListName()
                                                  throws AS400SecurityException,
                                                         ErrorCompletingRequestException,
                                                         java.lang.InterruptedException,
                                                         java.io.IOException,
                                                         ObjectDoesNotExistException
        Returns the name of the authorization list that is used to secure the named object.
        Returns:
        The name of the authorization list that is used to secure the named object. The value *NONE indicates that no authorization list is used in determining authority to the object.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getAsp

        public short getAsp()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            java.lang.InterruptedException,
                            java.io.IOException,
                            ObjectDoesNotExistException
        Returns the auxiliary storage pool in which the object is stored.
        Returns:
        The auxiliary storage pool (ASP) in which the object is stored. Possible values are:
        • 1: the system ASP (QASP01, also known as the system disk pool)
        • 2 to 32: user ASPs (QASP02 to QASP32)
        • 33 to 255: independent ASPs
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getDataSize

        public long getDataSize()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException
        Returns the size in bytes of the data in this object. The size varies by object type and file system. This size does not include object headers or the size of extended attributes associated with the object.
        Returns:
        The size in bytes of the data in this object.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getAllocatedSize

        public long getAllocatedSize()
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException
        Returns the number of bytes that have been allocated for this object. The allocated size varies by object type and file system. For example, the allocated size includes the object data size as shown in getDataSize() as well as any logically sized extents to accommodate anticipated future requirements for the object data. It may or may not include additional bytes for attribute information.
        Returns:
        The number of bytes that have been allocated for this object.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getResetDate

        public java.util.Date getResetDate()
                                    throws AS400SecurityException,
                                           ErrorCompletingRequestException,
                                           java.lang.InterruptedException,
                                           java.io.IOException,
                                           ObjectDoesNotExistException
        Returns the date the days used count was last reset to zero (0). This date is set to the current date when resetDate() is called to reset the days used count to zero.
        Returns:
        The date the days used count was last reset to zero (0).
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getLastUsedDate

        public java.util.Date getLastUsedDate()
                                       throws AS400SecurityException,
                                              ErrorCompletingRequestException,
                                              java.lang.InterruptedException,
                                              java.io.IOException,
                                              ObjectDoesNotExistException
        Returns the date the object was last used. If the object has not been used or if usage data is not maintained for the IBM i type or the file system to which an object belongs, null is returned.
        Returns:
        The date the object was last used.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getDaysUsedCount

        public int getDaysUsedCount()
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    java.lang.InterruptedException,
                                    java.io.IOException,
                                    ObjectDoesNotExistException
        Returns the number of days an object has been used. Usage has different meanings according to the specific file system and according to the individual object types supported within a file system. Usage can indicate the opening or closing of a file or can refer to adding links, renaming, restoring, or checking out an object. This count is incremented once each day that an object is used and is reset to zero by calling resetDate().
        Returns:
        The number of days an object has been used.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isSystemArchive

        public boolean isSystemArchive()
                                throws AS400SecurityException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException
        Returns whether the object has changed and needs to be saved. It is set on when an object's change time is updated, and set off when the object has been saved.
        Returns:
        true if the object has changed and does need to be saved; false otherwise.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setSystemArchive

        public void setSystemArchive(boolean systemArchive)
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException
        Sets whether the object has changed and needs to be saved. It is set on when an object's change time is updated, and set off when the object has been saved.
        Parameters:
        systemArchive - true if the object has changed and does need to be saved; false otherwise.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getCodePage

        public int getCodePage()
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               java.lang.InterruptedException,
                               java.io.IOException,
                               ObjectDoesNotExistException
        Returns the code page derived from the coded character set identifier (CCSID) used for the data in the file or the extended attributes of the directory. If the returned value of this field is zero (0), there is more than one code page associated with the st_ccsid. If the st_ccsid is not a supported system CCSID, the st_codepage is set equal to the st_ccsid.
        Returns:
        The code page derived from the coded character set identifier (CCSID) used for the data in the file or the extended attributes of the directory.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setCodePage

        public void setCodePage(int codePage)
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException
        Sets the code page used to derive a coded character set identifier (CCSID) used for the data in the file or the extended attributes of the directory.
        Parameters:
        codePage - The code page used to derive a coded character set identifier (CCSID) used for the data in the file or the extended attributes of the directory.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getFileFormat

        public int getFileFormat()
                          throws AS400SecurityException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException
        Returns the format of the stream file.
        Returns:
        The format of the stream file (*STMF). Possible values are:
        • FILE_FORMAT_TYPE1 - The object has the same format as *STMF objects created on releases prior to Version 4 Release 4. It has a minimum object size of 4096 bytes and a maximum object size of approximately 128 gigabytes.
        • FILE_FORMAT_TYPE2 - The *STMF has high performance file access and was new in OS/400 V4R4. It has a minimum object size of 4096 bytes and a maximum object size of approximately one terabyte in the "root" (/), QOpenSys and user-defined file systems. Otherwise, the maximum is approximately 256 gigabytes. A *TYPE2 *STMF is capable of memory mapping as well as the ability to specify an attribute to optimize disk storage allocation.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getUdfsDefaultFormat

        public int getUdfsDefaultFormat()
                                 throws AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException
        Returns the default file format of stream files (*STMF) created in the user-defined file system.
        Returns:
        The default file format of stream files (*STMF) created in the user-defined file system. Possible values are:
        • UDFS_DEFAULT_TYPE1 - The stream file (*STMF) has the same format as *STMF's created on releases prior to OS/400 V4R4. It has a minimum object size of 4096 bytes and a maximum object size of approximately 256 gigabytes.
        • UDFS_DEFAULT_TYPE2 - A *TYPE2 *STMF has high performance file access and was new in OS/400 V4R4. It has a minimum object size of 4096 bytes and a maximum object size of approximately one terabyte in the "root" (/), QOpenSys and user-defined file systems. Otherwise, the maximum is approximately 256 gigabytes. A *TYPE2 *STMF is capable of memory mapping as well as the ability to specify an attribute to optimize disk storage allocation.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isAllowCheckpointWrite

        public boolean isAllowCheckpointWrite()
                                       throws AS400SecurityException,
                                              ErrorCompletingRequestException,
                                              java.lang.InterruptedException,
                                              java.io.IOException,
                                              ObjectDoesNotExistException
        Returns whether a stream file (*STMF) can be shared with readers and writers during the save-while-active checkpoint processing.
        Returns:
        true if the object can be shared with readers and writers; false if the object can be shared with readers only.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setAllowCheckpointWrite

        public void setAllowCheckpointWrite(boolean allowCheckpointWrite)
                                     throws AS400SecurityException,
                                            ErrorCompletingRequestException,
                                            java.lang.InterruptedException,
                                            java.io.IOException,
                                            ObjectDoesNotExistException
        Sets whether a stream file (*STMF) can be shared with readers and writers during the save-while-active checkpoint processing. Setting this attribute may cause unexpected results. See the Back up your system topic for details on this attribute.
        Parameters:
        allowCheckpointWrite - true if the object can be shared with readers and writers; false if the object can be shared with readers only.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isSystemSigned

        public boolean isSystemSigned()
                               throws AS400SecurityException,
                                      ErrorCompletingRequestException,
                                      java.lang.InterruptedException,
                                      java.io.IOException,
                                      ObjectDoesNotExistException
        Returns whether the object was signed by a source that is trusted by the system. This attribute is only returned for *STMF objects.
        Returns:
        true if the object was signed by a source that is trusted by the system, if the object has multiple signatures, at least one of the signatures came from a source that is trusted by the system; false otherwise.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getDiskStorageOption

        public int getDiskStorageOption()
                                 throws AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException
        Returns how auxiliary storage is allocated by the system for the specified object. This option can only be specified for stream files in the "root" (/), QOpenSys and user-defined file systems. This option will be ignored for *TYPE1 byte stream files.
        Returns:
        How auxiliary storage is allocated by the system for the specified object. Possible values are:
        • STORAGE_NORMAL - The auxiliary storage will be allocated normally. That is, as additional auxiliary storage is required, it will be allocated in logically sized extents to accommodate the current space requirement, and anticipated future requirements, while minimizing the number of disk I/O operations.
        • STORAGE_MINIMIZE - The auxiliary storage will be allocated to minimize the space used by the object. That is, as additional auxiliary storage is required, it will be allocated in small sized extents to accommodate the current space requirement. Accessing an object composed of many small extents may increase the number of disk I/O operations for that object.
        • STORAGE_DYNAMIC - The system will dynamically determine the optimum auxiliary storage allocation for the object, balancing space used versus disk I/O operations. For example, if a file has many small extents, yet is frequently being read and written, then future auxiliary storage allocations will be larger extents to minimize the number of disk I/O operations. Or, if a file is frequently truncated, then future auxiliary storage allocations will be small extents to minimize the space used. Additionally, information will be maintained on the stream file sizes for this system and its activity. This file size information will also be used to help determine the optimum auxiliary storage allocations for this object as it relates to the other objects sizes.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setDiskStorageOption

        public void setDiskStorageOption(int diskStorageOption)
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException
        Sets which option should be used to determine how auxiliary storage is allocated by the system for the specified object. The option will take effect immediately and be part of the next auxiliary storage allocation for the object. This option can only be specified for byte stream files in the "root" (/), QOpenSys and user-defined file systems. This option will be ignored for *TYPE1 byte stream files.
        Parameters:
        diskStorageOption - The option which should be used to determine how auxiliary storage is allocated by the system for the specified object. Possible values are:
        • STORAGE_NORMAL - The auxiliary storage will be allocated normally. That is, as additional auxiliary storage is required, it will be allocated in logically sized extents to accommodate the current space requirement, and anticipated future requirements, while minimizing the number of disk I/O operations. This option is the default.
        • STORAGE_MINIMIZE - The auxiliary storage will be allocated to minimize the space used by the object. That is, as additional auxiliary storage is required, it will be allocated in small sized extents to accommodate the current space requirement. Accessing an object composed of many small extents may increase the number of disk I/O operations for that object.
        • STORAGE_DYNAMIC - The system will dynamically determine the optimum auxiliary storage allocation for the object, balancing space used versus disk I/O operations. For example, if a file has many small extents, yet is frequently being read and written, then future auxiliary storage allocations will be larger extents to minimize the number of disk I/O operations. Or, if a file is frequently truncated, then future auxiliary storage allocations will be small extents to minimize the space used. Additionally, information will be maintained on the stream file sizes for this system and its activity. This file size information will also be used to help determine the optimum auxiliary storage allocations for this object as it relates to the other objects sizes.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getMainStorageOption

        public int getMainStorageOption()
                                 throws AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException
        Returns how main storage is allocated and used by the system for the specified object. This option can only be specified for stream files in the "root" (/), QOpenSys and user-defined file systems.
        Returns:
        How main storage is allocated and used by the system for the specified object. Possible values are:
        • STORAGE_NORMAL - The main storage will be allocated normally. That is, as much main storage as possible will be allocated and used. This minimizes the number of disk I/O operations since the information is cached in main storage.
        • STORAGE_MINIMIZE - The main storage will be allocated to minimize the space used by the object. That is, as little main storage as possible will be allocated and used. This minimizes main storage usage while increasing the number of disk I/O operations since less information is cached in main storage.
        • STORAGE_DYNAMIC - The system will dynamically determine the optimum main storage allocation for the object depending on other system activity and main storage contention. That is, when there is little main storage contention, as much storage as possible will be allocated and used to minimize the number of disk I/O operations. And when there is significant main storage contention, less main storage will be allocated and used to minimize the main storage contention. This option only has an effect when the storage pool's paging option is *CALC. When the storage pool's paging option is *FIXED, the behavior is the same as STORAGE_NORMAL. When the object is accessed through a file server, this option has no effect. Instead, its behavior is the same as STORAGE_NORMAL.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setMainStorageOption

        public void setMainStorageOption(int mainStorageOption)
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException
        Sets which option should be used to determine how main storage is allocated and used by the system for the specified object. The option will take effect the next time the specified object is opened. This option can only be specified for byte stream files in the "root" (/), QOpenSys and user-defined file systems.
        Parameters:
        mainStorageOption - The option which should be used to determine how main storage is allocated and used by the system for the specified object. Possible values are:
        • STORAGE_NORMAL - The main storage will be allocated normally. That is, as much main storage as possible will be allocated and used. This minimizes the number of disk I/O operations since the information is cached in main storage. This option is the default.
        • STORAGE_MINIMIZE - The main storage will be allocated to minimize the space used by the object. That is, as little main storage as possible will be allocated and used. This minimizes main storage usage while increasing the number of disk I/O operations since less information is cached in main storage.
        • STORAGE_DYNAMIC - The system will dynamically determine the optimum main storage allocation for the object depending on other system activity and main storage contention. That is, when there is little main storage contention, as much storage as possible will be allocated and used to minimize the number of disk I/O operations. And when there is significant main storage contention, less main storage will be allocated and used to minimize the main storage contention. This option only has an effect when the storage pool's paging option is *CALC. When the storage pool's paging option is *FIXED, the behavior is the same as *NORMAL. When the object is accessed through a file server, this option has no effect. Instead, its behavior is the same as *NORMAL.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isInheritAllowCheckpointWrite

        public boolean isInheritAllowCheckpointWrite()
                                              throws AS400SecurityException,
                                                     ErrorCompletingRequestException,
                                                     java.lang.InterruptedException,
                                                     java.io.IOException,
                                                     ObjectDoesNotExistException
        Returns whether new objects created within a directory should inherit the save-while-active checkpoint processing options of its parent.
        Returns:
        true if the object can inherit the save-while-active checkpoint processing options of its parent, otherwise return false.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setInheritAllowCheckpointWrite

        public void setInheritAllowCheckpointWrite(boolean inheritAllowCheckpointWrite)
                                            throws AS400SecurityException,
                                                   ErrorCompletingRequestException,
                                                   java.lang.InterruptedException,
                                                   java.io.IOException,
                                                   ObjectDoesNotExistException
        Sets whether new objects created within a directory should inherit the save-while-active checkpoint processing options of its parent.
        Parameters:
        inheritAllowCheckpointWrite - true if the object can inherit the save-while-active checkpoint processing options of its parent, otherwise return false.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getDirectoryFormat

        public int getDirectoryFormat()
                               throws AS400SecurityException,
                                      ErrorCompletingRequestException,
                                      java.lang.InterruptedException,
                                      java.io.IOException,
                                      ObjectDoesNotExistException
        Returns the format of the specified directory object.
        Returns:
        The format of the specified directory object. Possible values are:
        • DIRECTORY_FORMAT_TYPE1 - The directory of type *DIR has the original directory format. The Convert Directory (CVTDIR) command may be used to convert from the *TYPE1 format to the *TYPE2 format.
        • DIRECTORY_FORMAT_TYPE2 - The directory of type *DIR is optimized for performance, size, and reliability compared to directories having the *TYPE1 format.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getAudit

        public java.lang.String getAudit()
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException
        Returns the auditing value associated with the object. Note: The user must have all object (*ALLOBJ) or audit (*AUDIT) special authority to retrieve the auditing value.
        Returns:
        The auditing value associated with the object. Possible values are:
        • "*NONE" - No auditing occurs for this object when it is read or changed regardless of the user who is accessing the object.
        • "*USRPRF" - Audit this object only if the current user is being audited. The current user is tested to determine if auditing should be done for this object. The user profile can specify if only change access is audited or if both read and change accesses are audited for this object. The OBJAUD parameter of the Change User Auditing (CHGUSRAUD) command is used to change the auditing for a specific user.
        • "*CHANGE" - Audit all change access to this object by all users on the system.
        • "*ALL" - Audit all access to this object by all users on the system. All access is defined as a read or change operation.
        • "*NOTAVL" - The user performing the operation is not allowed to retrieve the current auditing value.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getCreateObjectScan

        public int getCreateObjectScan()
                                throws AS400SecurityException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException
        Returns whether the objects created in a directory will be scanned when exit programs are registered with any of the integrated file system scan-related exit points. This attribute can only have been specified for directories in the "root" (/), QOpenSys and user-defined file systems. Even though this attribute can be set for *TYPE1 and *TYPE2 directories, only objects which are in file systems that have completely converted to the *TYPE2 directory format will actually be scanned, no matter what value is set for this attribute.
        Returns:
        Whether the objects created in a directory will be scanned when exit programs are registered with any of the integrated file system scan-related exit points. Possible values are:
        • SCANNING_NO - After an object is created in the directory, the object will not be scanned according to the rules described in the scan-related exit programs. 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.
        • SCANNING_YES - After an object is created in the directory, the object will be scanned according to the rules described in the scan-related exit programs if the object has been modified or if the scanning software has been updated since the last time the object was scanned.
        • SCANNING_CHANGE_ONLY - After an object is created in the directory, the object will be scanned according to the rules described in the scan-related exit programs only if the object has been modified since the last time the object was scanned. It will not be scanned if the scanning software has been updated. This attribute only takes effect if the Scan file systems control (QSCANFSCTL) system value has *USEOCOATR specified. Otherwise, it will be treated as if the attribute is SCANNING_YES. 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.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setCreateObjectScan

        public void setCreateObjectScan(int createObjectScan)
                                 throws AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException
        Sets whether the objects created in a directory will be scanned when exit programs are registered with any of the integrated file system scan-related exit points. This attribute can only be specified for directories in the "root" (/), QOpenSys and user-defined file systems. Even though this attribute can be set for *TYPE1 and *TYPE2 directories, only objects which are in *TYPE2 directories will actually be scanned, no matter what value is set for this attribute.
        Parameters:
        createObjectScan - Whether the objects created in a directory will be scanned when exit programs are registered with any of the integrated file system scan-related exit points. Possible values are:
        • SCANNING_NO - After an object is created in the directory, the object will not be scanned according to the rules described in the scan-related exit programs. 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.
        • SCANNING_YES - After an object is created in the directory, the object will be scanned according to the rules described in the scan-related exit programs if the object has been modified or if the scanning software has been updated since the last time the object was scanned. This value is the default.
        • SCANNING_CHANGE_ONLY - After an object is created in the directory, the object will be scanned according to the rules described in the scan-related exit programs only if the object has been modified since the last time the object was scanned. It will not be scanned if the scanning software has been updated. This attribute only takes effect if the Scan file systems control (QSCANFSCTL) system value has *USEOCOATR specified. Otherwise, it will be treated as if the attribute is SCANNING_YES. 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.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getScan

        public int getScan()
                    throws AS400SecurityException,
                           ErrorCompletingRequestException,
                           java.lang.InterruptedException,
                           java.io.IOException,
                           ObjectDoesNotExistException
        Returns whether the object will be scanned when exit programs are registered with any of the integrated file system scan-related exit points. This attribute can only have been specified for stream files in the "root" (/), QOpenSys and user-defined file systems. Even though this attribute can be set for objects in *TYPE1 and *TYPE2 directories, only objects which are in file systems that have completely converted to the *TYPE2 directory format will actually be scanned, no matter what value is set for this attribute.
        Returns:
        Whether the object will be scanned when exit programs are registered with any of the integrated file system scan-related exit points. Possible values are:
        • SCANNING_NO - The object will not be scanned according to the rules described in the scan-related exit programs. 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.
        • SCANNING_YES - The object will be scanned according to the rules described in the scan-related exit programs if the object has been modified or if the scanning software has been updated since the last time the object was scanned.
        • SCANNING_CHANGE_ONLY - The object will be scanned according to the rules described in the scan-related exit programs only if the object has been modified since the last time the object was scanned. It will not be scanned if the scanning software has been updated. This attribute only takes effect if the Scan file systems control (QSCANFSCTL) system value has *USEOCOATR specified. Otherwise, it will be treated as if the attribute is SCANNING_YES. 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.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setScan

        public void setScan(int scan)
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            java.lang.InterruptedException,
                            java.io.IOException,
                            ObjectDoesNotExistException
        Sets the whether the object will be scanned when exit programs are registered with any of the integrated file system scan-related exit points. This attribute can only be specified for stream files in the "root" (/), QOpenSys and user-defined file systems that are not virtual volumes or network server storage spaces. Even though this attribute can be set for objects in *TYPE1 and *TYPE2 directories, only objects which are in *TYPE2 directories will actually be scanned, no matter what value is set for this attribute.
        Parameters:
        scan - Whether the object will be scanned when exit programs are registered with any of the integrated file system scan-related exit points. Possible values are:
        • SCANNING_NO - The object will not be scanned according to the rules described in the scan-related exit programs. 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.
        • SCANNING_YES - The object will be scanned according to the rules described in the scan-related exit programs if the object has been modified or if the scanning software has been updated since the last time the object was scanned. This value is the default.
        • SCANNING_CHANGE_ONLY - The object will be scanned according to the rules described in the scan-related exit programs only if the object has been modified since the last time the object was scanned. It will not be scanned if the scanning software has been updated. This attribute only takes effect if the Scan file systems control (QSCANFSCTL) system value has *USEOCOATR specified. Otherwise, it will be treated as if the attribute is SCANNING_YES. 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.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getScanStatus

        public int getScanStatus()
                          throws AS400SecurityException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException
        Returns the scan status associated with this object.
        Returns:
        The scan status associated with this object. Possible values are:
        • SCAN_REQUIRED - A scan is required for the object either because it has not yet been scanned by the scan-related exit programs, or because the objects data or CCSID has been modified since it was last scanned. Examples of object data or CCSID modifications are: writing to the object, directly or through memory mapping; truncating the object; clearing the object; and changing the objects CCSID attribute etc..
        • SCAN_SUCCESS - The object has been scanned by a scan-related exit program, and at the time of that last scan request, the object did not fail the scan.
        • SCAN_FAILURE - The object has been scanned by a scan-related exit program, and at the time of that last scan request, the object failed the scan and the operation did not complete. Once an object has been marked as a failure, it will not be scanned again until the object's scan signature is different than the global scan key signature or independent ASP group scan key signature as appropriate. Therefore, subsequent requests to work with the object will fail with a scan failure indication if that access meets the criteria for when an object is to be scanned. Examples of requests which will fail are opening the object with more than write-only access, changing the CCSID of the object, copying the object etc.. See Integrated File System Scan on Open Exit Programs and Integrated File System Scan on Close Exit Programs for the criteria for when an object is to be scanned. Note: 1. If scanning has been turned off using the QSCANFS system value, or if no exit programs are registered for a specific exit point, then any requests which trigger that specific exit point will return a scan failure indication. 2. If the scan attribute is set to not scan the object, then requests to work with the object will not fail with a scan failure indication.
        • SCAN_PENDING_CONVERSION - The object is in a file system that has not completely converted to the *TYPE2 directory format, and therefore will not be scanned until the file system is completely converted. For information on the *TYPE2 directory format, see the Convert Directory (CVTDIR) command and the Integrated file system information in the Files and file systems topic.
        • SCAN_NOT_REQUIRED - The object does not require any scanning because the object is marked to not be scanned.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isScanSignaturesDifferent

        public boolean isScanSignaturesDifferent()
                                          throws AS400SecurityException,
                                                 ErrorCompletingRequestException,
                                                 java.lang.InterruptedException,
                                                 java.io.IOException,
                                                 ObjectDoesNotExistException
        Returns whether the scan signatures are different. The scan signatures give an indication of the level of the scanning software support. For more information, see Scan Key List and Scan Key Signatures in Integrated File System Scan on Open Exit Program. When an object is in an independent ASP group, the object scan signature is compared to the associated independent ASP group scan signature. When an object is not in an independent ASP group, the object scan signature is compared to the global scan signature value.
        Returns:
        true if the compared signatures are different; false otherwise.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isBinaryScan

        public boolean isBinaryScan()
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    java.lang.InterruptedException,
                                    java.io.IOException,
                                    ObjectDoesNotExistException
        Returns whether the object has been scanned in binary mode when it was previously scanned.
        Returns:
        true if the object was scanned in binary mode; false otherwise. If the object scan status is SCAN_SUCCESS, then the object was successfully scanned in binary. If the object scan status is SCAN_FAILURE, then the object failed the scan in binary.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getScanCcsid1

        public int getScanCcsid1()
                          throws AS400SecurityException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException
        Returns the CCSID value that the object has been scanned in if it was previously scanned in a CCSID. If the object scan status is SCAN_SUCCESS, then the object was successfully scanned in this CCSID. If the object scan status is SCAN_FAILURE, then the object failed the scan in this CCSID. A value of 0 means this field does not apply.
        Returns:
        The CCSID value that the object has been scanned in if it was previously scanned in a CCSID.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getScanCcsid2

        public int getScanCcsid2()
                          throws AS400SecurityException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException
        Returns the CCSID value that the object has been scanned in if it was previously scanned in a CCSID. If the object scan status is SCAN_SUCCESS, then the object was successfully scanned in this CCSID. If the object scan status is SCAN_FAILURE, then this field will be 0. A value of 0 means this field does not apply.
        Returns:
        The CCSID value that the object has been scanned in if it was previously scanned in a CCSID.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isAllowSave

        public boolean isAllowSave()
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   java.lang.InterruptedException,
                                   java.io.IOException,
                                   ObjectDoesNotExistException
        Returns whether the object can be saved or not.
        Returns:
        true if the object will be saved when using the Save Object (SAV) command or the QsrSave() API. false if the object will not be saved when using the Save Object (SAV) command or the QsrSave() API. Additionally, if this object is a directory, none of the objects in the directory's subtree will be saved unless they were explicitly specified as an object to be saved. The subtree includes all subdirectories and the objects within those subdirectories. Note: If this attribute is chosen for an object that has private authorities associated with it, or is chosen for the directory of an object that has private authorities associated with it, then the following consideration applies. When the private authorities are saved, the fact that this attribute is false is not taken into consideration. (Private authorities can be saved using either the Save System (SAVSYS) or Save Security Data (SAVSECDTA) command or the Save Object List (QSRSAVO) API.) Therefore, when a private authority is restored using the Restore Authority (RSTAUT) command, message CPD3776 will be seen for each object that was not saved either because it had this attribute specified as false, or because the object was not specified on the save and it was in a directory that had this attribute specified as false.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setAllowSave

        public void setAllowSave(boolean allowSave)
                          throws AS400SecurityException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException
        Sets whether the object can be saved or not. Note: It is highly recommended that this attribute not be changed for any system created objects.
        Parameters:
        allowSave - true if the object will be saved when using the Save Object (SAV) command or the QsrSave() API. This value is the default. false if the object will not be saved when using the Save Object (SAV) command or the QsrSave() API. Additionally, if this object is a directory, none of the objects in the directory's subtree will be saved unless they were explicitly specified as an object to be saved. The subtree includes all subdirectories and the objects within those subdirectories. Note: If this attribute is chosen for an object that has private authorities associated with it, or is chosen for the directory of an object that has private authorities associated with it, then the following consideration applies. When the private authorities are saved, the fact that this attribute is false is not taken into consideration. (Private authorities can be saved using either the Save System (SAVSYS) or Save Security Data (SAVSECDTA) command or the Save Object List (QSRSAVO) API.) Therefore, when a private authority is restored using the Restore Authority (RSTAUT) command, message CPD3776 will be seen for each object that was not saved either because it had this attribute specified as false, or because the object was not specified on the save and it was in a directory that had this attribute specified as false.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isRestrictedRenameAndUnlink

        public boolean isRestrictedRenameAndUnlink()
                                            throws AS400SecurityException,
                                                   ErrorCompletingRequestException,
                                                   java.lang.InterruptedException,
                                                   java.io.IOException,
                                                   ObjectDoesNotExistException
        Returns whether renames and unlinks are restricted for objects within a directory. Objects can be linked into a directory that has this attribute set on, but cannot be renamed or unlinked from it unless one or more of the following are true for the user performing the operation:
        • The user is the owner of the object.
        • The user is the owner of the directory.
        • The user has *ALLOBJ special authority.
        This restriction only applies to directories. Other types of object can have this attribute on, however, it will be ignored. This attribute is equivalent to the S_ISVTX mode bit for an object.
        Returns:
        true if the additional restrictions for rename and unlink operations are on; false otherwise.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setRestrictedRenameAndUnlink

        public void setRestrictedRenameAndUnlink(boolean restrictedRenameAndUnlink)
                                          throws AS400SecurityException,
                                                 ErrorCompletingRequestException,
                                                 java.lang.InterruptedException,
                                                 java.io.IOException,
                                                 ObjectDoesNotExistException
        Sets whether renames and unlinks are restricted for objects within a directory. Objects can be linked into a directory that has this attribute set on, but cannot be renamed or unlinked from it unless one or more of the following are true for the user performing the operation:
        • The user is the owner of the object.
        • The user is the owner of the directory.
        • The user has *ALLOBJ special authority.
        This restriction only applies to directories. Other types of object can have this attribute on, however, it will be ignored. In addition, this attribute can only be specified for objects within the Network File System (NFS), QFileSvr.400, "root" (/), QOpenSys, or user-defined file systems. Both the NFS and QFileSvr.400 file systems support this attribute by passing it to the system and surfacing it to the caller. This attribute is also equivalent to the S_ISVTX mode bit for an object.
        Parameters:
        restrictedRenameAndUnlink - true if the additional restrictions for rename and unlink operations are on; false otherwise.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getJournalingOptions

        public int getJournalingOptions()
                                 throws AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException
        Returns the current journaling options.
        Returns:
        The current journaling options. This field is composed of several bit flags and contains one or more of the following bit values:
        • JOURNAL_SUBTREE - When this flag is returned, this object is a directory with IFS journaling subtree semantics. New objects created within this directory's subtree will inherit the journaling attributes and options from this directory.
        • JOURNAL_OPTIONAL_ENTRIES - When journaling is active, entries that are considered optional are journaled. The list of optional journal entries varies for each object type. See the Integrated file system information in the Files and file systems topic for information regarding these optional entries for various objects.
        • JOURNAL_AFTER_IMAGES - When journaling is active, the image of the object after a change is journaled.
        • JOURNAL_BEFORE_IMAGES - When journaling is active, the image of the object prior to a change is journaled.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getJournalIdentifier

        public byte[] getJournalIdentifier()
                                    throws AS400SecurityException,
                                           ErrorCompletingRequestException,
                                           java.lang.InterruptedException,
                                           java.io.IOException,
                                           ObjectDoesNotExistException
        Returns the field that associates the object being journaled with an identifier that can be used on various journaling-related commands and APIs.
        Returns:
        The field that associates the object being journaled with an identifier that can be used on various journaling-related commands and APIs.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getJournal

        public java.lang.String getJournal()
                                    throws AS400SecurityException,
                                           ErrorCompletingRequestException,
                                           java.lang.InterruptedException,
                                           java.io.IOException,
                                           ObjectDoesNotExistException
        Returns the fully qualified integrated file system path name of the current or last journal. If the value of isJournalingStatus() is true, then this field contains the name of the journal currently being used. If the value of isJournalingStatus() is false, then this field contains the name of the journal last used for this object. If this object has never been journaled, null is returned.
        Returns:
        The fully qualified integrated file system path name of the current or last journal.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getJournalingStartTime

        public java.util.Date getJournalingStartTime()
                                              throws AS400SecurityException,
                                                     ErrorCompletingRequestException,
                                                     java.lang.InterruptedException,
                                                     java.io.IOException,
                                                     ObjectDoesNotExistException
        Returns the last date and time for which the object had journaling started for it. If this object has never been journaled, null is returned.
        Returns:
        The last date and time for which the object had journaling started for it.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getStartingJournalReceiverForApply

        public java.lang.String getStartingJournalReceiverForApply()
                                                            throws AS400SecurityException,
                                                                   ErrorCompletingRequestException,
                                                                   java.lang.InterruptedException,
                                                                   java.io.IOException,
                                                                   ObjectDoesNotExistException
        Returns the fully qualified integrated file system path name of the starting journal receiver for apply. The oldest journal receiver needed to successfully Apply Journaled Changes (APYJRNCHG). When getApplyJournaledChangesRequired() is true the journal receiver contains the journal entries representing the start of the partial transaction. Otherwise; the journal receiver contains the journal entries representing the start-of-the-save operation. If no information is available, null is returned.
        Returns:
        The fully qualified integrated file system path name of the starting journal receiver for apply.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getStartingJournalReceiverAspDevice

        public java.lang.String getStartingJournalReceiverAspDevice()
                                                             throws AS400SecurityException,
                                                                    ErrorCompletingRequestException,
                                                                    java.lang.InterruptedException,
                                                                    java.io.IOException,
                                                                    ObjectDoesNotExistException
        Returns the name of the ASP for the library that contains the starting journal receiver. The special value "*SYSBAS" means the journal receiver library resides in the system or user ASP's.
        Returns:
        The name of the ASP for the library that contains the starting journal receiver.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isApplyJournaledChangesRequired

        public boolean isApplyJournaledChangesRequired()
                                                throws AS400SecurityException,
                                                       ErrorCompletingRequestException,
                                                       java.lang.InterruptedException,
                                                       java.io.IOException,
                                                       ObjectDoesNotExistException
        Returns whether the object was restored with partial transactions which would require an Apply Journaled Changes (APYJRNCHG) command to complete the transaction. A partial transaction can occur if an object was saved using save-while-active requesting that transactions with pending record changes do not have to reach a commit boundary before the object is saved.
        Returns:
        true if the object was restored with partial transactions. This object can not be used until the Apply Journaled Changes (APYJRNCHG) or Remove Journaled Changes (RMVJRNCHG) command is used to complete or rollback the partial transactions. false if the object does not have partial transactions.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isRollbackWasEnded

        public boolean isRollbackWasEnded()
                                   throws AS400SecurityException,
                                          ErrorCompletingRequestException,
                                          java.lang.InterruptedException,
                                          java.io.IOException,
                                          ObjectDoesNotExistException
        Returns whether the object had rollback ended prior to completion of a request to roll back a transaction.
        Returns:
        true if the object had a rollback operation ended using the "End Rollback" option on the Work with Commitment Definition (WRKCMTDFN) screen. It is recommended that the object be restored as it can not be used. As a last resort, the Change Journaled Object (CHGJRNOBJ) command can be used to allow the object to be used. Doing this, however, may leave the object in an inconsistent state. false if the object did not have a rollback operation ended prior to completion of a request to roll back a transaction.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getCreateObjectAuditing

        public java.lang.String getCreateObjectAuditing()
                                                 throws AS400SecurityException,
                                                        ErrorCompletingRequestException,
                                                        java.lang.InterruptedException,
                                                        java.io.IOException,
                                                        ObjectDoesNotExistException
        Returns the create object auditing value associated with the directory. This is the auditing value given to any objects created in the directory. Note: The user must have all object (*ALLOBJ) or audit (*AUDIT) special authority to retrieve the create object auditing value.
        Returns:
        The create object auditing value associated with the directory. Possible values are:
        • "*SYSVAL" - The object auditing value for the objects created in the directory is determined by the system auditing value (QCRTOBJAUD).
        • "*NONE" - No auditing occurs for this object when it is read or changed regardless of the user who is accessing the object.
        • "*USRPRF" - Audit this object only if the current user is being audited. The current user is tested to determine if auditing should be done for this object. The user profile can specify if only change access is audited or if both read and change accesses are audited for this object. The OBJAUD parameter of the Change User Auditing (CHGUSRAUD) command is used to change the auditing for a specific user.
        • "*CHANGE" - Audit all change access to this object by all users on the system.
        • "*ALL" - Audit all access to this object by all users on the system. All access is defined as a read or change operation.
        • "*NOTAVL" - The user performing the operation is not allowed to retrieve the current create object auditing value.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setCreateObjectAuditing

        public void setCreateObjectAuditing(java.lang.String createObjectAuditing)
                                     throws AS400SecurityException,
                                            ErrorCompletingRequestException,
                                            java.lang.InterruptedException,
                                            java.io.IOException,
                                            ObjectDoesNotExistException
        Sets the create object auditing value associated with the directory. This is the auditing value given to any objects created in the directory. This attribute can only be specified for directories in the "root" (/), QOpenSys, QSYS.LIB, independent ASP QSYS.LIB, QFileSvr.400 and user-defined file systems.
        Parameters:
        createObjectAuditing - The create object auditing value associated with the directory. Possible values are:
        • "*SYSVAL" - The object auditing value for the objects created in the directory is determined by the system auditing value (QCRTOBJAUD).
        • "*NONE" - No auditing occurs for this object when it is read or changed regardless of the user who is accessing the object.
        • "*USRPRF" - Audit this object only if the current user is being audited. The current user is tested to determine if auditing should be done for this object. The user profile can specify if only change access is audited or if both read and change accesses are audited for this object. The OBJAUD parameter of the Change User Auditing (CHGUSRAUD) command is used to change the auditing for a specific user.
        • "*CHANGE" - Audit all change access to this object by all users on the system.
        • "*ALL" - Audit all access to this object by all users on the system. All access is defined as a read or change operation.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • resetDate

        public void resetDate()
                       throws AS400SecurityException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException,
                              java.io.IOException,
                              ObjectDoesNotExistException
        Resets the count of the number of days an object has been used. Usage has different meanings according to the file system and according to the individual object types supported within a file system. Usage can indicate the opening or closing of a file or can refer to adding links, renaming, restoring, or checking out an object. When this attribute is set, the date use count reset for the object is set to the current date.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isSetEffectiveUserId

        public boolean isSetEffectiveUserId()
                                     throws AS400SecurityException,
                                            ErrorCompletingRequestException,
                                            java.lang.InterruptedException,
                                            java.io.IOException,
                                            ObjectDoesNotExistException
        Returns whether the effective user ID (UID) is set at execution time. This value is ignored if the specified object is a directory.
        Returns:
        true if the object owner is the effective user ID (UID) at execution time; false if the user ID (UID) is not set at execution time.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setSetEffectiveUserId

        public void setSetEffectiveUserId(boolean setEffectiveUserId)
                                   throws AS400SecurityException,
                                          ErrorCompletingRequestException,
                                          java.lang.InterruptedException,
                                          java.io.IOException,
                                          ObjectDoesNotExistException
        Sets whether the effective user ID (UID) is set at execution time. This value is ignored if the specified object is a directory.
        Parameters:
        setEffectiveUserId - true if the object owner is the effective user ID (UID) at execution time; false if the user ID (UID) is not set at execution time.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isSetEffectiveGroupId

        public boolean isSetEffectiveGroupId()
                                      throws AS400SecurityException,
                                             ErrorCompletingRequestException,
                                             java.lang.InterruptedException,
                                             java.io.IOException,
                                             ObjectDoesNotExistException
        Returns whether the effective group ID (GID) is set at execution time.
        Returns:
        true if the object is a file, the group ID (GID) is set at execution time. If the object is a directory, the group ID (GID) of objects created in the directory is set to the GID of the parent directory. false if the object is a file, the group ID (GID) is not set at execution time. If the object is a directory in the "root" (/), QOpenSys, and user-defined file systems, the group ID (GID) of objects created in the directory is set to the effective GID of the thread creating the object. This value cannot be set for other file systems.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • setSetEffectiveGroupId

        public void setSetEffectiveGroupId(boolean setEffectiveGroupId)
                                    throws AS400SecurityException,
                                           ErrorCompletingRequestException,
                                           java.lang.InterruptedException,
                                           java.io.IOException,
                                           ObjectDoesNotExistException
        Sets whether the effective group ID (GID) is set at execution time.
        Parameters:
        setEffectiveGroupId - true if the object is a file, the group ID (GID) is set at execution time. If the object is a directory, the group ID (GID) of objects created in the directory is set to the GID of the parent directory. false if the object is a file, the group ID (GID) is not set at execution time. If the object is a directory in the "root" (/), QOpenSys, and user-defined file systems, the group ID (GID) of objects created in the directory is set to the effective GID of the thread creating the object. This value cannot be set for other file systems.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • containsTemporaryObjects

        public boolean containsTemporaryObjects()
                                         throws AS400SecurityException,
                                                ErrorCompletingRequestException,
                                                java.lang.InterruptedException,
                                                java.io.IOException,
                                                ObjectDoesNotExistException
        Returns whether the objects in the user-defined file system (UDFS) are temporary system objects.

        Note: This method is not supported until the release following IBM i V6R1. For IBM i V6R1 and earlier, this method always returns false.

        Returns:
        true if the objects in the UDFS are temporary system objects; false if the objects in the UDFS are permanent system objects. If the file system represented by this object is not a UDFS, this method returns false.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • isTemporaryObject

        public boolean isTemporaryObject()
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException
        Returns whether the object is a temporary system object.

        Note: This method is not supported until the release following IBM i V6R1. For IBM i V6R1 and earlier, this method always returns false.

        Returns:
        true if the object is a temporary system object; false if the object is a permanent system object.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the object does not exist on the system.