Class HttpFileObject<FS extends HttpFileSystem>
- java.lang.Object
-
- org.apache.commons.vfs2.provider.AbstractFileObject<FS>
-
- org.apache.commons.vfs2.provider.http.HttpFileObject<FS>
-
- Type Parameters:
FS
- AnHttpFileSystem
subclass
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,java.lang.Comparable<FileObject>
,java.lang.Iterable<FileObject>
,FileObject
@Deprecated public class HttpFileObject<FS extends HttpFileSystem> extends AbstractFileObject<FS>
Deprecated.Useorg.apache.commons.vfs2.provider.http5
.A file object backed by Apache Commons HttpClient.TODO - status codes.
-
-
Field Summary
-
Fields inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
DEFAULT_BUFFER_SIZE
-
Fields inherited from interface org.apache.commons.vfs2.FileObject
EMPTY_ARRAY
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
HttpFileObject(AbstractFileName fileName, FS fileSystem)
Deprecated.Constructs a new instance.protected
HttpFileObject(AbstractFileName fileName, FS fileSystem, HttpFileSystemConfigBuilder builder)
Deprecated.Constructs a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
doDetach()
Deprecated.Detaches this file object from its file resource.protected long
doGetContentSize()
Deprecated.Returns the size of the file content (in bytes).protected java.io.InputStream
doGetInputStream(int bufferSize)
Deprecated.Creates an input stream to read the file content from.protected long
doGetLastModifiedTime()
Deprecated.Returns the last modified time of this file.protected RandomAccessContent
doGetRandomAccessContent(RandomAccessMode mode)
Deprecated.Creates access to the file for random i/o.protected FileType
doGetType()
Deprecated.Determines the type of this file.protected boolean
doIsWriteable()
Deprecated.Determines if this file can be written to.protected java.lang.String[]
doListChildren()
Deprecated.Throws UnsupportedOperationException.protected java.lang.String
encodePath(java.lang.String unescaped)
Deprecated.Encodes the given path.protected FileContentInfoFactory
getFileContentInfoFactory()
Deprecated.Gets a new FileContentInfoFactory.protected boolean
getFollowRedirect()
Deprecated.Gets whether to follow redirects.protected java.lang.String
getUrlCharset()
Deprecated.Gets the URL charset name.protected java.lang.String
getUserAgent()
Deprecated.Gets the user agent.protected void
setupMethod(org.apache.commons.httpclient.HttpMethod method)
Deprecated.Prepares a HttpMethod object.-
Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
canRenameTo, childrenChanged, close, compareTo, copyFrom, createFile, createFolder, delete, delete, deleteAll, doAttach, doCreateFileContent, doCreateFolder, doDelete, doGetAttributes, doGetCertificates, doGetInputStream, doGetOutputStream, doIsExecutable, doIsHidden, doIsReadable, doIsSameFile, doIsSymbolicLink, doListChildrenResolved, doRemoveAttribute, doRename, doSetAttribute, doSetExecutable, doSetLastModifiedTime, doSetReadable, doSetWritable, endOutput, exists, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getChildren, getContent, getFileOperations, getFileSystem, getInputStream, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, isSymbolicLink, isWriteable, iterator, listFiles, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, refresh, resolveFile, resolveFile, setExecutable, setReadable, setWritable, toString
-
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.commons.vfs2.FileObject
getPath, getURI
-
-
-
-
Constructor Detail
-
HttpFileObject
protected HttpFileObject(AbstractFileName fileName, FS fileSystem)
Deprecated.Constructs a new instance.- Parameters:
fileName
- the file name.fileSystem
- the file system.
-
HttpFileObject
protected HttpFileObject(AbstractFileName fileName, FS fileSystem, HttpFileSystemConfigBuilder builder)
Deprecated.Constructs a new instance.- Parameters:
fileName
- the file name.fileSystem
- the file system.builder
- Configuration options for HTTP.
-
-
Method Detail
-
doDetach
protected void doDetach() throws java.lang.Exception
Deprecated.Detaches this file object from its file resource.- Overrides:
doDetach
in classAbstractFileObject<FS extends HttpFileSystem>
- Throws:
java.lang.Exception
- if an error occurs.
-
doGetContentSize
protected long doGetContentSize() throws java.lang.Exception
Deprecated.Returns the size of the file content (in bytes).- Specified by:
doGetContentSize
in classAbstractFileObject<FS extends HttpFileSystem>
- Returns:
- The size of the file in bytes.
- Throws:
java.lang.Exception
- if an error occurs.
-
doGetInputStream
protected java.io.InputStream doGetInputStream(int bufferSize) throws java.lang.Exception
Deprecated.Creates an input stream to read the file content from. Is only called ifdoGetType()
returnsFileType.FILE
.It is guaranteed that there are no open output streams for this file when this method is called.
The returned stream does not have to be buffered.
- Overrides:
doGetInputStream
in classAbstractFileObject<FS extends HttpFileSystem>
- Parameters:
bufferSize
- Buffer size hint.- Returns:
- An InputStream to read the file content.
- Throws:
java.lang.Exception
- if an error occurs.
-
doGetLastModifiedTime
protected long doGetLastModifiedTime() throws java.lang.Exception
Deprecated.Returns the last modified time of this file.This implementation throws an exception.
- Overrides:
doGetLastModifiedTime
in classAbstractFileObject<FS extends HttpFileSystem>
- Returns:
- The last modification time.
- Throws:
java.lang.Exception
- if an error occurs.
-
doGetRandomAccessContent
protected RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode) throws java.lang.Exception
Deprecated.Description copied from class:AbstractFileObject
Creates access to the file for random i/o. Is only called ifAbstractFileObject.doGetType()
returnsFileType.FILE
.It is guaranteed that there are no open output streams for this file when this method is called.
- Overrides:
doGetRandomAccessContent
in classAbstractFileObject<FS extends HttpFileSystem>
- Parameters:
mode
- The mode to access the file.- Returns:
- The RandomAccessContext.
- Throws:
java.lang.Exception
- if an error occurs.
-
doGetType
protected FileType doGetType() throws java.lang.Exception
Deprecated.Determines the type of this file. Must not return null. The return value of this method is cached, so the implementation can be expensive.- Specified by:
doGetType
in classAbstractFileObject<FS extends HttpFileSystem>
- Returns:
- the type of the file.
- Throws:
java.lang.Exception
- if an error occurs.
-
doIsWriteable
protected boolean doIsWriteable() throws java.lang.Exception
Deprecated.Description copied from class:AbstractFileObject
Determines if this file can be written to. Is only called ifAbstractFileObject.doGetType()
does not returnFileType.IMAGINARY
.This implementation always returns true.
- Overrides:
doIsWriteable
in classAbstractFileObject<FS extends HttpFileSystem>
- Returns:
- true if the file is writable.
- Throws:
java.lang.Exception
- if an error occurs.
-
doListChildren
protected java.lang.String[] doListChildren() throws java.lang.Exception
Deprecated.Throws UnsupportedOperationException.- Specified by:
doListChildren
in classAbstractFileObject<FS extends HttpFileSystem>
- Returns:
- a possible empty String array if the file is a directory or null or an exception if the file is not a directory or can't be read.
- Throws:
java.lang.UnsupportedOperationException
- always thrown.java.lang.Exception
- if an error occurs.
-
encodePath
protected java.lang.String encodePath(java.lang.String unescaped) throws org.apache.commons.httpclient.URIException
Deprecated.Encodes the given path.- Parameters:
unescaped
- An unescaped path.- Returns:
- the encoded path.
- Throws:
org.apache.commons.httpclient.URIException
- if the default protocol charset is not supported
-
getFileContentInfoFactory
protected FileContentInfoFactory getFileContentInfoFactory()
Deprecated.Gets a new FileContentInfoFactory.- Overrides:
getFileContentInfoFactory
in classAbstractFileObject<FS extends HttpFileSystem>
- Returns:
- a new FileContentInfoFactory.
-
getFollowRedirect
protected boolean getFollowRedirect()
Deprecated.Gets whether to follow redirects.- Returns:
- whether to follow redirects.
-
getUrlCharset
protected java.lang.String getUrlCharset()
Deprecated.Gets the URL charset name.- Returns:
- the URL charset name.
-
getUserAgent
protected java.lang.String getUserAgent()
Deprecated.Gets the user agent.- Returns:
- the user agent.
-
setupMethod
protected void setupMethod(org.apache.commons.httpclient.HttpMethod method) throws FileSystemException, org.apache.commons.httpclient.URIException
Deprecated.Prepares a HttpMethod object.- Parameters:
method
- The object which gets prepared to access the file object.- Throws:
FileSystemException
- if an error occurs.org.apache.commons.httpclient.URIException
- if path cannot be represented.- Since:
- 2.0 (was package)
-
-