| org.apache.cocoon.components.repository.SourceRepository
All known Subclasses: org.apache.cocoon.components.repository.SourceRepositoryImpl,
| SourceRepository | | public interface SourceRepository (Code) | | A stateless utility service intended to be used by flowscripts to help
them with persistent operations on sources.
Each operation returns a status code that is based on RFC 2518 (WebDAV).
version:
$Id: SourceRepository.java 433543 2006-08-22 06:22:54Z crossley $ |
| Method Summary | |
| abstract public int | copy(String from, String to, boolean recurse, boolean overwrite)
Copy a Souce from one location to the other.
Parameters:
from - the source location.
Parameters:
to - the destination location.
Parameters:
recurse - whether to move all the source descendents also.
Parameters:
overwrite - whether to overwrite the destination source if it exists. | | abstract public int | makeCollection(String location)
Create a Source collection.
Parameters:
location - the location of the source collection to create. | | abstract public int | move(String from, String to, boolean recurse, boolean overwrite)
Move a Source from one location to the other.
Parameters:
from - the source location.
Parameters:
to - the destination location.
Parameters:
recurse - whether to move all the source descendents also.
Parameters:
overwrite - whether to overwrite the destination source if it exists. | | abstract public int | remove(String location)
Deletes a Source and all of its descendants.
Parameters:
location - the location of the source to delete. | | abstract public int | save(String in, String out)
Saves a Source by either creating a new one or overwriting the previous one.
Parameters:
in - the Source location to read from.
Parameters:
out - the Source location to write to. |
| STATUS_CONFLICT | | final public static int STATUS_CONFLICT(Code) | | Status CONFLICT (409).
|
| STATUS_CREATED | | final public static int STATUS_CREATED(Code) | | Status CREATED (201).
|
| STATUS_FORBIDDEN | | final public static int STATUS_FORBIDDEN(Code) | | Status FORBIDDEN (403).
|
| STATUS_NOT_ALLOWED | | final public static int STATUS_NOT_ALLOWED(Code) | | Status NOT_ALLOWED (405).
|
| STATUS_NOT_FOUND | | final public static int STATUS_NOT_FOUND(Code) | | Status NOT_FOUND (404).
|
| STATUS_NO_CONTENT | | final public static int STATUS_NO_CONTENT(Code) | | Status NO_CONTENT (204).
|
| STATUS_OK | | final public static int STATUS_OK(Code) | | Status OK (200).
|
| STATUS_PRECONDITION_FAILED | | final public static int STATUS_PRECONDITION_FAILED(Code) | | Status PRECONDITION_FAILED (412)
|
| copy | | abstract public int copy(String from, String to, boolean recurse, boolean overwrite) throws IOException, SourceException(Code) | | Copy a Souce from one location to the other.
Parameters:
from - the source location.
Parameters:
to - the destination location.
Parameters:
recurse - whether to move all the source descendents also.
Parameters:
overwrite - whether to overwrite the destination source if it exists. a status code describing the exit status.
throws:
IOException -
throws:
SourceException - |
| makeCollection | | abstract public int makeCollection(String location) throws IOException, SourceException(Code) | | Create a Source collection.
Parameters:
location - the location of the source collection to create. a status code describing the exit status.
throws:
IOException -
throws:
SourceException - |
| move | | abstract public int move(String from, String to, boolean recurse, boolean overwrite) throws IOException, SourceException(Code) | | Move a Source from one location to the other.
Parameters:
from - the source location.
Parameters:
to - the destination location.
Parameters:
recurse - whether to move all the source descendents also.
Parameters:
overwrite - whether to overwrite the destination source if it exists. a status code describing the exit status.
throws:
IOException -
throws:
SourceException - |
| remove | | abstract public int remove(String location) throws IOException, SourceException(Code) | | Deletes a Source and all of its descendants.
Parameters:
location - the location of the source to delete. a status code describing the exit status.
throws:
IOException -
throws:
SourceException - |
| save | | abstract public int save(String in, String out) throws IOException, SourceException(Code) | | Saves a Source by either creating a new one or overwriting the previous one.
Parameters:
in - the Source location to read from.
Parameters:
out - the Source location to write to. a status code describing the exit status.
throws:
IOException -
throws:
SourceException - |
|
|