| org.apache.cocoon.components.source.impl.SlideSource
| SlideSource | | public class SlideSource extends AbstractLogEnabled implements Contextualizable,Serviceable,Initializable,Source,ModifiableTraversableSource,MoveableSource,LockableSource,InspectableSource,VersionableSource(Code) | | A sources from jakarta slide repositories.
version:
CVS $Id: SlideSource.java 433543 2006-08-22 06:22:54Z crossley $ |
| SlideSource | | public SlideSource(NamespaceAccessToken nat, String scheme, String scope, String path, String principal, String version)(Code) | | Create a slide source.
Parameters:
nat - Namespace access token
Parameters:
scheme - Scheme of the source
Parameters:
path - Path of the source. |
| addSourceLocks | | public void addSourceLocks(SourceLock sourcelock) throws SourceException(Code) | | Add a lock to this source
Parameters:
sourcelock - Lock, which should be added
throws:
SourceException - If an exception occurs during this operation |
| canCancel | | public boolean canCancel(OutputStream stream)(Code) | | Can the data sent to an OutputStream returned by
SlideSource.getOutputStream() be cancelled ?
Parameters:
stream - The ouput stream, which should be cancelled. true if the stream can be cancelled |
| cancel | | public void cancel(OutputStream stream) throws SourceException(Code) | | Cancel the data sent to an OutputStream returned by
SlideSource.getOutputStream() .
After cancel, the stream should no more be used.
Parameters:
stream - The ouput stream, which should be cancelled.
throws:
SourceException - If the ouput stream can't be cancelled. |
| contextualize | | public void contextualize(Context context)(Code) | | Pass the Context to the component.
This method is called after the LogEnabled.enableLogging() (if present)
method and before any other method.
Parameters:
context - The context. |
| copyTo | | public void copyTo(Source source) throws SourceException(Code) | | Copy the current source to a specified destination.
Parameters:
source -
throws:
SourceException - If an exception occurs during the copy. |
| delete | | public void delete()(Code) | | Delete the source.
|
| exists | | public boolean exists()(Code) | | Does this source actually exist ?
true if the resource exists. |
| getChild | | public Source getChild(String name) throws SourceException(Code) | | |
| getContentLength | | public long getContentLength()(Code) | | Return the content length of the content or -1 if the length is
unknown.
Content length of the source. |
| getInputStream | | public InputStream getInputStream() throws IOException, SourceException(Code) | | Return an InputStream object to read from the source.
This is the data at the point of invocation of this method,
so if this is Modifiable, you might get different content
from two different invocations.
Input stream for the source.
throws:
IOException - If an IO excepetion occurs.
throws:
SourceException - If an exception occurs. |
| getLastModified | | public long getLastModified()(Code) | | Get the last modification date of the source or 0 if it
is not possible to determine the date.
Last modified date of the source. |
| getLatestSourceRevision | | public String getLatestSourceRevision() throws SourceException(Code) | | Get the latest revision
Last revision of the source.
throws:
SourceException - If an exception occurs. |
| getMimeType | | public String getMimeType()(Code) | | The mime-type of the content described by this object.
If the source is not able to determine the mime-type by itself
this can be null.
Mime type of the source. |
| getOutputStream | | public OutputStream getOutputStream() throws IOException, SourceException(Code) | | Get an OutputStream where raw bytes can be written to.
The signification of these bytes is implementation-dependent and
is not restricted to a serialized XML document.
a stream to write to
throws:
IOException -
throws:
SourceException - |
| getParent | | public Source getParent() throws SourceException(Code) | | |
| getScheme | | public String getScheme()(Code) | |
See Also: org.apache.excalibur.source.Source.getScheme Scheme of the source. |
| getSourceLocks | | public SourceLock[] getSourceLocks() throws SourceException(Code) | | Returns a enumeration of the existing locks
Enumeration of SourceLock
throws:
SourceException - If an exception occurs. |
| getSourceProperties | | public SourceProperty[] getSourceProperties() throws SourceException(Code) | | Returns a enumeration of the properties
Enumeration of SourceProperty
throws:
SourceException - If an exception occurs. |
| getSourceProperty | | public SourceProperty getSourceProperty(String namespace, String name) throws SourceException(Code) | | Returns a property from a source.
Parameters:
namespace - Namespace of the property
Parameters:
name - Name of the property Property of the source.
throws:
SourceException - If an exception occurs. |
| getSourceRevision | | public String getSourceRevision()(Code) | | Get the current revision of the source
The current revision of the source |
| getSourceRevisionBranch | | public String getSourceRevisionBranch() throws SourceException(Code) | | Get the current branch of the revision from the source
The branch of the revision
throws:
SourceException - If an exception occurs. |
| getURI | | public String getURI()(Code) | | Return the unique identifer for this source
System identifier for the source. |
| getValidity | | public SourceValidity getValidity()(Code) | | Get the Validity object. This can either wrap the last modification
date or the expires information or...
If it is currently not possible to calculate such an information
null is returned.
Validity for the source. |
| initialize | | public void initialize() throws SourceException(Code) | | |
| isCollection | | public boolean isCollection()(Code) | | |
| isVersioned | | public boolean isVersioned() throws SourceException(Code) | | If this source versioned
True if the current source is versioned.
throws:
SourceException - If an exception occurs. |
| makeCollection | | public void makeCollection() throws SourceException(Code) | | |
| moveTo | | public void moveTo(Source source) throws SourceException(Code) | | Move the current source to a specified destination.
Parameters:
source -
throws:
SourceException - If an exception occurs during the move. |
| refresh | | public void refresh()(Code) | | Refresh the content of this object after the underlying data
content has changed.
|
| removeSourceProperty | | public void removeSourceProperty(String namespace, String name) throws SourceException(Code) | | Remove a specified source property.
Parameters:
namespace - Namespace of the property.
Parameters:
name - Name of the property.
throws:
SourceException - If an exception occurs. |
| service | | public void service(ServiceManager manager)(Code) | | Pass the ServiceManager to the composer. The Serviceable implementation
should use the specified ServiceManager to acquire the services it needs for execution
Parameters:
manager - The ServiceManager which this Serviceable uses |
| setSourceProperty | | public void setSourceProperty(SourceProperty property) throws SourceException(Code) | | Sets a property for a source.
Parameters:
property - Property of the source
throws:
SourceException - If an exception occurs during this operation |
| setSourceRevision | | public void setSourceRevision(String revision) throws SourceException(Code) | | Not implemented.
Parameters:
revision - The revision, which should be used.
throws:
SourceException - If an exception occurs. |
| setSourceRevisionBranch | | public void setSourceRevisionBranch(String branch) throws SourceException(Code) | | Not implemented.
Parameters:
branch - The branch, which should be used.
throws:
SourceException - If an exception occurs. |
|
|