railo.commons.io.res.type.http
Class HTTPResource

java.lang.Object
  extended by railo.commons.io.res.util.ResourceSupport
      extended by railo.commons.io.res.util.ReadOnlyResourceSupport
          extended by railo.commons.io.res.type.http.HTTPResource
All Implemented Interfaces:
Serializable, Resource

public class HTTPResource
extends ReadOnlyResourceSupport

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface railo.commons.io.res.Resource
ATTRIBUTE_ARCHIVE, ATTRIBUTE_HIDDEN, ATTRIBUTE_SYSTEM
 
Constructor Summary
HTTPResource(HTTPResourceProvider provider, HTTPConnectionData data)
           
 
Method Summary
 boolean exists()
          Tests whether the resource denoted by this abstract pathname exists.
 ContentType getContentType()
           
 InputStream getInputStream()
           
 String getName()
          Returns the name of the resource denoted by this abstract pathname.
 String getParent()
          Returns the pathname string of this abstract pathname's parent, or null if this pathname does not name a parent directory.
 Resource getParentResource()
          Returns the abstract pathname of this abstract pathname's parent, or null if this pathname does not name a parent directory.
 String getPath()
          Converts this abstract pathname into a pathname string.
 Resource getRealResource(String realpath)
          returns a resource that is relative to the current resource
 ResourceProvider getResourceProvider()
           
 boolean isAbsolute()
          Tests whether this abstract pathname is absolute.
 boolean isDirectory()
          Tests whether the resource denoted by this abstract pathname is a directory.
 boolean isFile()
          Tests whether the file denoted by this abstract pathname is a normal file.
 boolean isReadable()
          Tests whether the application can read the resource denoted by this abstract pathname.
 long lastModified()
          Returns the time that the resource denoted by this abstract pathname was last modified.
 long length()
          Returns the length of the resource denoted by this abstract pathname.
 Resource[] listResources()
          Returns an array of abstract pathnames denoting the files in the directory denoted by this abstract pathname.
 void setProxyData(ProxyData pd)
           
 void setTimeout(int timeout)
           
 void setUserAgent(String userAgent)
           
 int statusCode()
           
 
Methods inherited from class railo.commons.io.res.util.ReadOnlyResourceSupport
createDirectory, createFile, getMode, getOutputStream, isWriteable, remove, setLastModified, setMode, setReadable, setWritable
 
Methods inherited from class railo.commons.io.res.util.ResourceSupport
canRead, canWrite, copyFrom, copyTo, createNewFile, delete, equals, getAbsolutePath, getAbsoluteResource, getAttribute, getCanonicalPath, getCanonicalResource, getOutputStream, getReal, isArchive, isHidden, isSystem, list, list, list, listResources, listResources, mkdir, mkdirs, moveTo, renameTo, setArchive, setAttribute, setHidden, setReadOnly, setSystem, toString
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HTTPResource

public HTTPResource(HTTPResourceProvider provider,
                    HTTPConnectionData data)
Method Detail

getContentType

public ContentType getContentType()
                           throws IOException
Throws:
IOException

exists

public boolean exists()
Description copied from interface: Resource
Tests whether the resource denoted by this abstract pathname exists.

Returns:
true if and only if the resource denoted by this abstract pathname exists; false otherwise

statusCode

public int statusCode()

getInputStream

public InputStream getInputStream()
                           throws IOException
Throws:
IOException

getName

public String getName()
Description copied from interface: Resource
Returns the name of the resource denoted by this abstract pathname. This is just the last name in the pathname's name sequence. If the pathname's name sequence is empty, then the empty string is returned.

Returns:
The name of the resource denoted by this abstract pathname, or the empty string if this pathname's name sequence is empty

getParent

public String getParent()
Description copied from interface: Resource
Returns the pathname string of this abstract pathname's parent, or null if this pathname does not name a parent directory.

The parent of an abstract pathname consists of the pathname's prefix, if any, and each name in the pathname's name sequence except for the last. If the name sequence is empty then the pathname does not name a parent directory.

Returns:
The pathname string of the parent directory named by this abstract pathname, or null if this pathname does not name a parent

getParentResource

public Resource getParentResource()
Description copied from interface: Resource
Returns the abstract pathname of this abstract pathname's parent, or null if this pathname does not name a parent directory.

The parent of an abstract pathname consists of the pathname's prefix, if any, and each name in the pathname's name sequence except for the last. If the name sequence is empty then the pathname does not name a parent directory.

Returns:
The abstract pathname of the parent directory named by this abstract pathname, or null if this pathname does not name a parent

getPath

public String getPath()
Description copied from interface: Resource
Converts this abstract pathname into a pathname string.

Returns:
The string form of this abstract pathname

getRealResource

public Resource getRealResource(String realpath)
Description copied from interface: Resource
returns a resource that is relative to the current resource

Returns:
relative resource to the current

getResourceProvider

public ResourceProvider getResourceProvider()

isAbsolute

public boolean isAbsolute()
Description copied from interface: Resource
Tests whether this abstract pathname is absolute.

Returns:
true if this abstract pathname is absolute, false otherwise

isDirectory

public boolean isDirectory()
Description copied from interface: Resource
Tests whether the resource denoted by this abstract pathname is a directory.

Returns:
true if and only if the file denoted by this abstract pathname exists and is a directory; false otherwise

isFile

public boolean isFile()
Description copied from interface: Resource
Tests whether the file denoted by this abstract pathname is a normal file. A file is normal if it is not a directory and, in addition, satisfies other system-dependent criteria. Any non-directory file created by a Java application is guaranteed to be a normal file.

Returns:
true if and only if the file denoted by this abstract pathname exists and is a normal file; false otherwise

isReadable

public boolean isReadable()
Description copied from interface: Resource
Tests whether the application can read the resource denoted by this abstract pathname.

Returns:
true if and only if the resource specified by this abstract pathname exists and can be read by the application; false otherwise

lastModified

public long lastModified()
Description copied from interface: Resource
Returns the time that the resource denoted by this abstract pathname was last modified.

Returns:
A long value representing the time the file was last modified, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970), or 0L if the file does not exist or if an I/O error occurs

length

public long length()
Description copied from interface: Resource
Returns the length of the resource denoted by this abstract pathname. The return value is unspecified if this pathname denotes a directory.

Returns:
The length, in bytes, of the resource denoted by this abstract pathname, or 0L if the resource does not exist

listResources

public Resource[] listResources()
Description copied from interface: Resource
Returns an array of abstract pathnames denoting the files in the directory denoted by this abstract pathname.

If this abstract pathname does not denote a directory, then this method returns null. Otherwise an array of File objects is returned, one for each file or directory in the directory. Therefore if this pathname is absolute then each resulting pathname is absolute; if this pathname is relative then each resulting pathname will be relative to the same directory.

There is no guarantee that the name strings in the resulting array will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.

Returns:
An array of abstract pathnames denoting the files and directories in the directory denoted by this abstract pathname. The array will be empty if the directory is empty. Returns null if this abstract pathname does not denote a directory, or if an I/O error occurs.

setProxyData

public void setProxyData(ProxyData pd)

setUserAgent

public void setUserAgent(String userAgent)

setTimeout

public void setTimeout(int timeout)


Copyright © 2012 Railo