A C D E F G H I L M N O P Q R S T U V W

A

absolutize(String, String) - Method in class org.apache.excalibur.source.impl.FileSourceFactory

absolutize(SourceFactory, String, String) - Method in class org.apache.excalibur.source.impl.SourceResolverImpl

Makes an absolute URI based on a baseURI and a relative URI.

absolutize(String, String) - Static method in class org.apache.excalibur.source.SourceUtil

Calls absolutize(url1, url2, false).

absolutize(String, String, boolean) - Static method in class org.apache.excalibur.source.SourceUtil

Calls absolutize(url1, url2, false, true).

absolutize(String, String, boolean, boolean) - Static method in class org.apache.excalibur.source.SourceUtil

Applies a location to a baseURI.

absolutize(String, String) - Method in interface org.apache.excalibur.source.URIAbsolutizer

absolutizeWithoutAuthority(String[], String[]) - Static method in class org.apache.excalibur.source.SourceUtil

Absolutizes URIs whereby the authority part is considered to be a part of the path.

AbstractAggregatedValidity - Class in org.apache.excalibur.source.impl.validity

The base class for the aggregation implementations

AbstractAggregatedValidity() - Constructor for class org.apache.excalibur.source.impl.validity.AbstractAggregatedValidity

AbstractSource - Class in org.apache.excalibur.source.impl

Abstract base class for a source implementation.

AbstractSource() - Constructor for class org.apache.excalibur.source.impl.AbstractSource

add(SourceValidity) - Method in class org.apache.excalibur.source.impl.validity.AbstractAggregatedValidity

add(DeferredValidity) - Method in class org.apache.excalibur.source.impl.validity.DeferredAggregatedValidity

add(SourceParameters) - Method in class org.apache.excalibur.source.SourceParameters

Add all parameters from the incoming parameters object.

AggregatedValidity - Class in org.apache.excalibur.source.impl.validity

A validation object using a List.

AggregatedValidity() - Constructor for class org.apache.excalibur.source.impl.validity.AggregatedValidity

alphabet - Static variable in class org.apache.excalibur.source.SourceUtil

appendParameters(String, Parameters) - Static method in class org.apache.excalibur.source.SourceUtil

Append parameters to the uri.

appendParameters(String, SourceParameters) - Static method in class org.apache.excalibur.source.SourceUtil

Append parameters to the uri Each parameter is appended to the uri with "parameter=value", the parameters are separated by "&".

AUTHORITY - Static variable in class org.apache.excalibur.source.SourceUtil

avalonParameters - Variable in class org.apache.excalibur.source.impl.URLSource

C

canCancel(OutputStream) - Method in class org.apache.excalibur.source.impl.CommonsVFSSource

Whether we can cancel writing to the output stream

canCancel(OutputStream) - Method in class org.apache.excalibur.source.impl.FileSource

Can the data sent to an OutputStream returned by FileSource.getOutputStream() be cancelled ?

canCancel() - Method in class org.apache.excalibur.source.impl.FileSource.FileSourceOutputStream

canCancel(OutputStream) - Method in class org.apache.excalibur.source.impl.FTPSource

Can the data sent to an OutputStream returned by FTPSource.getOutputStream() be cancelled ?

canCancel() - Method in class org.apache.excalibur.source.impl.FTPSource.FTPSourceOutputStream

canCancel(OutputStream) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Method to determine whether writing to the supplied OutputStream (which must be that returned from HTTPClientSource.getOutputStream()) can be cancelled

canCancel() - Method in class org.apache.excalibur.source.impl.HTTPClientSource.WrappedFileOutputStream

Method to test whether this stream can be closed.

canCancel(OutputStream) - Method in interface org.apache.excalibur.source.ModifiableSource

Can the data sent to an OutputStream returned by ModifiableSource.getOutputStream() be cancelled ?

cancel(OutputStream) - Method in class org.apache.excalibur.source.impl.CommonsVFSSource

Cancels writing to the specified output stream.

cancel(OutputStream) - Method in class org.apache.excalibur.source.impl.FileSource

Cancel the data sent to an OutputStream returned by FileSource.getOutputStream().

cancel() - Method in class org.apache.excalibur.source.impl.FileSource.FileSourceOutputStream

cancel(OutputStream) - Method in class org.apache.excalibur.source.impl.FTPSource

Cancel the data sent to an OutputStream returned by FTPSource.getOutputStream().

cancel() - Method in class org.apache.excalibur.source.impl.FTPSource.FTPSourceOutputStream

cancel(OutputStream) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Cancels any data sent to the HTTPClientSource.WrappedFileOutputStream returned by HTTPClientSource.getOutputStream().

cancel() - Method in class org.apache.excalibur.source.impl.HTTPClientSource.WrappedFileOutputStream

Cancels this stream.

cancel(OutputStream) - Method in interface org.apache.excalibur.source.ModifiableSource

Cancel the data sent to an OutputStream returned by ModifiableSource.getOutputStream().

characterCaseDiff - Static variable in class org.apache.excalibur.source.SourceUtil

charactersDontNeedingEncoding - Static variable in class org.apache.excalibur.source.SourceUtil

A BitSet defining the characters which don't need encoding

checkInfos() - Method in class org.apache.excalibur.source.impl.AbstractSource

Call AbstractSource.getInfos() if it hasn't already been called since the last call to AbstractSource.refresh().

clone() - Method in class org.apache.excalibur.source.SourceParameters

Returns a copy of the parameters object.

close() - Method in class org.apache.excalibur.source.impl.FileSource.FileSourceOutputStream

close() - Method in class org.apache.excalibur.source.impl.FTPSource.FTPSourceOutputStream

close() - Method in class org.apache.excalibur.source.impl.HTTPClientSource.WrappedFileOutputStream

Closes the stream, and uploads the file written to the server.

