Package org.apache.tomcat.jni
Class File
- java.lang.Object
- 
- org.apache.tomcat.jni.File
 
- 
 @Deprecated public class File extends java.lang.ObjectDeprecated.The scope of the APR/Native Library will be reduced in Tomcat 10.1.x / Tomcat Native 2.x onwards to only include those components required to provide OpenSSL integration with the NIO and NIO2 connectors.File- Author:
- Mladen Turk
 
- 
- 
Field SummaryFields Modifier and Type Field Description static intAPR_BLKDeprecated.a block devicestatic intAPR_CHRDeprecated.a character devicestatic intAPR_CURDeprecated.Currentstatic intAPR_DIRDeprecated.a directorystatic intAPR_ENDDeprecated.Go to end of filestatic intAPR_FILE_ATTR_EXECUTABLEDeprecated.File is executablestatic intAPR_FILE_ATTR_HIDDENDeprecated.File is hiddenstatic intAPR_FILE_ATTR_READONLYDeprecated.File is read-onlystatic intAPR_FINFO_ATIMEDeprecated.Creation or inode-changed timestatic intAPR_FINFO_CSIZEDeprecated.Size of the filestatic intAPR_FINFO_CTIMEDeprecated.Modification Timestatic intAPR_FINFO_DEVDeprecated.Storage size consumed by the filestatic intAPR_FINFO_DIRENTDeprecated.an atomic unix apr_stat()static intAPR_FINFO_GPROTDeprecated.User protection bitsstatic intAPR_FINFO_GROUPDeprecated.Userstatic intAPR_FINFO_ICASEDeprecated.World protection bitsstatic intAPR_FINFO_IDENTDeprecated.type, mtime, ctime, atime, sizestatic intAPR_FINFO_INODEDeprecated.Devicestatic intAPR_FINFO_LINKDeprecated.use OS's default permissionsstatic intAPR_FINFO_MINDeprecated.->name in proper casestatic intAPR_FINFO_MTIMEDeprecated.Stat the link not the file itself if it is a linkstatic intAPR_FINFO_NAMEDeprecated.if dev is case insensitivestatic intAPR_FINFO_NLINKDeprecated.Inodestatic intAPR_FINFO_NORMDeprecated.all protectionsstatic intAPR_FINFO_OWNERDeprecated.dev and inodestatic intAPR_FINFO_PROTDeprecated.user and groupstatic intAPR_FINFO_SIZEDeprecated.Access Timestatic intAPR_FINFO_TYPEDeprecated.Number of linksstatic intAPR_FINFO_UPROTDeprecated.Groupstatic intAPR_FINFO_USERDeprecated.Typestatic intAPR_FINFO_WPROTDeprecated.Group protection bitsstatic intAPR_FLOCK_EXCLUSIVEDeprecated.Exclusive lock.static intAPR_FLOCK_NONBLOCKDeprecated.do not block while acquiring the file lockstatic intAPR_FLOCK_SHAREDDeprecated.Shared lock.static intAPR_FLOCK_TYPEMASKDeprecated.mask to extract lock typestatic intAPR_FOPEN_APPENDDeprecated.Append to the end of the filestatic intAPR_FOPEN_BINARYDeprecated.Open the file in binary modestatic intAPR_FOPEN_BUFFEREDDeprecated.Open the file for buffered I/Ostatic intAPR_FOPEN_CREATEDeprecated.Create the file if not therestatic intAPR_FOPEN_DELONCLOSEDeprecated.Delete the file after closestatic intAPR_FOPEN_EXCLDeprecated.Open should fail if APR_CREATE and file exists.static intAPR_FOPEN_LARGEFILEDeprecated.Platform dependent flag to enable large file support;
 Warning : The APR_LARGEFILE flag only has effect on some platforms where sizeof(apr_off_t) == 4.static intAPR_FOPEN_NOCLEANUPDeprecated.Do not register a cleanup when the file is openedstatic intAPR_FOPEN_READDeprecated.Open the file for readingstatic intAPR_FOPEN_SENDFILE_ENABLEDDeprecated.Advisory flag that this file should support apr_socket_sendfile operationstatic intAPR_FOPEN_SHARELOCKDeprecated.Platform dependent support for higher level locked read/write access to support writes across process/machinesstatic intAPR_FOPEN_TRUNCATEDeprecated.Open the file and truncate to 0 lengthstatic intAPR_FOPEN_WRITEDeprecated.Open the file for writingstatic intAPR_FOPEN_XTHREADDeprecated.Platform dependent tag to open the file for use across multiple threadsstatic intAPR_FPROT_GEXECUTEDeprecated.Write by groupstatic intAPR_FPROT_GREADDeprecated.Set group idstatic intAPR_FPROT_GSETIDDeprecated.Execute by userstatic intAPR_FPROT_GWRITEDeprecated.Read by groupstatic intAPR_FPROT_OS_DEFAULTDeprecated.Execute by othersstatic intAPR_FPROT_UEXECUTEDeprecated.Write by userstatic intAPR_FPROT_UREADDeprecated.Set user idstatic intAPR_FPROT_USETIDDeprecated.static intAPR_FPROT_UWRITEDeprecated.Read by userstatic intAPR_FPROT_WEXECUTEDeprecated.Write by othersstatic intAPR_FPROT_WREADDeprecated.Sticky bitstatic intAPR_FPROT_WSTICKYDeprecated.Execute by groupstatic intAPR_FPROT_WWRITEDeprecated.Read by othersstatic intAPR_LNKDeprecated.a symbolic linkstatic intAPR_NOFILEDeprecated.no file type determinedstatic intAPR_PIPEDeprecated.a FIFO / pipestatic intAPR_REGDeprecated.a regular filestatic intAPR_SETDeprecated.Set the file positionstatic intAPR_SOCKDeprecated.a [unix domain] socketstatic intAPR_UNKFILEDeprecated.a file of some other unknown type
 - 
