...
Here is a description of how each of these methods works.
Method | Important parameters (To extract from Request Context) | Return value | Description | ||
---|---|---|---|---|---|
| requestContext.getResourcePath() // path, the resource is getting | Resource // the resource at the path | Retrieves a resource in a given path. | ||
| requestContext.getResourcePath() // path to put | - | Stores a resource in a given path. | ||
| requestContext.getResourcePath() // path to put | - | Imports a resource from a URL. | ||
| requestContext.getSourcePath() // source to move from | String // the new path | Moves a resource from one to another. | ||
| requestContext.getSourcePath() // source to copy from | String // the new path | Copies a resource from one to another. | ||
| requestContext.getSourcePath() // source of the resource | String // the new path | Changes a name of a resource. | ||
| requestContext.getResourcePath() // the path of the link is creating | - | Creates a sym-link or a remote link. | ||
| requestContext.getResourcePath() // the path of the link to remove | - | Removes a link. | ||
| requestContext.getResourcePath() // the path of the resource to remove | - | Deletes a resource. If this is a collection, all the children will also be removed. | ||
| requestContext.getResourcePath() // the path resource is putting | String // the path of the resource | Called when putting a resource to any path except root. | ||
| requestContext.getResourcePath() // the path resource is importing to | String // the path of the resource | Called when importing a resource to any path except root. | ||
| requestContext.getResource() // the resource to invoke the aspect | - | Triggered when invoking an aspect (Aspects are described in detail in following sections). | ||
| requestContext.getSourcePath() // left branch of the association | - | Triggered when adding an association. | ||
| requestContext.getSourcePath() // left branch of the association | - | Triggered when removing an association. | ||
| requestContext.getResourcePath() // the path of the resource | Association[] | Returns all the associations of a given resource. | ||
| requestContext.getResourcePath() // the path of the resource | Association[] | Returns associations of a give association type of a given resource. | ||
| requestContext.getResourcePath() // the path of the resource | - | Applies a tag to a particular path. | ||
| requestContext.getResourcePath() // the path of the resource | - | Removes a tag in a particular path. | ||
| requestContext.getResourcePath() // the path of the resource | - | Triggered when Rating a resource. | ||
| requestContext.getVersionPath() // the path + version of the resource | - | Triggered when restoring a version-ed resource. | ||
| requestContext.getResourcePath() // Create a version of a resource | - | Triggered when creating a resource.
| ||
| requestContext.getCommentPath() // The path of the comment of a resource | - | Edits a comment in a given path. | ||
| requestContext.getResourcePath() // The path of the resource | String // the comment path | Adds a comment to the given path. | ||
| requestContext.getCommentPath() // The path of the comment of a resource | - | Removes a comment in a given path. | ||
| requestContext.getResourcePath() // The path of the resource | Comment[] | Gets all comments in a given path. | ||
| requestContext.getResourcePath() // The path of the resource | float | Gets the average rating of a resource. | ||
| requestContext.getResourcePath() // The path of the resource | int | Gets the rating given by a user to a given resource. | ||
| requestContext.getResourcePath() // The path of the resource | String[] | Returns version paths of a given resource. | ||
| requestContext.getResourcePath() // The path of the resource | Tag[] | Returns tags of a given resource. | ||
| requestContext.getResourcePath() // The path of the resource | TaggedResourcePath[] | Returns resource paths with a given tag. | ||
| requestContext.getResourcePath() // The path of the query | Collection | Returns collection (paths as the content) queried in the given query. | ||
| requestContext.getKeywords() // The search keywords | Collection | Returns collection (paths as the content) found as a result of search operation. | ||
| requestContext.getResourcePath() // The path of the resource | boolean | Returns whether the resource in the given path exists. | ||
| requestContext.getResourcePath() // The path of the resource | - | Dumps a particular path. | ||
| requestContext.getResourcePath() // The path of the resource | - | Restores a dump. |
Handlers can be engaged and configured using the registry configuration file (registry.xml
). Here is an example of using registry.xml
to declare a handler.
...