CommonsVFSSource - Class in org.apache.excalibur.source.impl

Source implementation that provides resolver access to all protocols supported by Commons VFS.

CommonsVFSSource(String, Map) - Constructor for class org.apache.excalibur.source.impl.CommonsVFSSource

Constructor, creates instance of class.

CommonsVFSSourceFactory - Class in org.apache.excalibur.source.impl

A factory for source types supported by Commons VFS.

CommonsVFSSourceFactory() - Constructor for class org.apache.excalibur.source.impl.CommonsVFSSourceFactory

CONNECT_TIMEOUT - Static variable in class org.apache.excalibur.source.impl.URLSource

connectTimeout - Variable in class org.apache.excalibur.source.impl.URLSource

containsParameter(String) - Method in class org.apache.excalibur.source.SourceParameters

Test if a value for this parameter exists.

CONTENT_LENGTH - Static variable in class org.apache.excalibur.source.impl.HTTPClientSource

Constant used when obtaining the Content-Length from HTTP Headers

CONTENT_TYPE - Static variable in class org.apache.excalibur.source.impl.HTTPClientSource

Constant used when obtaining the Content-Type from HTTP Headers

contextualize(Context) - Method in class org.apache.excalibur.source.impl.SourceResolverImpl

Get the context

copy(Source, Source) - Static method in class org.apache.excalibur.source.SourceUtil

Copy the source to a specified destination.

copy(InputStream, OutputStream) - Static method in class org.apache.excalibur.source.SourceUtil

Copy the contents of an InputStream to an OutputStream.

copyTo(Source) - Method in class org.apache.excalibur.source.impl.FileSource

copyTo(Source) - Method in interface org.apache.excalibur.source.MoveableSource

Copy the current source to a specified destination.

create(Configuration) - Static method in class org.apache.excalibur.source.SourceParameters

Create a new parameters object from the children of the configuration.

createDeleteMethod(String) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Factory method to create a DeleteMethod object.

createFileSource(String) - Method in class org.apache.excalibur.source.impl.URLSourceFactory

Create an file-based source.

createGetMethod(String) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Factory method to create a GetMethod object.

createHeadMethod(String) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Factory method to create a HeadMethod object.

createPostMethod(String, SourceParameters) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Factory method to create a new PostMethod with the given SourceParameters object.

createPutMethod(String, File) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Factory method to create a PutMethod object.

createURLSource(URL, Map) - Method in class org.apache.excalibur.source.impl.FTPSourceFactory

Creates an FTPSource.

createURLSource(URL, Map) - Method in class org.apache.excalibur.source.impl.URLSourceFactory

Create an URL-based source.

D

decodePath(String) - Static method in class org.apache.excalibur.source.SourceUtil

Decode a path.

DeferredAggregatedValidity - Class in org.apache.excalibur.source.impl.validity

A validation object using a List.

DeferredAggregatedValidity() - Constructor for class org.apache.excalibur.source.impl.validity.DeferredAggregatedValidity

DeferredValidity - Interface in org.apache.excalibur.source.impl.validity

This object delivers a validity object if required.

delete() - Method in class org.apache.excalibur.source.impl.CommonsVFSSource

Deletes the source.

delete() - Method in class org.apache.excalibur.source.impl.FileSource

Delete the source.

delete() - Method in class org.apache.excalibur.source.impl.FTPSource

Delete the source.

delete(String) - Method in class org.apache.excalibur.source.impl.FTPSource.EnhancedFtpClient

delete() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Deletes the referenced resource.

delete() - Method in interface org.apache.excalibur.source.ModifiableSource

Delete the source

deleteSuccessful(int) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

According to RFC2616 (HTTP 1.1) valid responses for a HTTP DELETE are 200 (OK), 202 (Accepted) and 204 (No Content).

dispose() - Method in class org.apache.excalibur.source.impl.SourceResolverImpl

E

enableLogging(Logger) - Method in class org.apache.excalibur.source.impl.CommonsVFSSource

Enables logging for this source.

encode(String) - Static method in class org.apache.excalibur.source.SourceUtil

Translates a string into x-www-form-urlencoded format.

encode(String, String) - Static method in class org.apache.excalibur.source.SourceUtil

Translates a string into x-www-form-urlencoded format with specified encoding

encodeBASE64(String) - Static method in class org.apache.excalibur.source.SourceUtil

BASE 64 encoding.

encodeBASE64(byte[]) - Static method in class org.apache.excalibur.source.SourceUtil

BASE 64 encoding.

executeMethod(HttpMethod) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Executes a particular HttpMethod and updates internal data storage.

exists() - Method in class org.apache.excalibur.source.impl.CommonsVFSSource

Whether this resource exists or not

exists() - Method in class org.apache.excalibur.source.impl.FileSource

Does this source actually exist ?

exists() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Method to ascertain whether the given resource actually exists.

exists() - Method in class org.apache.excalibur.source.impl.ResourceSource

exists() - Method in class org.apache.excalibur.source.impl.URLSource

Does this source exist ?

exists() - Method in interface org.apache.excalibur.source.Source

Does this source exist ?

expires - Variable in class org.apache.excalibur.source.impl.validity.ExpiresValidity

ExpiresValidity - Class in org.apache.excalibur.source.impl.validity

A validation object that holds an expiration date.

ExpiresValidity(long) - Constructor for class org.apache.excalibur.source.impl.validity.ExpiresValidity

Constructor

F

FileSource - Class in org.apache.excalibur.source.impl

A ModifiableTraversableSource for filesystem objects.

FileSource(String) - Constructor for class org.apache.excalibur.source.impl.FileSource

Builds a FileSource given an URI, which doesn't necessarily have to start with "file:"

FileSource(String, File) - Constructor for class org.apache.excalibur.source.impl.FileSource