Constructor SummaryConstructors Constructor Description File()Deprecated.
 - 
Method SummaryAll Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static intappend(java.lang.String fromPath, java.lang.String toPath, int perms, long pool)Deprecated.Append the specified file to another file.static intattrsSet(java.lang.String fname, int attributes, int mask, long pool)Deprecated.Set attributes of the specified file.static intclose(long file)Deprecated.Close the specified file.static intcopy(java.lang.String fromPath, java.lang.String toPath, int perms, long pool)Deprecated.Copy the specified file to another file.static longdup(long newFile, long oldFile, long pool)Deprecated.Duplicate the specified file descriptor.static intdup2(long newFile, long oldFile, long pool)Deprecated.Duplicate the specified file descriptor and close the original.static inteof(long fptr)Deprecated.Are we at the end of the filestatic intflagsGet(long file)Deprecated.Retrieve the flags that were passed into apr_file_open() when the file was opened.static intflush(long thefile)Deprecated.Flush the file's buffer.static intgetc(long thefile)Deprecated.Read a character from the specified file.static FileInfogetInfo(int wanted, long thefile)Deprecated.Get the specified file's stats.static intgets(byte[] buf, int offset, long thefile)Deprecated.Read a string from the specified file.static FileInfogetStat(java.lang.String fname, int wanted, long pool)Deprecated.Get the specified file's stats.static intinfoGet(FileInfo finfo, int wanted, long thefile)Deprecated.Get the specified file's stats.static intlock(long thefile, int type)Deprecated.Establish a lock on the specified, open file.static longmktemp(java.lang.String templ, int flags, long pool)Deprecated.Open a temporary filestatic intmtimeSet(java.lang.String fname, long mtime, long pool)Deprecated.Set the mtime of the specified file.static java.lang.StringnameGet(long thefile)Deprecated.Return the file name of the current file.static longopen(java.lang.String fname, int flag, int perm, long pool)Deprecated.Open the specified file.static intpermsSet(java.lang.String fname, int perms)Deprecated.Set the specified file's permission bits.static intpipeCreate(long[] io, long pool)Deprecated.Create an anonymous pipe.static longpipeTimeoutGet(long thepipe)Deprecated.Get the timeout value for a pipe or manipulate the blocking state.static intpipeTimeoutSet(long thepipe, long timeout)Deprecated.Set the timeout value for a pipe or manipulate the blocking state.static intputc(byte ch, long thefile)Deprecated.Write a character into the specified file.static intputs(byte[] str, long thefile)Deprecated.Write the string into the specified file.static intread(long thefile, byte[] buf, int offset, int nbytes)Deprecated.Read data from the specified file.static intreadb(long thefile, java.nio.ByteBuffer buf, int offset, int nbytes)Deprecated.Read data from the specified file.static intreadFull(long thefile, byte[] buf, int offset, int nbytes)Deprecated.Read data from the specified file, ensuring that the buffer is filled before returning.static intreadFullb(long thefile, java.nio.ByteBuffer buf, int offset, int nbytes)Deprecated.Read data from the specified file, ensuring that the buffer is filled before returning.static intremove(java.lang.String path, long pool)Deprecated.Delete the specified file.static intrename(java.lang.String fromPath, java.lang.String toPath, long pool)Deprecated.Rename the specified file.static longseek(long thefile, int where, long offset)Deprecated.Move the read/write file offset to a specified byte within a file.static intstat(FileInfo finfo, java.lang.String fname, int wanted, long pool)Deprecated.Get the specified file's stats.static inttrunc(long fp, long offset)Deprecated.Truncate the file's length to the specified offsetstatic intungetc(byte ch, long thefile)Deprecated.Put a character back onto a specified stream.static intunlock(long thefile)Deprecated.Remove any outstanding locks on the file.static intwrite(long thefile, byte[] buf, int offset, int nbytes)Deprecated.Write data to the specified file.static intwriteb(long thefile, java.nio.ByteBuffer buf, int offset, int nbytes)Deprecated.Write data to the specified file.static intwriteFull(long thefile, byte[] buf, int offset, int nbytes)Deprecated.Write data to the specified file, ensuring that all of the data is written before returning.static intwriteFullb(long thefile, java.nio.ByteBuffer buf, int offset, int nbytes)Deprecated.Write data to the specified file, ensuring that all of the data is written before returning.static intwritev(long thefile, byte[][] vec)Deprecated.Write data from array of byte arrays to the specified file.static intwritevFull(long thefile, byte[][] vec)Deprecated.Write data from array of byte arrays to the specified file, ensuring that all of the data is written before returning.
 
