File	Doc	Category	Size	Date	Package
File.java	API Doc	Apache Tomcat 6.0.14	31861	Fri Jul 20 04:20:34 BST 2007	org.apache.tomcat.jni

File

• java.lang.Object

Fields Summary
public static final int	APR_FOPEN_READ Open the file for reading
public static final int	APR_FOPEN_WRITE Open the file for writing
public static final int	APR_FOPEN_CREATE Create the file if not there
public static final int	APR_FOPEN_APPEND Append to the end of the file
public static final int	APR_FOPEN_TRUNCATE Open the file and truncate to 0 length
public static final int	APR_FOPEN_BINARY Open the file in binary mode
public static final int	APR_FOPEN_EXCL Open should fail if APR_CREATE and file exists.
public static final int	APR_FOPEN_BUFFERED Open the file for buffered I/O
public static final int	APR_FOPEN_DELONCLOSE Delete the file after close
public static final int	APR_FOPEN_XTHREAD Platform dependent tag to open the file for use across multiple threads
public static final int	APR_FOPEN_SHARELOCK Platform dependent support for higher level locked read/write access to support writes across process/machines
public static final int	APR_FOPEN_NOCLEANUP Do not register a cleanup when the file is opened
public static final int	APR_FOPEN_SENDFILE_ENABLED Advisory flag that this file should support apr_socket_sendfile operation
public static final int	APR_FOPEN_LARGEFILE 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.
public static final int	APR_SET Set the file position
public static final int	APR_CUR Current
public static final int	APR_END Go to end of file
public static final int	APR_FILE_ATTR_READONLY File is read-only
public static final int	APR_FILE_ATTR_EXECUTABLE File is executable
public static final int	APR_FILE_ATTR_HIDDEN File is hidden
public static final int	APR_FLOCK_SHARED 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.
public static final int	APR_FLOCK_EXCLUSIVE Exclusive lock. Only one process may hold an exclusive lock at any given time. This is analogous to a "write lock".
public static final int	APR_FLOCK_TYPEMASK mask to extract lock type
public static final int	APR_FLOCK_NONBLOCK do not block while acquiring the file lock
public static final int	APR_NOFILE no file type determined
public static final int	APR_REG a regular file
public static final int	APR_DIR a directory
public static final int	APR_CHR a character device
public static final int	APR_BLK a block device
public static final int	APR_PIPE a FIFO / pipe
public static final int	APR_LNK a symbolic link
public static final int	APR_SOCK a [unix domain] socket
public static final int	APR_UNKFILE a file of some other unknown type
public static final int	APR_FPROT_USETID
public static final int	APR_FPROT_UREAD Set user id
public static final int	APR_FPROT_UWRITE Read by user
public static final int	APR_FPROT_UEXECUTE Write by user
public static final int	APR_FPROT_GSETID Execute by user
public static final int	APR_FPROT_GREAD Set group id
public static final int	APR_FPROT_GWRITE Read by group
public static final int	APR_FPROT_GEXECUTE Write by group
public static final int	APR_FPROT_WSTICKY Execute by group
public static final int	APR_FPROT_WREAD Sticky bit
public static final int	APR_FPROT_WWRITE Read by others
public static final int	APR_FPROT_WEXECUTE Write by others
public static final int	APR_FPROT_OS_DEFAULT Execute by others
public static final int	APR_FINFO_LINK use OS's default permissions
public static final int	APR_FINFO_MTIME Stat the link not the file itself if it is a link
public static final int	APR_FINFO_CTIME Modification Time
public static final int	APR_FINFO_ATIME Creation or inode-changed time
public static final int	APR_FINFO_SIZE Access Time
public static final int	APR_FINFO_CSIZE Size of the file
public static final int	APR_FINFO_DEV Storage size consumed by the file
public static final int	APR_FINFO_INODE Device
public static final int	APR_FINFO_NLINK Inode
public static final int	APR_FINFO_TYPE Number of links
public static final int	APR_FINFO_USER Type
public static final int	APR_FINFO_GROUP User
public static final int	APR_FINFO_UPROT Group
public static final int	APR_FINFO_GPROT User protection bits
public static final int	APR_FINFO_WPROT Group protection bits
public static final int	APR_FINFO_ICASE World protection bits
public static final int	APR_FINFO_NAME if dev is case insensitive
public static final int	APR_FINFO_MIN ->name in proper case
public static final int	APR_FINFO_IDENT type, mtime, ctime, atime, size
public static final int	APR_FINFO_OWNER dev and inode
public static final int	APR_FINFO_PROT user and group
public static final int	APR_FINFO_NORM all protections
public static final int	APR_FINFO_DIRENT an atomic unix apr_stat()