Builds a FileSource, given an URI scheme and a File.

FileSource.FileSourceOutputStream - Class in org.apache.excalibur.source.impl

A file outputStream that will rename the temp file to the destination file upon close() and discard the temp file upon cancel().

FileSource.FileSourceOutputStream(File, FileSource) - Constructor for class org.apache.excalibur.source.impl.FileSource.FileSourceOutputStream

FileSourceFactory - Class in org.apache.excalibur.source.impl

A factory for filesystem-based sources (see FileSource).

FileSourceFactory() - Constructor for class org.apache.excalibur.source.impl.FileSourceFactory

FileTimeStampValidity - Class in org.apache.excalibur.source.impl.validity

A validation object for time-stamps.

FileTimeStampValidity(String) - Constructor for class org.apache.excalibur.source.impl.validity.FileTimeStampValidity

FileTimeStampValidity(File) - Constructor for class org.apache.excalibur.source.impl.validity.FileTimeStampValidity

FileTimeStampValidity(File, long) - Constructor for class org.apache.excalibur.source.impl.validity.FileTimeStampValidity

finalize() - Method in class org.apache.excalibur.source.impl.FileSource.FileSourceOutputStream

findMethodType() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Method to discover what kind of request is being made from the parameters map passed in to this Source's constructor.

FRAGMENT - Static variable in class org.apache.excalibur.source.SourceUtil

FTPSource - Class in org.apache.excalibur.source.impl

Source implementation for the File Transfer Protocol.

FTPSource() - Constructor for class org.apache.excalibur.source.impl.FTPSource

FTPSource.EnhancedFtpClient - Class in org.apache.excalibur.source.impl

Need to extend FtpClient in order to get to protected issueCommand and implement additional functionality.

FTPSource.EnhancedFtpClient(String) - Constructor for class org.apache.excalibur.source.impl.FTPSource.EnhancedFtpClient

FTPSource.FTPSourceOutputStream - Class in org.apache.excalibur.source.impl

Buffers the output in a byte array and only writes to the remote FTP location at closing time.

FTPSource.FTPSourceOutputStream(FTPSource) - Constructor for class org.apache.excalibur.source.impl.FTPSource.FTPSourceOutputStream

FTPSourceFactory - Class in org.apache.excalibur.source.impl

A factory for an @link FTPSource.

FTPSourceFactory() - Constructor for class org.apache.excalibur.source.impl.FTPSourceFactory

G

GET - Static variable in class org.apache.excalibur.source.impl.HTTPClientSource

Constant used for identifying GET requests.

getCause() - Method in exception org.apache.excalibur.source.SourceException

Retrieve the cause of the exception.

getChild(String) - Method in class org.apache.excalibur.source.impl.FileSource

getChild(String) - Method in interface org.apache.excalibur.source.TraversableSource

Get a child of this source, given its name.

getChildren() - Method in class org.apache.excalibur.source.impl.FileSource

getChildren() - Method in interface org.apache.excalibur.source.TraversableSource

Get the children of this source if this source is traversable.

getClassLoader() - Method in class org.apache.excalibur.source.impl.ResourceSource

getContentLength() - Method in class org.apache.excalibur.source.impl.AbstractSource

Return the content length of the content or -1 if the length is unknown

getContentLength() - Method in class org.apache.excalibur.source.impl.FileSource

getContentLength() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Obtain the content length of the referenced resource.

getContentLength() - Method in interface org.apache.excalibur.source.Source

Get the content length of this source's content or -1 if the length is unknown.

getEncodedQueryString() - Method in class org.apache.excalibur.source.SourceParameters

Build a query string and encode each parameter value.

getFile() - Method in class org.apache.excalibur.source.impl.FileSource

Get the associated file

getFile() - Method in class org.apache.excalibur.source.impl.validity.FileTimeStampValidity

getFile(Source) - Static method in class org.apache.excalibur.source.SourceUtil

Return a File object associated with the Source object.

getFirstParameters() - Method in class org.apache.excalibur.source.SourceParameters

Create a Parameters object.

getFtpClient() - Method in class org.apache.excalibur.source.impl.FTPSource

Creates an FtpClient and logs in the current user.

getInfos() - Method in class org.apache.excalibur.source.impl.AbstractSource

Get the last modification date and content length of the source.

getInfos() - Method in class org.apache.excalibur.source.impl.CommonsVFSSource

Sets content information for this source.

getInfos() - Method in class org.apache.excalibur.source.impl.FTPSource

Get the last modification date and content length of the source.

getInfos() - Method in class org.apache.excalibur.source.impl.ResourceSource

getInfos() - Method in class org.apache.excalibur.source.impl.URLSource

Get the last modification date and content length of the source.

getInputStream() - Method in class org.apache.excalibur.source.impl.AbstractSource

Return an InputStream object to read from the source.

getInputStream() - Method in class org.apache.excalibur.source.impl.CommonsVFSSource

Obtain an InputStream for this source.

getInputStream() - Method in class org.apache.excalibur.source.impl.FileSource

getInputStream() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Method to obtain an InputStream to read the response from the server.

getInputStream() - Method in class org.apache.excalibur.source.impl.ResourceSource

Return an InputStream object to read from the source.

getInputStream() - Method in class org.apache.excalibur.source.impl.URLSource

Return an InputStream object to read from the source.

getInputStream() - Method in interface org.apache.excalibur.source.Source

Return an InputStream to read from the source.

getInstance(String) - Method in class org.apache.excalibur.source.impl.HTTPSClientSourceFactory

Helper method to create a single instance from a class name.

getLastModified() - Method in class org.apache.excalibur.source.impl.AbstractSource

Get the last modification date of the source or 0 if it is not possible to determine the date.

getLastModified() - Method in class org.apache.excalibur.source.impl.FileSource