- 
- 
- 
Field Detail- 
APR_FOPEN_READpublic static final int APR_FOPEN_READ Deprecated.Open the file for reading- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_WRITEpublic static final int APR_FOPEN_WRITE Deprecated.Open the file for writing- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_CREATEpublic static final int APR_FOPEN_CREATE Deprecated.Create the file if not there- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_APPENDpublic static final int APR_FOPEN_APPEND Deprecated.Append to the end of the file- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_TRUNCATEpublic static final int APR_FOPEN_TRUNCATE Deprecated.Open the file and truncate to 0 length- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_BINARYpublic static final int APR_FOPEN_BINARY Deprecated.Open the file in binary mode- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_EXCLpublic static final int APR_FOPEN_EXCL Deprecated.Open should fail if APR_CREATE and file exists.- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_BUFFEREDpublic static final int APR_FOPEN_BUFFERED Deprecated.Open the file for buffered I/O- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_DELONCLOSEpublic static final int APR_FOPEN_DELONCLOSE Deprecated.Delete the file after close- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_XTHREADpublic static final int APR_FOPEN_XTHREAD Deprecated.Platform dependent tag to open the file for use across multiple threads- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_SHARELOCKpublic static final int APR_FOPEN_SHARELOCK Deprecated.Platform dependent support for higher level locked read/write access to support writes across process/machines- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_NOCLEANUPpublic static final int APR_FOPEN_NOCLEANUP Deprecated.Do not register a cleanup when the file is opened- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_SENDFILE_ENABLEDpublic static final int APR_FOPEN_SENDFILE_ENABLED Deprecated.Advisory flag that this file should support apr_socket_sendfile operation- See Also:
- Constant Field Values
 
 - 
APR_FOPEN_LARGEFILEpublic static final int APR_FOPEN_LARGEFILE Deprecated.Platform dependent flag to enable large file support;
 Warning : The APR_LARGEFILE flag only has effect on some platforms where sizeof(apr_off_t) == 4. Where implemented, it allows opening and writing to a file which exceeds the size which can be represented by apr_off_t (2 gigabytes). When a file's size does exceed 2Gb, apr_file_info_get() will fail with an error on the descriptor, likewise apr_stat()/apr_lstat() will fail on the filename. apr_dir_read() will fail with APR_INCOMPLETE on a directory entry for a large file depending on the particular APR_FINFO_* flags. Generally, it is not recommended to use this flag.- See Also:
- Constant Field Values
 
 - 
APR_SETpublic static final int APR_SET Deprecated.Set the file position- See Also:
- Constant Field Values
 
 - 
APR_CURpublic static final int APR_CUR Deprecated.Current- See Also:
- Constant Field Values
 
 - 
APR_ENDpublic static final int APR_END Deprecated.Go to end of file- See Also:
- Constant Field Values
 
 - 
APR_FILE_ATTR_READONLYpublic static final int APR_FILE_ATTR_READONLY Deprecated.File is read-only- See Also:
- Constant Field Values
 
 - 
APR_FILE_ATTR_EXECUTABLEpublic static final int APR_FILE_ATTR_EXECUTABLE Deprecated.File is executable- See Also:
- Constant Field Values
 
 - 
APR_FILE_ATTR_HIDDENpublic static final int APR_FILE_ATTR_HIDDEN Deprecated.File is hidden- See Also:
- Constant Field Values
 
 - 
APR_FLOCK_SHAREDpublic static final int APR_FLOCK_SHARED Deprecated.Shared lock. More than one process or thread can hold a shared lock at any given time. Essentially, this is a "read lock", preventing writers from establishing an exclusive lock.- See Also:
- Constant Field Values
 
 - 
APR_FLOCK_EXCLUSIVEpublic static final int APR_FLOCK_EXCLUSIVE Deprecated.Exclusive lock. Only one process may hold an exclusive lock at any given time. This is analogous to a "write lock".- See Also:
- Constant Field Values
 
 - 
APR_FLOCK_TYPEMASKpublic static final int APR_FLOCK_TYPEMASK Deprecated.mask to extract lock type- See Also:
- Constant Field Values
 
 - 
APR_FLOCK_NONBLOCKpublic static final int APR_FLOCK_NONBLOCK Deprecated.do not block while acquiring the file lock- See Also:
- Constant Field Values
 
 - 
APR_NOFILEpublic static final int APR_NOFILE Deprecated.no file type determined- See Also:
- Constant Field Values
 
 - 
APR_REGpublic static final int APR_REG Deprecated.a regular file- See Also:
- Constant Field Values
 
 - 
APR_DIRpublic static final int APR_DIR Deprecated.a directory- See Also:
- Constant Field Values
 
 - 