Constructors Summary

Methods Summary
public static native int	append(java.lang.String fromPath, java.lang.String toPath, int perms, long pool) Append the specified file to another file. The new file does not need to exist, it will be created if required. param fromPath The full path to the source file (use / on all systems) param toPath The full path to the destination file (use / on all systems) param 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. param pool The pool to use.
public static native int	attrsSet(java.lang.String fname, int attributes, int mask, long pool) Set attributes of the specified file. This function should be used in preference to explict 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. param fname The full path to the file (using / on all systems) param 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 param mask Mask of valid bits in attributes. param pool the pool to use.
public static native int	close(long file) Close the specified file. param file The file descriptor to close.
public static native int	copy(java.lang.String fromPath, java.lang.String toPath, int perms, long pool) 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. param fromPath The full path to the original file (using / on all systems) param toPath The full path to the new file (using / on all systems) param 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. param pool The pool to use.
public static native long	dup(long newFile, long oldFile, long pool) Duplicate the specified file descriptor. param newFile The file to duplicate. newFile must point to a valid apr_file_t, or point to NULL. param oldFile The file to duplicate. param pool The pool to use for the new file. return Duplicated file structure.
public static native int	dup2(long newFile, long oldFile, long pool) Duplicate the specified file descriptor and close the original. param newFile The old file that is to be closed and reused. newFile MUST point at a valid apr_file_t. It cannot be NULL. param oldFile The file to duplicate. param pool The pool to use for the new file. return Status code.
public static native int	eof(long fptr) Are we at the end of the file param fptr The apr file we are testing. return Returns APR_EOF if we are at the end of file, APR_SUCCESS otherwise.
public static native int	flagsGet(long file) Retrieve the flags that were passed into apr_file_open() when the file was opened. param file The file to retrive flags. return the flags
public static native int	flush(long thefile) Flush the file's buffer. param thefile The file descriptor to flush
public static native int	getc(long thefile) Read a character from the specified file. param thefile The file descriptor to read from return The readed character
public static native int	gets(byte[] buf, int offset, long thefile) Read a string from the specified file. The buffer will be NUL-terminated if any characters are stored. param buf The buffer to store the string in. param offset Start offset in buf param thefile The file descriptor to read from
public static native int	infoGet(FileInfo finfo, int wanted, long thefile) Get the specified file's stats. param finfo Where to store the information about the file. param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values param thefile The file to get information about.
public static native int	lock(long thefile, int type) 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. param thefile The file to lock. param type The type of lock to establish on the file.
public static native long	mktemp(java.lang.String templ, int flags, long pool) Open a temporary file param templ The template to use when creating a temp file. param 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 param pool The pool to allocate the file out of. return 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.
public static native int	mtimeSet(java.lang.String fname, long mtime, long pool) Set the mtime of the specified file. Warning : Platforms which do not implement this feature will return APR_ENOTIMPL. param fname The full path to the file (using / on all systems) param mtime The mtime to apply to the file in microseconds param pool The pool to use.
public static native java.lang.String	nameGet(long thefile) return the file name of the current file. param thefile The currently open file.
public static native long	open(java.lang.String fname, int flag, int perm, long pool) Open the specified file. param fname The full path to the file (using / on all systems) param 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. param perm Access permissions for file. param pool The pool to use. If perm is APR_OS_DEFAULT and the file is being created, appropriate default permissions will be used. return The opened file descriptor.
public static native int	permsSet(java.lang.String fname, int perms) 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. param fname The file (name) to apply the permissions to. param perms The permission bits to apply to the file.
public static native int	pipeCreate(long[] io, long pool) Create an anonymous pipe. param 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. param pool The pool to operate on.
public static native long	pipeTimeoutGet(long thepipe) Get the timeout value for a pipe or manipulate the blocking state. param thepipe The pipe we are getting a timeout for. return The current timeout value in microseconds.
public static native int	pipeTimeoutSet(long thepipe, long timeout) Set the timeout value for a pipe or manipulate the blocking state. param thepipe The pipe we are setting a timeout on. param timeout The timeout value in microseconds. Values < 0 mean wait forever, 0 means do not wait at all.
public static native int	putc(byte ch, long thefile) Write a character into the specified file. param ch The character to write. param thefile The file descriptor to write to
public static native int	puts(byte[] str, long thefile) Write the string into the specified file. param str The string to write. Must be NUL terminated! param thefile The file descriptor to write to
public static native int	read(long thefile, byte[] buf, int offset, int nbytes) 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. param thefile The file descriptor to read from. param buf The buffer to store the data to. param offset Start offset in buf param nbytes The number of bytes to read (-1) for full array. return the number of bytes read.
public static native int	readFull(long thefile, byte[] buf, int offset, int nbytes) 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. param thefile The file descriptor to read from. param buf The buffer to store the data to. param offset Start offset in buf param nbytes The number of bytes to read (-1) for full array. return the number of bytes read.
public static native int	readFullb(long thefile, java.nio.ByteBuffer buf, int offset, int nbytes) 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. param thefile The file descriptor to read from. param buf The direct ByteBuffer to store the data to. param offset Start offset in buf param nbytes The number of bytes to read. return the number of bytes read.
public static native int	readb(long thefile, java.nio.ByteBuffer buf, int offset, int nbytes) 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. param thefile The file descriptor to read from. param buf The direct Byte buffer to store the data to. param offset Start offset in buf param nbytes The number of bytes to read. return the number of bytes read.
public static native int	remove(java.lang.String path, long pool) Delete the specified file. param path The full path to the file (using / on all systems) param pool The pool to use. If the file is open, it won't be removed until all instances are closed.
public static native int	rename(java.lang.String fromPath, java.lang.String toPath, long pool) 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. param fromPath The full path to the original file (using / on all systems) param toPath The full path to the new file (using / on all systems) param pool The pool to use.
public static native long	seek(long thefile, int where, long offset) Move the read/write file offset to a specified byte within a file. param thefile The file descriptor param 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 param offset The offset to move the pointer to. return Offset the pointer was actually moved to.
public static native int	stat(FileInfo finfo, java.lang.String fname, int wanted, long pool) Get the specified file's stats. The file is specified by filename, instead of using a pre-opened file. param finfo Where to store the information about the file, which is never touched if the call fails. param fname The name of the file to stat. param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values param pool the pool to use to allocate the new file.
public static native int	trunc(long fp, long offset) Truncate the file's length to the specified offset param fp The file to truncate param offset The offset to truncate to.
public static native int	ungetc(byte ch, long thefile) Put a character back onto a specified stream. param ch The character to write. param thefile The file descriptor to write to
public static native int	unlock(long thefile) Remove any outstanding locks on the file. param thefile The file to unlock.
public static native int	write(long thefile, byte[] buf, int offset, int nbytes) 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. param thefile The file descriptor to write to. param buf The buffer which contains the data. param offset Start offset in buf param nbytes The number of bytes to write; (-1) for full array. return The number of bytes written.
public static native int	writeFull(long thefile, byte[] buf, int offset, int nbytes) 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. param thefile The file descriptor to write to. param buf The buffer which contains the data. param offset Start offset in buf param nbytes The number of bytes to write; (-1) for full array. return The number of bytes written.
public static native int	writeFullb(long thefile, java.nio.ByteBuffer buf, int offset, int nbytes) 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. param thefile The file descriptor to write to. param buf The direct ByteBuffer which contains the data. param offset Start offset in buf param nbytes The number of bytes to write. return The number of bytes written.
public static native int	writeb(long thefile, java.nio.ByteBuffer buf, int offset, int nbytes) 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. param thefile The file descriptor to write to. param buf The direct Byte buffer which contains the data. param offset Start offset in buf param nbytes The number of bytes to write return The number of bytes written.
public static native int	writev(long thefile, byte[][] vec) Write data from aray 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(). param thefile The file descriptor to write to. param vec The array from which to get the data to write to the file. return The number of bytes written.
public static native int	writevFull(long thefile, byte[][] vec) Write data from aray 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(). param thefile The file descriptor to write to. param vec The array from which to get the data to write to the file. return The number of bytes written.