getLastModified() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Get the last modification date of this source.

getLastModified() - Method in interface org.apache.excalibur.source.Source

Get the last modification date of this source.

getLogger() - Method in class org.apache.excalibur.source.impl.CommonsVFSSource

Obtain access to this components logger.

getMethod() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Helper method to create the required HttpMethod object based on parameters passed to this HTTPClientSource object.

getMimeType() - Method in class org.apache.excalibur.source.impl.AbstractSource

The mime-type of the content described by this object.

getMimeType() - Method in class org.apache.excalibur.source.impl.FileSource

getMimeType() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Obtain the mime-type for the referenced resource.

getMimeType() - Method in class org.apache.excalibur.source.impl.ResourceSource

getMimeType() - Method in class org.apache.excalibur.source.impl.URLSource

The mime-type of the content described by this object.

getMimeType() - Method in interface org.apache.excalibur.source.Source

Get the mime-type of the content described by this object.

getName() - Method in class org.apache.excalibur.source.impl.FileSource

getName() - Method in interface org.apache.excalibur.source.TraversableSource

Return the name of this source relative to its parent.

getOutputStream() - Method in class org.apache.excalibur.source.impl.CommonsVFSSource

Obtain an OutputStream to the source

getOutputStream() - Method in class org.apache.excalibur.source.impl.FileSource

Get an InputStream where raw bytes can be written to.

getOutputStream() - Method in class org.apache.excalibur.source.impl.FTPSource

Return an OutputStream to write to.

getOutputStream() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Obtain an HTTPClientSource.WrappedFileOutputStream to write to.

getOutputStream() - Method in interface org.apache.excalibur.source.ModifiableSource

Return an OutputStream to write to.

getParameter(String) - Method in class org.apache.excalibur.source.SourceParameters

Get the value of a parameter.

getParameter(String, String) - Method in class org.apache.excalibur.source.SourceParameters

Get the value of a parameter.

getParameterAsBoolean(String, boolean) - Method in class org.apache.excalibur.source.SourceParameters

Get the boolean value of a parameter.

getParameterAsInteger(String, int) - Method in class org.apache.excalibur.source.SourceParameters

Get the integer value of a parameter.

getParameterMap() - Method in class org.apache.excalibur.source.SourceParameters

Returns an immutable java.util.Map containing parameter names as keys and parameter values as map values.

getParameterNames() - Method in class org.apache.excalibur.source.SourceParameters

Get all parameter names.

getParameterValues(String) - Method in class org.apache.excalibur.source.SourceParameters

Get all values of a parameter.

getParameterValuesAsArray(String) - Method in class org.apache.excalibur.source.SourceParameters

Get all values of a parameter.

getParent() - Method in class org.apache.excalibur.source.impl.FileSource

getParent() - Method in interface org.apache.excalibur.source.TraversableSource

Get the parent of this source as a Source object.

getPassword() - Method in class org.apache.excalibur.source.impl.FTPSource

getQueryString() - Method in class org.apache.excalibur.source.SourceParameters

Build a query string.

getScheme() - Method in class org.apache.excalibur.source.impl.AbstractSource

Return the protocol identifier.

getScheme() - Method in class org.apache.excalibur.source.impl.FileSource

getScheme() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Return the URI scheme identifier, ie.

getScheme() - Method in interface org.apache.excalibur.source.Source

Return the URI scheme identifier, i.e.

getScheme(String) - Static method in class org.apache.excalibur.source.SourceUtil

Get the scheme of an absolute URI.

getSource(String, Map) - Method in class org.apache.excalibur.source.impl.CommonsVFSSourceFactory

Returns a CommonsVFSSource instance primed with the specified location

getSource() - Method in class org.apache.excalibur.source.impl.FileSource.FileSourceOutputStream

getSource(String, Map) - Method in class org.apache.excalibur.source.impl.FileSourceFactory

getSource() - Method in class org.apache.excalibur.source.impl.FTPSource.FTPSourceOutputStream

getSource(String, Map) - Method in class org.apache.excalibur.source.impl.HTTPClientSourceFactory

Creates a HTTPClientSource instance.

getSource(String, Map) - Method in class org.apache.excalibur.source.impl.ResourceSourceFactory

Get a Source object.

getSource(String, Map) - Method in class org.apache.excalibur.source.impl.URLSourceFactory

getSource(String, Map) - Method in interface org.apache.excalibur.source.SourceFactory

Get a Source object.

getSpecificPart(String) - Static method in class org.apache.excalibur.source.SourceUtil

Get the scheme-specific part of an absolute URI.

getTimeStamp() - Method in class org.apache.excalibur.source.impl.validity.FileTimeStampValidity

getTimeStamp() - Method in class org.apache.excalibur.source.impl.validity.TimeStampValidity

getURI() - Method in class org.apache.excalibur.source.impl.AbstractSource

Return the unique identifer for this source

getURI() - Method in class org.apache.excalibur.source.impl.FileSource

getURI() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Obtain the absolute URI this Source object references.

getURI() - Method in interface org.apache.excalibur.source.Source

Get the absolute URI for this source.

getUser() - Method in class org.apache.excalibur.source.impl.FTPSource

getUserInfo() - Method in class org.apache.excalibur.source.impl.URLSource

The decoded userinfo for this source.

getValidities() - Method in class org.apache.excalibur.source.impl.validity.AbstractAggregatedValidity

getValidity() - Method in class org.apache.excalibur.source.impl.AbstractSource

Get the Validity object.

getValidity() - Method in class org.apache.excalibur.source.impl.FileSource

Return a validity object based on the file's modification date.

getValidity() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Obtain a SourceValidity object.

getValidity() - Method in class org.apache.excalibur.source.impl.ResourceSource

Returns TimeStampValidity as resources may change in a directory-based classloader.