APR_CHRpublic static final int APR_CHR Deprecated.a character device- See Also:
- Constant Field Values
 
 - 
APR_BLKpublic static final int APR_BLK Deprecated.a block device- See Also:
- Constant Field Values
 
 - 
APR_PIPEpublic static final int APR_PIPE Deprecated.a FIFO / pipe- See Also:
- Constant Field Values
 
 - 
APR_LNKpublic static final int APR_LNK Deprecated.a symbolic link- See Also:
- Constant Field Values
 
 - 
APR_SOCKpublic static final int APR_SOCK Deprecated.a [unix domain] socket- See Also:
- Constant Field Values
 
 - 
APR_UNKFILEpublic static final int APR_UNKFILE Deprecated.a file of some other unknown type- See Also:
- Constant Field Values
 
 - 
APR_FPROT_USETIDpublic static final int APR_FPROT_USETID Deprecated.- See Also:
- Constant Field Values
 
 - 
APR_FPROT_UREADpublic static final int APR_FPROT_UREAD Deprecated.Set user id- See Also:
- Constant Field Values
 
 - 
APR_FPROT_UWRITEpublic static final int APR_FPROT_UWRITE Deprecated.Read by user- See Also:
- Constant Field Values
 
 - 
APR_FPROT_UEXECUTEpublic static final int APR_FPROT_UEXECUTE Deprecated.Write by user- See Also:
- Constant Field Values
 
 - 
APR_FPROT_GSETIDpublic static final int APR_FPROT_GSETID Deprecated.Execute by user- See Also:
- Constant Field Values
 
 - 
APR_FPROT_GREADpublic static final int APR_FPROT_GREAD Deprecated.Set group id- See Also:
- Constant Field Values
 
 - 
APR_FPROT_GWRITEpublic static final int APR_FPROT_GWRITE Deprecated.Read by group- See Also:
- Constant Field Values
 
 - 
APR_FPROT_GEXECUTEpublic static final int APR_FPROT_GEXECUTE Deprecated.Write by group- See Also:
- Constant Field Values
 
 - 
APR_FPROT_WSTICKYpublic static final int APR_FPROT_WSTICKY Deprecated.Execute by group- See Also:
- Constant Field Values
 
 - 
APR_FPROT_WREADpublic static final int APR_FPROT_WREAD Deprecated.Sticky bit- See Also:
- Constant Field Values
 
 - 
APR_FPROT_WWRITEpublic static final int APR_FPROT_WWRITE Deprecated.Read by others- See Also:
- Constant Field Values
 
 - 
APR_FPROT_WEXECUTEpublic static final int APR_FPROT_WEXECUTE Deprecated.Write by others- See Also:
- Constant Field Values
 
 - 
APR_FPROT_OS_DEFAULTpublic static final int APR_FPROT_OS_DEFAULT Deprecated.Execute by others- See Also:
- Constant Field Values
 
 - 
APR_FINFO_LINKpublic static final int APR_FINFO_LINK Deprecated.use OS's default permissions- See Also:
- Constant Field Values
 
 - 
APR_FINFO_MTIMEpublic static final int APR_FINFO_MTIME Deprecated.Stat the link not the file itself if it is a link- See Also:
- Constant Field Values
 
 - 
APR_FINFO_CTIMEpublic static final int APR_FINFO_CTIME Deprecated.Modification Time- See Also:
- Constant Field Values
 
 - 
APR_FINFO_ATIMEpublic static final int APR_FINFO_ATIME Deprecated.Creation or inode-changed time- See Also:
- Constant Field Values
 
 - 
APR_FINFO_SIZEpublic static final int APR_FINFO_SIZE Deprecated.Access Time- See Also:
- Constant Field Values
 
 - 
APR_FINFO_CSIZEpublic static final int APR_FINFO_CSIZE Deprecated.Size of the file- See Also:
- Constant Field Values
 
 - 
APR_FINFO_DEVpublic static final int APR_FINFO_DEV Deprecated.Storage size consumed by the file- See Also:
- Constant Field Values
 
 - 
APR_FINFO_INODEpublic static final int APR_FINFO_INODE Deprecated.Device- See Also:
- Constant Field Values
 
 - 
APR_FINFO_NLINKpublic static final int APR_FINFO_NLINK Deprecated.Inode- See Also:
- Constant Field Values
 
 - 
APR_FINFO_TYPEpublic static final int APR_FINFO_TYPE Deprecated.Number of links- See Also:
- Constant Field Values
 
 - 
APR_FINFO_USERpublic static final int APR_FINFO_USER Deprecated.Type- See Also:
- Constant Field Values
 
 - 
APR_FINFO_GROUPpublic static final int APR_FINFO_GROUP Deprecated.User- See Also:
- Constant Field Values
 
 - 
APR_FINFO_UPROTpublic static final int APR_FINFO_UPROT Deprecated.Group- See Also:
- Constant Field Values
 
 - 
APR_FINFO_GPROTpublic static final int APR_FINFO_GPROT Deprecated.User protection bits- See Also:
- Constant Field Values
 
 - 
