Class WebdavFileObject
java.lang.Object
org.apache.commons.vfs2.provider.AbstractFileObject<WebdavFileSystem>
org.apache.commons.vfs2.provider.http.HttpFileObject<WebdavFileSystem>
org.apache.commons.vfs2.provider.webdav.WebdavFileObject
- All Implemented Interfaces:
Closeable,AutoCloseable,Comparable<FileObject>,Iterable<FileObject>,FileObject
A WebDAV file.
- Since:
- 2.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final org.apache.jackrabbit.webdav.property.DavPropertyNameThe character set property name.Fields inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
DEFAULT_BUFFER_SIZE -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedWebdavFileObject(AbstractFileName fileName, WebdavFileSystem fileSystem) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidconfigureMethod(org.apache.commons.httpclient.HttpMethodBase httpMethod) Configures the given HttpMethodBase.protected voidCreates this file as a folder.protected voiddoDelete()Deletes the file.Returns the properties of the WebDAV resource.protected longReturns the size of the file content (in bytes).protected longReturns the last modified time of this file.protected OutputStreamdoGetOutputStream(boolean bAppend) protected FileTypeDetermines the type of this file.protected booleanDetermines if this file can be written to.protected String[]Lists the children of the file.protected FileObject[]Lists the children of the file.protected voiddoRename(FileObject newFile) Rename the file.protected voiddoSetAttribute(String attrName, Object value) Sets an attribute of this file.protected FileContentInfoFactoryprotected voidsetupMethod(org.apache.commons.httpclient.HttpMethod method) Prepares a Method object.Methods inherited from class org.apache.commons.vfs2.provider.http.HttpFileObject
doDetach, doGetInputStream, doGetRandomAccessContent, encodePath, getFollowRedirect, getUrlCharset, getUserAgentMethods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
canRenameTo, childrenChanged, close, compareTo, copyFrom, createFile, createFolder, delete, delete, deleteAll, doAttach, doCreateFileContent, doGetCertificates, doGetInputStream, doIsExecutable, doIsHidden, doIsReadable, doIsSameFile, doIsSymbolicLink, doRemoveAttribute, 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, toStringMethods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.vfs2.FileObject
getPath, getURIMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Field Details
-
RESPONSE_CHARSET
The character set property name.
-
-
Constructor Details
-
WebdavFileObject
Constructs a new instance.- Parameters:
fileName- the file name.fileSystem- the file system.
-
-
Method Details
-
configureMethod
Configures the given HttpMethodBase.- Parameters:
httpMethod- The HttpMethodBase to configure.
-
doCreateFolder
Creates this file as a folder.- Overrides:
doCreateFolderin classAbstractFileObject<WebdavFileSystem>- Throws:
Exception
-
doDelete
Deletes the file.- Overrides:
doDeletein classAbstractFileObject<WebdavFileSystem>- Throws:
Exception
-
doGetAttributes
Returns the properties of the WebDAV resource.- Overrides:
doGetAttributesin classAbstractFileObject<WebdavFileSystem>- Throws:
Exception
-
doGetContentSize
Returns the size of the file content (in bytes).- Overrides:
doGetContentSizein classHttpFileObject<WebdavFileSystem>- Throws:
Exception
-
doGetLastModifiedTime
Returns the last modified time of this file. Is only called ifdoGetType()does not returnFileType.IMAGINARY.- Overrides:
doGetLastModifiedTimein classHttpFileObject<WebdavFileSystem>- Throws:
Exception
-
doGetOutputStream
- Overrides:
doGetOutputStreamin classAbstractFileObject<WebdavFileSystem>- Throws:
Exception
-
doGetType
Determines the type of this file. Must not return null. The return value of this method is cached, so the implementation can be expensive.- Overrides:
doGetTypein classHttpFileObject<WebdavFileSystem>- Throws:
Exception
-
doIsWriteable
Determines if this file can be written to. Is only called ifdoGetType()does not returnFileType.IMAGINARY.This implementation always returns true.
- Overrides:
doIsWriteablein classHttpFileObject<WebdavFileSystem>- Returns:
- true if the file is writable.
- Throws:
Exception- if an error occurs.
-
doListChildren
Lists the children of the file.- Overrides:
doListChildrenin classHttpFileObject<WebdavFileSystem>- Throws:
Exception
-
doListChildrenResolved
Lists the children of the file.- Overrides:
doListChildrenResolvedin classAbstractFileObject<WebdavFileSystem>- Throws:
Exception
-
doRename
Rename the file.- Overrides:
doRenamein classAbstractFileObject<WebdavFileSystem>- Throws:
Exception
-
doSetAttribute
Sets an attribute of this file. Is only called ifdoGetType()does not returnFileType.IMAGINARY.- Overrides:
doSetAttributein classAbstractFileObject<WebdavFileSystem>- Throws:
Exception
-
getFileContentInfoFactory
- Overrides:
getFileContentInfoFactoryin classHttpFileObject<WebdavFileSystem>
-
setupMethod
protected void setupMethod(org.apache.commons.httpclient.HttpMethod method) throws FileSystemException, org.apache.commons.httpclient.URIException Prepares a Method object.- Overrides:
setupMethodin classHttpFileObject<WebdavFileSystem>- Parameters:
method- the HttpMethod.- Throws:
FileSystemException- if an error occurs encoding the uri.org.apache.commons.httpclient.URIException- if the URI is in error.
-