getValidity() - Method in class org.apache.excalibur.source.impl.URLSource

Get the Validity object.

getValidity(int) - Method in class org.apache.excalibur.source.impl.validity.AbstractAggregatedValidity

getValidity(int) - Method in class org.apache.excalibur.source.impl.validity.DeferredAggregatedValidity

getValidity() - Method in interface org.apache.excalibur.source.impl.validity.DeferredValidity

Return the validity

getValidity() - Method in interface org.apache.excalibur.source.Source

Get the Validity object.

H

hasParameters() - Method in class org.apache.excalibur.source.SourceParameters

Test if there are any parameters.

HTTPClientSource - Class in org.apache.excalibur.source.impl

HTTP URL Source object, based on the Jakarta Commons HttpClient project.

HTTPClientSource(String, Map, HttpState) - Constructor for class org.apache.excalibur.source.impl.HTTPClientSource

Constructor, creates a new HTTPClientSource instance.

HTTPClientSource.WrappedFileOutputStream - Class in org.apache.excalibur.source.impl

Internal class which extends FileOutputStream to automatically upload the data written to it, upon a HTTPClientSource.WrappedFileOutputStream.close() operation.

HTTPClientSource.WrappedFileOutputStream(File, Logger) - Constructor for class org.apache.excalibur.source.impl.HTTPClientSource.WrappedFileOutputStream

Constructor, creates a new HTTPClientSource.WrappedFileOutputStream instance.

HTTPClientSourceFactory - Class in org.apache.excalibur.source.impl

HTTPClientSource Factory class.

HTTPClientSourceFactory() - Constructor for class org.apache.excalibur.source.impl.HTTPClientSourceFactory

HTTPS - Static variable in class org.apache.excalibur.source.impl.HTTPSClientSourceFactory

HTTPS constant.

HTTPSClientSourceFactory - Class in org.apache.excalibur.source.impl

HTTPClientSource Factory class.

HTTPSClientSourceFactory() - Constructor for class org.apache.excalibur.source.impl.HTTPSClientSourceFactory

I

indexOfSchemeColon(String) - Static method in class org.apache.excalibur.source.SourceUtil

Get the position of the scheme-delimiting colon in an absolute URI, as specified by RFC 2396, appendix A.

init(String, File) - Method in class org.apache.excalibur.source.impl.FileSource

init(URL, Map) - Method in class org.apache.excalibur.source.impl.FTPSource

Initialize a new object from a URL.

init(URL, Map) - Method in class org.apache.excalibur.source.impl.URLSource

Initialize a new object from a URL.

initialize() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Initializes this HTTPClientSource instance.

INVALID - Static variable in interface org.apache.excalibur.source.SourceValidity

isCollection() - Method in class org.apache.excalibur.source.impl.FileSource

isCollection() - Method in interface org.apache.excalibur.source.TraversableSource

Is this source a collection, i.e.

isValid() - Method in class org.apache.excalibur.source.impl.validity.AggregatedValidity

Check if the component is still valid.

isValid(SourceValidity) - Method in class org.apache.excalibur.source.impl.validity.AggregatedValidity

isValid() - Method in class org.apache.excalibur.source.impl.validity.DeferredAggregatedValidity

Check if the component is still valid.

isValid(SourceValidity) - Method in class org.apache.excalibur.source.impl.validity.DeferredAggregatedValidity

isValid() - Method in class org.apache.excalibur.source.impl.validity.ExpiresValidity

Checks if the expires date is already reached.

isValid(SourceValidity) - Method in class org.apache.excalibur.source.impl.validity.ExpiresValidity

This method is never invoked as isValid() can always perform the complete check.

isValid() - Method in class org.apache.excalibur.source.impl.validity.FileTimeStampValidity

Check if the component is still valid.

isValid(SourceValidity) - Method in class org.apache.excalibur.source.impl.validity.FileTimeStampValidity

isValid() - Method in class org.apache.excalibur.source.impl.validity.NOPValidity

Check if the component is still valid.

isValid(SourceValidity) - Method in class org.apache.excalibur.source.impl.validity.NOPValidity

isValid() - Method in class org.apache.excalibur.source.impl.validity.TimeStampValidity

Check if the component is still valid.

isValid(SourceValidity) - Method in class org.apache.excalibur.source.impl.validity.TimeStampValidity

isValid() - Method in interface org.apache.excalibur.source.SourceValidity

Check if the component is still valid.

isValid(SourceValidity) - Method in interface org.apache.excalibur.source.SourceValidity

Check if the component is still valid.

L

LAST_MODIFIED - Static variable in class org.apache.excalibur.source.impl.HTTPClientSource

Constant used when obtaining the Last-Modified date from HTTP Headers

M

m_baseURL - Variable in class org.apache.excalibur.source.impl.SourceResolverImpl

The base URL

m_cachedLastModificationDate - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

Cached last modification date.

m_cachedLastModificationDate - Variable in class org.apache.excalibur.source.impl.URLSource

m_cachedValidity - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

Stored SourceValidity object.

m_cachedValidity - Variable in class org.apache.excalibur.source.impl.URLSource

the prev returned SourceValidity

m_client - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

The HttpClient object.

m_connection - Variable in class org.apache.excalibur.source.impl.URLSource

The connection for a real URL

m_contentLength - Variable in class org.apache.excalibur.source.impl.AbstractSource

m_contentLength - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

The content length of the resource on the server.

m_dataValid - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

Whether the data held within this instance is currently accurate.

m_encoding - Variable in class org.apache.excalibur.source.impl.URLSource

The encoding of the SourceParameters

m_exists - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

Whether the resource exists on the server.

m_exists - Variable in class org.apache.excalibur.source.impl.URLSource

Does this source exist ?

m_factorySelector - Variable in class org.apache.excalibur.source.impl.SourceResolverImpl