APR_FINFO_WPROTpublic static final int APR_FINFO_WPROT Deprecated.Group protection bits- See Also:
- Constant Field Values
 
 - 
APR_FINFO_ICASEpublic static final int APR_FINFO_ICASE Deprecated.World protection bits- See Also:
- Constant Field Values
 
 - 
APR_FINFO_NAMEpublic static final int APR_FINFO_NAME Deprecated.if dev is case insensitive- See Also:
- Constant Field Values
 
 - 
APR_FINFO_MINpublic static final int APR_FINFO_MIN Deprecated.->name in proper case- See Also:
- Constant Field Values
 
 - 
APR_FINFO_IDENTpublic static final int APR_FINFO_IDENT Deprecated.type, mtime, ctime, atime, size- See Also:
- Constant Field Values
 
 - 
APR_FINFO_OWNERpublic static final int APR_FINFO_OWNER Deprecated.dev and inode- See Also:
- Constant Field Values
 
 - 
APR_FINFO_PROTpublic static final int APR_FINFO_PROT Deprecated.user and group- See Also:
- Constant Field Values
 
 - 
APR_FINFO_NORMpublic static final int APR_FINFO_NORM Deprecated.all protections- See Also:
- Constant Field Values
 
 - 
APR_FINFO_DIRENTpublic static final int APR_FINFO_DIRENT Deprecated.an atomic unix apr_stat()- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
openpublic static long open(java.lang.String fname, int flag, int perm, long pool) throws ErrorDeprecated.Open the specified file.- Parameters:
- fname- The full path to the file (using / on all systems)
- flag- Or'ed value of:- APR_FOPEN_READ open for reading APR_FOPEN_WRITE open for writing APR_FOPEN_CREATE create the file if not there APR_FOPEN_APPEND file ptr is set to end prior to all writes APR_FOPEN_TRUNCATE set length to zero if file exists APR_FOPEN_BINARY not a text file (This flag is ignored on UNIX because it has no meaning) APR_FOPEN_BUFFERED buffer the data. Default is non-buffered APR_FOPEN_EXCL return error if APR_CREATE and file exists APR_FOPEN_DELONCLOSE delete the file after closing. APR_FOPEN_XTHREAD Platform dependent tag to open the file for use across multiple threads APR_FOPEN_SHARELOCK Platform dependent support for higher level locked read/write access to support writes across process/machines APR_FOPEN_NOCLEANUP Do not register a cleanup with the pool passed in on the pool argument (see below). The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed. APR_FOPEN_SENDFILE_ENABLED Open with appropriate platform semantics for sendfile operations. Advisory only, apr_socket_sendfile does not check this flag.
- perm- Access permissions for file.
- pool- The pool to use. If perm is APR_OS_DEFAULT and the file is being created, appropriate default permissions will be used.
- Returns:
- The opened file descriptor.
- Throws:
- Error- An error occurred
 
 - 
closepublic static int close(long file) Deprecated.Close the specified file.- Parameters:
- file- The file descriptor to close.
- Returns:
- the operation status
 
 - 
flushpublic static int flush(long thefile) Deprecated.Flush the file's buffer.- Parameters:
- thefile- The file descriptor to flush
- Returns:
- the operation status
 
 - 
mktemppublic static long mktemp(java.lang.String templ, int flags, long pool) throws ErrorDeprecated.Open a temporary file- Parameters:
- templ- The template to use when creating a temp file.
- flags- The flags to open the file with. If this is zero, the file is opened with APR_CREATE | APR_READ | APR_WRITE | APR_EXCL | APR_DELONCLOSE
- pool- The pool to allocate the file out of.
- Returns:
- The apr file to use as a temporary file. This function generates a unique temporary file name from template. The last six characters of template must be XXXXXX and these are replaced with a string that makes the filename unique. Since it will be modified, template must not be a string constant, but should be declared as a character array.
- Throws:
- Error- An error occurred
 
 - 
removepublic static int remove(java.lang.String path, long pool)Deprecated.Delete the specified file.- Parameters:
- path- The full path to the file (using / on all systems)
- pool- The pool to use. If the file is open, it won't be removed until all instances are closed.
- Returns:
- the operation status
 
 - 
renamepublic static int rename(java.lang.String fromPath, java.lang.String toPath, long pool)Deprecated.Rename the specified file.
 Warning : If a file exists at the new location, then it will be overwritten. Moving files or directories across devices may not be possible.- Parameters:
- fromPath- The full path to the original file (using / on all systems)
- toPath- The full path to the new file (using / on all systems)
- pool- The pool to use.
- Returns:
- the operation status
 
 - 
copypublic static int copy(java.lang.String fromPath, java.lang.String toPath, int perms, long pool)Deprecated.Copy the specified file to another file. The new file does not need to exist, it will be created if required.
 Warning : If the new file already exists, its contents will be overwritten.- Parameters:
- fromPath- The full path to the original file (using / on all systems)
- toPath- The full path to the new file (using / on all systems)
- perms- Access permissions for the new file if it is created. In place of the usual or'd combination of file permissions, the value APR_FILE_SOURCE_PERMS may be given, in which case the source file's permissions are copied.
- pool- The pool to use.
- Returns:
- the operation status
 
 - 