The special Source factories

m_file - Variable in class org.apache.excalibur.source.impl.FileSource

The file

m_file - Variable in class org.apache.excalibur.source.impl.HTTPClientSource.WrappedFileOutputStream

Reference to the File being written itself.

m_file - Variable in class org.apache.excalibur.source.impl.validity.FileTimeStampValidity

m_fileContent - Variable in class org.apache.excalibur.source.impl.CommonsVFSSource

The content of the resource

m_fileObject - Variable in class org.apache.excalibur.source.impl.CommonsVFSSource

The resource itself

m_gotInfos - Variable in class org.apache.excalibur.source.impl.AbstractSource

m_httpState - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

Optional http state passed from SourceFactory

m_isAscii - Variable in class org.apache.excalibur.source.impl.FTPSource

m_isClosed - Variable in class org.apache.excalibur.source.impl.FileSource.FileSourceOutputStream

m_isClosed - Variable in class org.apache.excalibur.source.impl.FTPSource.FTPSourceOutputStream

m_isPost - Variable in class org.apache.excalibur.source.impl.URLSource

Is this a post?

m_lastModificationDate - Variable in class org.apache.excalibur.source.impl.AbstractSource

m_lastModified - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

The last modified date of the resource on the server.

m_list - Variable in class org.apache.excalibur.source.impl.validity.AbstractAggregatedValidity

m_location - Variable in class org.apache.excalibur.source.impl.CommonsVFSSource

Resource location

m_location - Variable in class org.apache.excalibur.source.impl.ResourceSource

Location of the resource

m_logger - Variable in class org.apache.excalibur.source.impl.CommonsVFSSource

Our logging target

m_logger - Variable in class org.apache.excalibur.source.impl.HTTPClientSource.WrappedFileOutputStream

Reference to a Logger.

m_manager - Variable in class org.apache.excalibur.source.impl.CommonsVFSSource

FileSystemManager reference

m_manager - Variable in class org.apache.excalibur.source.impl.SourceResolverImpl

The component m_manager

m_mimeType - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

The mime type of the resource on the server.

m_mimeType - Variable in class org.apache.excalibur.source.impl.ResourceSource

m_mimeType - Variable in class org.apache.excalibur.source.impl.URLSource

The content type (if known)

m_parameters - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

Contextual parameters passed via the SourceFactory.

m_parameters - Variable in class org.apache.excalibur.source.impl.HTTPClientSourceFactory

Configuration information.

m_parameters - Variable in class org.apache.excalibur.source.impl.URLSource

The SourceParameters used for a post

m_proxyHost - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

Proxy host if set via configuration.

m_proxyPort - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

Proxy port if set via configuration.

m_scheme - Variable in class org.apache.excalibur.source.impl.AbstractSource

m_scheme - Variable in class org.apache.excalibur.source.impl.FileSource

The scheme

m_source - Variable in class org.apache.excalibur.source.impl.FileSource.FileSourceOutputStream

m_source - Variable in class org.apache.excalibur.source.impl.FTPSource.FTPSourceOutputStream

m_systemId - Variable in class org.apache.excalibur.source.impl.AbstractSource

m_throwable - Variable in exception org.apache.excalibur.source.SourceException

The Throwable that caused this exception to be thrown.

m_timeStamp - Variable in class org.apache.excalibur.source.impl.validity.FileTimeStampValidity

m_timeStamp - Variable in class org.apache.excalibur.source.impl.validity.TimeStampValidity

m_tmpFile - Variable in class org.apache.excalibur.source.impl.FileSource.FileSourceOutputStream

m_uri - Variable in class org.apache.excalibur.source.impl.FileSource

The URI of this source

m_uri - Variable in class org.apache.excalibur.source.impl.HTTPClientSource

The URI being accessed.

m_url - Variable in class org.apache.excalibur.source.impl.URLSource

The URL of the source

makeCollection() - Method in class org.apache.excalibur.source.impl.FileSource

makeCollection() - Method in interface org.apache.excalibur.source.ModifiableTraversableSource

If it doesn't already exist, ensure this source is traversable (equivalent to File.mkdirs())

makeUrl(String, String, String, String, String) - Static method in class org.apache.excalibur.source.SourceUtil

Assembles an URL from the given URL parts, each of these parts can be null.

METHOD - Static variable in interface org.apache.excalibur.source.SourceResolver

With this parameter you can specify the method to use for getting the content.

mkdir(String) - Method in class org.apache.excalibur.source.impl.FTPSource.EnhancedFtpClient

Create a directory in the current working directory.

mkdirs(String) - Method in class org.apache.excalibur.source.impl.FTPSource.EnhancedFtpClient

Create all directories along a directory path if they do not already exist.

ModifiableSource - Interface in org.apache.excalibur.source

A Source that can be written to.

ModifiableTraversableSource - Interface in org.apache.excalibur.source

A modifiable traversable source.

move(Source, Source) - Static method in class org.apache.excalibur.source.SourceUtil

Move the source to a specified destination.

MoveableSource - Interface in org.apache.excalibur.source

This class marks a source to be able to moved and copied to serveral other locations.

moveTo(Source) - Method in class org.apache.excalibur.source.impl.FileSource

moveTo(Source) - Method in interface org.apache.excalibur.source.MoveableSource

Move the current source to a specified destination.

N

names - Variable in class org.apache.excalibur.source.SourceParameters

The parameter names are the keys and the value is a List object

NOPValidity - Class in org.apache.excalibur.source.impl.validity

A validation object which is always valid.

NOPValidity() - Constructor for class org.apache.excalibur.source.impl.validity.NOPValidity

normalize(String) - Static method in class org.apache.excalibur.source.SourceUtil

Removes things like <segment>/../ or ./, as described in RFC 2396 in step 6 of section 5.2.

O