appendpublic static int append(java.lang.String fromPath, java.lang.String toPath, int perms, long pool)Deprecated.Append the specified file to another file. The new file does not need to exist, it will be created if required.- Parameters:
- fromPath- The full path to the source file (use / on all systems)
- toPath- The full path to the destination file (use / on all systems)
- perms- Access permissions for the destination file if it is created. In place of the usual or'd combination of file permissions, the value APR_FILE_SOURCE_PERMS may be given, in which case the source file's permissions are copied.
- pool- The pool to use.
- Returns:
- the operation status
 
 - 
putspublic static int puts(byte[] str, long thefile)Deprecated.Write the string into the specified file.- Parameters:
- str- The string to write. Must be NUL terminated!
- thefile- The file descriptor to write to
- Returns:
- the operation status
 
 - 
seekpublic static long seek(long thefile, int where, long offset) throws ErrorDeprecated.Move the read/write file offset to a specified byte within a file.- Parameters:
- thefile- The file descriptor
- where- How to move the pointer, one of:- APR_SET -- set the offset to offset APR_CUR -- add the offset to the current position APR_END -- add the offset to the current file size 
- offset- The offset to move the pointer to.
- Returns:
- Offset the pointer was actually moved to.
- Throws:
- Error- If an error occurs reading the file
 
 - 
putcpublic static int putc(byte ch, long thefile)Deprecated.Write a character into the specified file.- Parameters:
- ch- The character to write.
- thefile- The file descriptor to write to
- Returns:
- the operation status
 
 - 
ungetcpublic static int ungetc(byte ch, long thefile)Deprecated.Put a character back onto a specified stream.- Parameters:
- ch- The character to write.
- thefile- The file descriptor to write to
- Returns:
- the operation status
 
 - 
writepublic static int write(long thefile, byte[] buf, int offset, int nbytes)Deprecated.Write data to the specified file. Write will write up to the specified number of bytes, but never more. If the OS cannot write that many bytes, it will write as many as it can. The third argument is modified to reflect the * number of bytes written. It is possible for both bytes to be written and an error to be returned. APR_EINTR is never returned.- Parameters:
- thefile- The file descriptor to write to.
- buf- The buffer which contains the data.
- offset- Start offset in buf
- nbytes- The number of bytes to write
- Returns:
- The number of bytes written.
 
 - 
writebpublic static int writeb(long thefile, java.nio.ByteBuffer buf, int offset, int nbytes)Deprecated.Write data to the specified file. Write will write up to the specified number of bytes, but never more. If the OS cannot write that many bytes, it will write as many as it can. The third argument is modified to reflect the * number of bytes written. It is possible for both bytes to be written and an error to be returned. APR_EINTR is never returned.- Parameters:
- thefile- The file descriptor to write to.
- buf- The direct Byte buffer which contains the data.
- offset- Start offset in buf
- nbytes- The number of bytes to write
- Returns:
- The number of bytes written.
 
 - 
writeFullpublic static int writeFull(long thefile, byte[] buf, int offset, int nbytes)Deprecated.Write data to the specified file, ensuring that all of the data is written before returning. Write will write up to the specified number of bytes, but never more. If the OS cannot write that many bytes, the process/thread will block until they can be written. Exceptional error such as "out of space" or "pipe closed" will terminate with an error. It is possible for both bytes to be written and an error to be returned. And if *bytes_written is less than nbytes, an accompanying error is _always_ returned. APR_EINTR is never returned.- Parameters:
- thefile- The file descriptor to write to.
- buf- The buffer which contains the data.
- offset- Start offset in buf
- nbytes- The number of bytes to write
- Returns:
- The number of bytes written.
 
 - 
writeFullbpublic static int writeFullb(long thefile, java.nio.ByteBuffer buf, int offset, int nbytes)Deprecated.Write data to the specified file, ensuring that all of the data is written before returning. Write will write up to the specified number of bytes, but never more. If the OS cannot write that many bytes, the process/thread will block until they can be written. Exceptional error such as "out of space" or "pipe closed" will terminate with an error. It is possible for both bytes to be written and an error to be returned. And if *bytes_written is less than nbytes, an accompanying error is _always_ returned. APR_EINTR is never returned.- Parameters:
- thefile- The file descriptor to write to.
- buf- The direct ByteBuffer which contains the data.
- offset- Start offset in buf
- nbytes- The number of bytes to write.
- Returns:
- The number of bytes written.
 
 - 
writevpublic static int writev(long thefile, byte[][] vec)Deprecated.Write data from array of byte arrays to the specified file. It is possible for both bytes to be written and an error to be returned. APR_EINTR is never returned. apr_file_writev is available even if the underlying operating system doesn't provide writev().- Parameters:
- thefile- The file descriptor to write to.
- vec- The array from which to get the data to write to the file.
- Returns:
- The number of bytes written.
 
 - 