org.apache.excalibur.source - package org.apache.excalibur.source

org.apache.excalibur.source.impl - package org.apache.excalibur.source.impl

org.apache.excalibur.source.impl.validity - package org.apache.excalibur.source.impl.validity

P

parameterize(Parameters) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Parameterizes this HTTPClientSource instance.

parameterize(Parameters) - Method in class org.apache.excalibur.source.impl.HTTPClientSourceFactory

Parameterize this SourceFactory.

parameterize(Parameters) - Method in class org.apache.excalibur.source.impl.HTTPSClientSourceFactory

Parameterize this SourceFactory.

parameterize(Parameters) - Method in class org.apache.excalibur.source.impl.URLSource

parameterize(Parameters) - Method in class org.apache.excalibur.source.impl.URLSourceFactory

Starting with JDK 1.5, accepts configuration parameters: connect-timeout used to set URLConnection.setConnectTimeout() read-timeout used to set URLConnection.setReadTimeout()

parameters - Variable in class org.apache.excalibur.source.impl.URLSourceFactory

parseName(String) - Method in class org.apache.excalibur.source.SourceParameters

Decode the string

parseUrl(String) - Static method in class org.apache.excalibur.source.SourceUtil

Parses an URL into the following parts: scheme, authority, path, query and fragment identifier.

PATH - Static variable in class org.apache.excalibur.source.SourceUtil

POST - Static variable in class org.apache.excalibur.source.impl.HTTPClientSource

Constant used for identifying POST requests.

PROXY_HOST - Static variable in class org.apache.excalibur.source.impl.HTTPClientSource

Constant used for configuring the proxy hostname.

PROXY_PORT - Static variable in class org.apache.excalibur.source.impl.HTTPClientSource

Constant used for configuring the proxy port number.

Q

QUERY - Static variable in class org.apache.excalibur.source.SourceUtil

R

READ_TIMEOUT - Static variable in class org.apache.excalibur.source.impl.URLSource

readTimeout - Variable in class org.apache.excalibur.source.impl.URLSource

recycle() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Recycles this HTTPClientSource object so that it may be reused to refresh it's content.

refresh() - Method in class org.apache.excalibur.source.impl.AbstractSource

Refresh this object and update the last modified date and content length.

refresh() - Method in class org.apache.excalibur.source.impl.FileSource

refresh() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Refreshes this Source object.

refresh() - Method in class org.apache.excalibur.source.impl.URLSource

Refresh this object and update the last modified date and content length.

refresh() - Method in interface org.apache.excalibur.source.Source

Refresh the content of this object after the underlying data content has changed.

release(Source) - Method in class org.apache.excalibur.source.impl.CommonsVFSSourceFactory

Releases the given source.

release(Source) - Method in class org.apache.excalibur.source.impl.FileSourceFactory

Does nothing, since FileSources don't need to be released.

release(Source) - Method in class org.apache.excalibur.source.impl.HTTPClientSourceFactory

Releases the given Source object.

release(Source) - Method in class org.apache.excalibur.source.impl.ResourceSourceFactory

Release a Source object.

release(Source) - Method in class org.apache.excalibur.source.impl.SourceResolverImpl

Releases a resolved resource

release(Source) - Method in class org.apache.excalibur.source.impl.URLSourceFactory

release(Source) - Method in interface org.apache.excalibur.source.SourceFactory

Release a Source object.

release(Source) - Method in interface org.apache.excalibur.source.SourceResolver

Releases a resolved resource.

removeParameter(String) - Method in class org.apache.excalibur.source.SourceParameters

Remove all values for this parameter

resolveURI(String) - Method in class org.apache.excalibur.source.impl.SourceResolverImpl

Get a Source object.

resolveURI(String, String, Map) - Method in class org.apache.excalibur.source.impl.SourceResolverImpl

Get a Source object.

resolveURI(String) - Method in interface org.apache.excalibur.source.SourceResolver

Get a Source object.

resolveURI(String, String, Map) - Method in interface org.apache.excalibur.source.SourceResolver

Get a Source object.

ResourceSource - Class in org.apache.excalibur.source.impl

Description of a source which is described by the resource protocol which gets a resource from the classloader.

ResourceSource(String) - Constructor for class org.apache.excalibur.source.impl.ResourceSource

ResourceSourceFactory - Class in org.apache.excalibur.source.impl

A factory for the Resource protocol

ResourceSourceFactory() - Constructor for class org.apache.excalibur.source.impl.ResourceSourceFactory

ROLE - Static variable in interface org.apache.excalibur.source.SourceFactory

ROLE - Static variable in interface org.apache.excalibur.source.SourceResolver

S

SCHEME - Static variable in class org.apache.excalibur.source.SourceUtil

service(ServiceManager) - Method in class org.apache.excalibur.source.impl.SourceResolverImpl

Set the current ComponentLocator instance used by this Composable.

setContentLength(long) - Method in class org.apache.excalibur.source.impl.AbstractSource

Sets the contentLength.

setLastModified(long) - Method in class org.apache.excalibur.source.impl.AbstractSource

Sets the lastModificationDate.

setParameter(String, String) - Method in class org.apache.excalibur.source.SourceParameters

Add a parameter.

setProvider(Parameters) - Method in class org.apache.excalibur.source.impl.HTTPSClientSourceFactory

Method to set up the SSL provider for this factory instance.

setScheme(String) - Method in class org.apache.excalibur.source.impl.AbstractSource

Sets the scheme.

setSingleParameterValue(String, String) - Method in class org.apache.excalibur.source.SourceParameters

Set the value of this parameter to the given value.

setSocketFactory(Parameters) - Method in class org.apache.excalibur.source.impl.HTTPSClientSourceFactory

Method to set up the SSL socket factory for this source factory instance.

setSystemId(String) - Method in class org.apache.excalibur.source.impl.AbstractSource

Sets the systemId.

SHARED_INSTANCE - Static variable in class org.apache.excalibur.source.impl.validity.NOPValidity

SOCKET_FACTORY - Static variable in class org.apache.excalibur.source.impl.HTTPSClientSourceFactory

SSL socket factory.

Source - Interface in org.apache.excalibur.source

This interface provides a simple interface for accessing a source of data.

SourceException - Exception in org.apache.excalibur.source

This Exception is thrown every time there is a problem in processing a source.

SourceException(String) - Constructor for exception org.apache.excalibur.source.SourceException

Construct a new SourceException instance.

SourceException(String, Throwable) - Constructor for exception org.apache.excalibur.source.SourceException

Construct a new SourceException instance.

SourceFactory - Interface in org.apache.excalibur.source

A source factory creates new source objects.

SourceNotFoundException - Exception in org.apache.excalibur.source

This Exception should be thrown if the source could not be found.

SourceNotFoundException(String) - Constructor for exception org.apache.excalibur.source.SourceNotFoundException

Construct a new SourceNotFoundException instance.

SourceNotFoundException(String, Throwable) - Constructor for exception org.apache.excalibur.source.SourceNotFoundException

Construct a new SourceNotFoundException instance.

SourceParameters - Class in org.apache.excalibur.source

This class holds parameters for a Source object.

SourceParameters() - Constructor for class org.apache.excalibur.source.SourceParameters

Standard Constructor creating an empty parameters object

SourceParameters(String) - Constructor for class org.apache.excalibur.source.SourceParameters

Construct a new object from a queryString

SourceResolver - Interface in org.apache.excalibur.source

Base interface for resolving a source by system identifiers.

SourceResolverImpl - Class in org.apache.excalibur.source.impl

This is the default implemenation of a SourceResolver.

SourceResolverImpl() - Constructor for class org.apache.excalibur.source.impl.SourceResolverImpl

SourceUtil - Class in org.apache.excalibur.source

Utility class for source resolving.

SourceUtil() - Constructor for class org.apache.excalibur.source.SourceUtil

SourceValidity - Interface in org.apache.excalibur.source

A SourceValidity object contains all information to check if a Source object is still valid.

SSL_PROVIDER - Static variable in class org.apache.excalibur.source.impl.HTTPSClientSourceFactory

SSL implementation provider.

stripLastSegment(String) - Static method in class org.apache.excalibur.source.SourceUtil

successfulUpload(int) - Method in class org.apache.excalibur.source.impl.HTTPClientSource.WrappedFileOutputStream

According to RFC2616 (HTTP 1.1) valid responses for a HTTP PUT are 201 (Created), 200 (OK), and 204 (No Content).

T

TimeStampValidity - Class in org.apache.excalibur.source.impl.validity

A validation object for time-stamps.

TimeStampValidity(long) - Constructor for class org.apache.excalibur.source.impl.validity.TimeStampValidity

toString() - Method in class org.apache.excalibur.source.impl.validity.AbstractAggregatedValidity

toString() - Method in class org.apache.excalibur.source.impl.validity.DeferredAggregatedValidity

toString() - Method in class org.apache.excalibur.source.impl.validity.ExpiresValidity

toString() - Method in class org.apache.excalibur.source.impl.validity.FileTimeStampValidity

toString() - Method in class org.apache.excalibur.source.impl.validity.NOPValidity

toString() - Method in class org.apache.excalibur.source.impl.validity.TimeStampValidity

toString() - Method in class org.apache.excalibur.source.SourceParameters

Overriding toString

TraversableSource - Interface in org.apache.excalibur.source

A traversable source is a source that can have children and a parent, like a file system.

U

UNKNOWN - Static variable in interface org.apache.excalibur.source.SourceValidity

UNKNWON - Static variable in interface org.apache.excalibur.source.SourceValidity

Deprecated. because it has been misspelled, use UNKNOWN of course

updateContentLength(HttpMethod) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Method to update the content length of a resource after executing a particular HttpMethod.

updateData() - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Method to make response data available if possible without actually making an actual request (ie.

updateExists(HttpMethod) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Method to update whether a referenced resource exists, after executing a particular HttpMethod.

updateLastModified(HttpMethod) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Method to update the last modified date of a resource after executing a particular HttpMethod.

updateMimeType(HttpMethod) - Method in class org.apache.excalibur.source.impl.HTTPClientSource

Method to update the mime type of a resource after executing a particular HttpMethod.

upload() - Method in class org.apache.excalibur.source.impl.HTTPClientSource.WrappedFileOutputStream

Helper method to attempt uploading of the local data file to the remove server via a HTTP PUT.

URI_ENCODING - Static variable in interface org.apache.excalibur.source.SourceResolver

With this parameter you can specify the encoding to use for encoding the additional request parameters the URI.

URI_PARAMETERS - Static variable in interface org.apache.excalibur.source.SourceResolver

With this parameter you can specify additional request parameters which are appended to the URI.

URIAbsolutizer - Interface in org.apache.excalibur.source

Implemented by a SourceFactory when it supports applying a relative URI to a base URI to form an absolute URI.

URLSource - Class in org.apache.excalibur.source.impl

Description of a source which is described by an URL.

URLSource() - Constructor for class org.apache.excalibur.source.impl.URLSource

Constructor

URLSourceFactory - Class in org.apache.excalibur.source.impl

A factory for a URL wrapper

URLSourceFactory() - Constructor for class org.apache.excalibur.source.impl.URLSourceFactory

V

VALID - Static variable in interface org.apache.excalibur.source.SourceValidity

W

writeObject(ObjectOutputStream) - Method in class org.apache.excalibur.source.impl.validity.DeferredAggregatedValidity

A C D E F G H I L M N O P Q R S T U V W