writevFullpublic static int writevFull(long thefile, byte[][] vec)Deprecated.Write data from array of byte arrays to the specified file, ensuring that all of the data is written before returning. writevFull is available even if the underlying operating system doesn't provide writev().- Parameters:
- thefile- The file descriptor to write to.
- vec- The array from which to get the data to write to the file.
- Returns:
- The number of bytes written.
 
 - 
readpublic static int read(long thefile, byte[] buf, int offset, int nbytes)Deprecated.Read data from the specified file. apr_file_read will read up to the specified number of bytes, but never more. If there isn't enough data to fill that number of bytes, all of the available data is read. The third argument is modified to reflect the number of bytes read. If a char was put back into the stream via ungetc, it will be the first character returned. It is not possible for both bytes to be read and an APR_EOF or other error to be returned. APR_EINTR is never returned.- Parameters:
- thefile- The file descriptor to read from.
- buf- The buffer to store the data to.
- offset- Start offset in buf
- nbytes- The number of bytes to read
- Returns:
- the number of bytes read.
 
 - 
readbpublic static int readb(long thefile, java.nio.ByteBuffer buf, int offset, int nbytes)Deprecated.Read data from the specified file. apr_file_read will read up to the specified number of bytes, but never more. If there isn't enough data to fill that number of bytes, all of the available data is read. The third argument is modified to reflect the number of bytes read. If a char was put back into the stream via ungetc, it will be the first character returned. It is not possible for both bytes to be read and an APR_EOF or other error to be returned. APR_EINTR is never returned.- Parameters:
- thefile- The file descriptor to read from.
- buf- The direct Byte buffer to store the data to.
- offset- Start offset in buf
- nbytes- The number of bytes to read.
- Returns:
- the number of bytes read.
 
 - 
readFullpublic static int readFull(long thefile, byte[] buf, int offset, int nbytes)Deprecated.Read data from the specified file, ensuring that the buffer is filled before returning. Read will read up to the specified number of bytes, but never more. If there isn't enough data to fill that number of bytes, then the process/thread will block until it is available or EOF is reached. If a char was put back into the stream via ungetc, it will be the first character returned. It is possible for both bytes to be read and an error to be returned. And if *bytes_read is less than nbytes, an accompanying error is _always_ returned. APR_EINTR is never returned.- Parameters:
- thefile- The file descriptor to read from.
- buf- The buffer to store the data to.
- offset- Start offset in buf
- nbytes- The number of bytes to read
- Returns:
- the number of bytes read.
 
 - 
readFullbpublic static int readFullb(long thefile, java.nio.ByteBuffer buf, int offset, int nbytes)Deprecated.Read data from the specified file, ensuring that the buffer is filled before returning. Read will read up to the specified number of bytes, but never more. If there isn't enough data to fill that number of bytes, then the process/thread will block until it is available or EOF is reached. If a char was put back into the stream via ungetc, it will be the first character returned. It is possible for both bytes to be read and an error to be returned. And if *bytes_read is less than nbytes, an accompanying error is _always_ returned. APR_EINTR is never returned.- Parameters:
- thefile- The file descriptor to read from.
- buf- The direct ByteBuffer to store the data to.
- offset- Start offset in buf
- nbytes- The number of bytes to read.
- Returns:
- the number of bytes read.
 
 - 
getspublic static int gets(byte[] buf, int offset, long thefile)Deprecated.Read a string from the specified file. The buffer will be NUL-terminated if any characters are stored.- Parameters:
- buf- The buffer to store the string in.
- offset- Start offset in buf
- thefile- The file descriptor to read from
- Returns:
- the number of bytes read.
 
 - 
getcpublic static int getc(long thefile) throws ErrorDeprecated.Read a character from the specified file.- Parameters:
- thefile- The file descriptor to read from
- Returns:
- The read character
- Throws:
- Error- If an error occurs reading the file
 
 - 
eofpublic static int eof(long fptr) Deprecated.Are we at the end of the file- Parameters:
- fptr- The apr file we are testing.
- Returns:
- Returns APR_EOF if we are at the end of file, APR_SUCCESS otherwise.
 
 - 
nameGetpublic static java.lang.String nameGet(long thefile) Deprecated.Return the file name of the current file.- Parameters:
- thefile- The currently open file.
- Returns:
- the name
 
 - 
permsSetpublic static int permsSet(java.lang.String fname, int perms)Deprecated.Set the specified file's permission bits.
 Warning : Some platforms may not be able to apply all of the available permission bits; APR_INCOMPLETE will be returned if some permissions are specified which could not be set.
 Warning : Platforms which do not implement this feature will return APR_ENOTIMPL.- Parameters:
- fname- The file (name) to apply the permissions to.
- perms- The permission bits to apply to the file.
- Returns:
- the operation status
 
 - 
attrsSetpublic static int attrsSet(java.lang.String fname, int attributes, int mask, long pool)Deprecated.Set attributes of the specified file. This function should be used in preference to explicit manipulation of the file permissions, because the operations to provide these attributes are platform specific and may involve more than simply setting permission bits.
 Warning : Platforms which do not implement this feature will return APR_ENOTIMPL.- Parameters:
- fname- The full path to the file (using / on all systems)
- attributes- Or'd combination of- APR_FILE_ATTR_READONLY - make the file readonly APR_FILE_ATTR_EXECUTABLE - make the file executable APR_FILE_ATTR_HIDDEN - make the file hidden
- mask- Mask of valid bits in attributes.
- pool- the pool to use.
- Returns:
- the operation status
 
 - 
mtimeSetpublic static int mtimeSet(java.lang.String fname, long mtime, long pool)Deprecated.Set the mtime of the specified file.
 Warning : Platforms which do not implement this feature will return APR_ENOTIMPL.- Parameters:
- fname- The full path to the file (using / on all systems)
- mtime- The mtime to apply to the file in microseconds
- pool- The pool to use.
- Returns:
- the operation status
 
 - 
lockpublic static int lock(long thefile, int type)Deprecated.Establish a lock on the specified, open file. The lock may be advisory or mandatory, at the discretion of the platform. The lock applies to the file as a whole, rather than a specific range. Locks are established on a per-thread/process basis; a second lock by the same thread will not block.- Parameters:
- thefile- The file to lock.
- type- The type of lock to establish on the file.
- Returns:
- the operation status
 
 - 
unlockpublic static int unlock(long thefile) Deprecated.Remove any outstanding locks on the file.- Parameters:
- thefile- The file to unlock.
- Returns:
- the operation status
 
 - 
flagsGetpublic static int flagsGet(long file) Deprecated.Retrieve the flags that were passed into apr_file_open() when the file was opened.- Parameters:
- file- The file to retrieve flags.
- Returns:
- the flags
 
 - 
truncpublic static int trunc(long fp, long offset)Deprecated.Truncate the file's length to the specified offset- Parameters:
- fp- The file to truncate
- offset- The offset to truncate to.
- Returns:
- the operation status
 
 - 
pipeCreatepublic static int pipeCreate(long[] io, long pool)Deprecated.Create an anonymous pipe.- Parameters:
- io- io[0] The file descriptors to use as input to the pipe. io[1] The file descriptor to use as output from the pipe.
- pool- The pool to operate on.
- Returns:
- the operation status
 
 - 
pipeTimeoutGetpublic static long pipeTimeoutGet(long thepipe) throws ErrorDeprecated.Get the timeout value for a pipe or manipulate the blocking state.- Parameters:
- thepipe- The pipe we are getting a timeout for.
- Returns:
- The current timeout value in microseconds.
- Throws:
- Error- If an error occurs
 
 - 
pipeTimeoutSetpublic static int pipeTimeoutSet(long thepipe, long timeout)Deprecated.Set the timeout value for a pipe or manipulate the blocking state.- Parameters:
- thepipe- The pipe we are setting a timeout on.
- timeout- The timeout value in microseconds. Values < 0 mean wait forever, 0 means do not wait at all.
- Returns:
- the operation status
 
 - 
duppublic static long dup(long newFile, long oldFile, long pool) throws ErrorDeprecated.Duplicate the specified file descriptor.- Parameters:
- newFile- The file to duplicate. newFile must point to a valid apr_file_t, or point to NULL.
- oldFile- The file to duplicate.
- pool- The pool to use for the new file.
- Returns:
- Duplicated file structure.
- Throws:
- Error- If an error occurs reading the file descriptor
 
 - 
dup2public static int dup2(long newFile, long oldFile, long pool)Deprecated.Duplicate the specified file descriptor and close the original.- Parameters:
- newFile- The old file that is to be closed and reused. newFile MUST point at a valid apr_file_t. It cannot be NULL.
- oldFile- The file to duplicate.
- pool- The pool to use for the new file.
- Returns:
- the operation status
 
 - 
statpublic static int stat(FileInfo finfo, java.lang.String fname, int wanted, long pool) Deprecated.Get the specified file's stats. The file is specified by filename, instead of using a pre-opened file.- Parameters:
- finfo- Where to store the information about the file, which is never touched if the call fails.
- fname- The name of the file to stat.
- wanted- The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values
- pool- the pool to use to allocate the new file.
- Returns:
- the operation status
 
 - 
getStatpublic static FileInfo getStat(java.lang.String fname, int wanted, long pool) Deprecated.Get the specified file's stats. The file is specified by filename, instead of using a pre-opened file.- Parameters:
- fname- The name of the file to stat.
- wanted- The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values
- pool- the pool to use to allocate the new file.
- Returns:
- FileInfo object.
 
 - 
infoGetpublic static int infoGet(FileInfo finfo, int wanted, long thefile) Deprecated.Get the specified file's stats.- Parameters:
- finfo- Where to store the information about the file.
- wanted- The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values
- thefile- The file to get information about.
- Returns:
- the operation status
 
 - 
getInfopublic static FileInfo getInfo(int wanted, long thefile) Deprecated.Get the specified file's stats.- Parameters:
- wanted- The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values
- thefile- The file to get information about.
- Returns:
- FileInfo object.
 
 
- 
 
-