|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.wso2.carbon.registry.core.jdbc.handlers.Handler
org.wso2.carbon.registry.core.jdbc.handlers.builtin.MountHandler
public class MountHandler
This class is used to handle registry calls to mounted registry instances. This plays a key role in making it possible to do remote mounting via configuration (registry.xml) as well as the user interface in a transparent manner.
Constructor Summary | |
---|---|
MountHandler()
|
Method Summary | |
---|---|
void |
addAssociation(RequestContext requestContext)
Gets called when an Association is added. |
java.lang.String |
addComment(RequestContext requestContext)
Gets called when adding a comment. |
void |
applyTag(RequestContext requestContext)
Gets called when a tag is applied. |
java.lang.String |
copy(RequestContext requestContext)
Copy a resource in the registry. |
void |
delete(RequestContext requestContext)
Processes the DELETE action of the media type. |
void |
dump(RequestContext requestContext)
Gets called when dumping an path |
boolean |
equals(java.lang.Object obj)
Revised implementation of the equals comparison to suite the modified hashCode method. |
Collection |
executeQuery(RequestContext requestContext)
Gets called when executing Queries. |
Resource |
get(RequestContext requestContext)
Processes the GET action for resource path of the requestContext. |
Association[] |
getAllAssociations(RequestContext requestContext)
Gets called when getting all Associations. |
Association[] |
getAssociations(RequestContext requestContext)
Gets called when getting Associations of given type. |
float |
getAverageRating(RequestContext requestContext)
Gets called when getting average rating. |
boolean |
getCacheEnabled()
Method to obtain whether caching is enabled or not. |
Comment[] |
getComments(RequestContext requestContext)
Gets called when retrieving comments. |
java.lang.String |
getDbConfig()
Method to obtain the database configuration |
int |
getRating(RequestContext requestContext)
Gets called when getting a rating given by a specific user. |
boolean |
getReadOnly()
Method to obtain whether in read-only mode or not. |
RegistryContext |
getRegistryContext(RequestContext requestContext)
Gets called when obtaining the registry context. |
java.lang.String |
getRegistryRoot()
Method to obtain the registry root. |
TaggedResourcePath[] |
getResourcePathsWithTag(RequestContext requestContext)
Gets called when getting the resource paths corresponding to the given tag. |
Tag[] |
getTags(RequestContext requestContext)
Gets called when getting tags. |
int |
hashCode()
This overrides the default hash code implementation for handler objects, to make sure that each handler of the same type will have identical hash codes unless otherwise it has its own extension. |
void |
importResource(RequestContext requestContext)
Creates a resource in the given path by fetching the resource content from the given URL. |
java.lang.String |
move(RequestContext requestContext)
Move a resource in the registry. |
void |
put(RequestContext requestContext)
Processes the PUT action. |
void |
rateResource(RequestContext requestContext)
Gets called when rating a resource. |
void |
removeAssociation(RequestContext requestContext)
Gets called when an Association is removed. |
void |
removeComment(RequestContext requestContext)
Gets called when removing a comment. |
void |
removeTag(RequestContext requestContext)
Gets called when a tag is removed. |
java.lang.String |
rename(RequestContext requestContext)
Rename a resource in the registry. |
boolean |
resourceExists(RequestContext requestContext)
Gets called when searching for existence of resource. |
void |
restore(RequestContext requestContext)
Gets called when restoring a path |
void |
setAuthor(java.lang.String author)
Method to set the author |
void |
setCacheEnabled(boolean cacheEnabled)
Method to set whether caching is enabled or not. |
void |
setConURL(java.lang.String conURL)
Method to set connection URL |
void |
setDbConfig(java.lang.String dbConfig)
Method to set the database configuration |
void |
setId(java.lang.String id)
Method to set instance identifier |
void |
setMountPoint(java.lang.String mountPoint)
Method to set mount point |
void |
setPassword(java.lang.String password)
Method to set password |
void |
setReadOnly(boolean readOnly)
Method to set whether in read-only mode or not. |
void |
setRegistryRoot(java.lang.String registryRoot)
Method to set the registry root. |
void |
setRegistryType(java.lang.String registryType)
Method to set type of remote registry |
void |
setRemote(boolean remote)
Method to set whether this mount is remote (atom-based) or not |
void |
setSubPath(java.lang.String subPath)
Method to set target sub path |
void |
setUserName(java.lang.String username)
Method to set username |
Methods inherited from class org.wso2.carbon.registry.core.jdbc.handlers.Handler |
---|
createLink, createVersion, editComment, getVersions, importChild, invokeAspect, putChild, removeLink, restoreVersion, searchContent |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MountHandler()
Method Detail |
---|
public int hashCode()
Handler
hashCode
in class Handler
public boolean equals(java.lang.Object obj)
Handler
equals
in class Handler
obj
- object to compare for equality.
public void put(RequestContext requestContext) throws RegistryException
Handler
put
in class Handler
requestContext
- Information about the current request.
requestContext.resourcePath: Path to put the resource.
requestContext.resource: Resource to put
RegistryException
- If the media type handler is supposed to handle the put on the
media type and if the put fails due a handler specific errorpublic boolean resourceExists(RequestContext requestContext) throws RegistryException
Handler
resourceExists
in class Handler
requestContext
- Information about the current request.
RegistryException
- If the media type handler is supposed to handle the resourceExists
on the media type and if the resourceExists fails due a handler
specific errorpublic RegistryContext getRegistryContext(RequestContext requestContext)
Handler
getRegistryContext
in class Handler
requestContext
- Information about the current request.
public Resource get(RequestContext requestContext) throws RegistryException
Handler
get
in class Handler
requestContext
- Information about the current request.
requestContext.resourcePath: Path of the resource
requestContext.resource: Resource at the given path. This can be null
if no other handler has retrieved that resource so far. If it contains
a value, matching handlers are free to do any change to the resource,
even they can replace the resource with completely new instance.
RegistryException
- If the media type handler is supposed to handle the get on the media type and if the
get fails due a handler specific errorpublic void delete(RequestContext requestContext) throws RegistryException
Handler
delete
in class Handler
requestContext
- Information about the current request.
requestContext.resourcePath: path of the resource to be deleted.
RegistryException
- If the media type handler is supposed to handle the delete on the
media type and if the delete fails due a handler specific errorpublic void removeComment(RequestContext requestContext) throws RegistryException
Handler
removeComment
in class Handler
requestContext
- Information about the current request. requestContext.resourcePath:
Path of Resource requestContext.comment: The comment to remove
RegistryException
- If the media type handler is supposed to handle the addComment on
the media type and if the addComment fails due a handler specific
errorpublic void removeTag(RequestContext requestContext) throws RegistryException
Handler
removeTag
in class Handler
requestContext
- Information about the current request. requestContext.resourcePath:
Path of Resource requestContext.tag: Tag
RegistryException
- If the media type handler is supposed to handle the removeTag on
the media type and if the removeTag fails due a handler specific
errorpublic java.lang.String rename(RequestContext requestContext) throws RegistryException
Handler
rename
in class Handler
requestContext
- Information about the current request.
requestContext.sourcePath: Source/Current Path
requestContext.targetPath: Destination/New Path
RegistryException
- if something went wrongpublic java.lang.String move(RequestContext requestContext) throws RegistryException
Handler
move
in class Handler
requestContext
- Information about the current request.
requestContext.sourcePath: Source/Current Path
requestContext.targetPath: Destination/New Path
RegistryException
- if something went wrongpublic java.lang.String copy(RequestContext requestContext) throws RegistryException
Handler
copy
in class Handler
requestContext
- Information about the current request.
requestContext.sourcePath: Source/Current Path
requestContext.targetPath: Destination/New Path
RegistryException
- if something went wrongpublic float getAverageRating(RequestContext requestContext) throws RegistryException
Handler
getAverageRating
in class Handler
requestContext
- Information about the current request. requestContext.resourcePath:
Path of Resource
RegistryException
- If the media type handler is supposed to handle the
getAverageRating on the media type and if the getAverageRating
fails due a handler specific errorpublic int getRating(RequestContext requestContext) throws RegistryException
Handler
getRating
in class Handler
requestContext
- Information about the current request. requestContext.resourcePath:
Path of Resource requestContext.userName: The name of the user
RegistryException
- If the media type handler is supposed to handle the getRating on
the media type and if the getRating fails due a handler specific
errorpublic void rateResource(RequestContext requestContext) throws RegistryException
Handler
rateResource
in class Handler
requestContext
- Information about the current request. requestContext.resourcePath:
Path of Resource requestContext.rating: Rating
RegistryException
- If the media type handler is supposed to handle the rateResource on
the media type and if the rateResource fails due a handler specific
errorpublic Comment[] getComments(RequestContext requestContext) throws RegistryException
Handler
getComments
in class Handler
requestContext
- Information about the current request. requestContext.resourcePath:
Path of Resource
RegistryException
- If the media type handler is supposed to handle the getComments on
the media type and if the getComments fails due a handler specific
errorpublic java.lang.String addComment(RequestContext requestContext) throws RegistryException
Handler
addComment
in class Handler
requestContext
- Information about the current request. requestContext.resourcePath:
Path of Resource requestContext.comment: The comment to add
RegistryException
- If the media type handler is supposed to handle the addComment on
the media type and if the addComment fails due a handler specific
errorpublic Tag[] getTags(RequestContext requestContext) throws RegistryException
Handler
getTags
in class Handler
requestContext
- Information about the current request. requestContext.resourcePath:
Path of Resource
RegistryException
- If the media type handler is supposed to handle the getTags on the
media type and if the getTags fails due a handler specific errorpublic void applyTag(RequestContext requestContext) throws RegistryException
Handler
applyTag
in class Handler
requestContext
- Information about the current request. requestContext.resourcePath:
Path of Resource requestContext.tag: Tag
RegistryException
- If the media type handler is supposed to handle the applyTag on the
media type and if the applyTag fails due a handler specific errorpublic TaggedResourcePath[] getResourcePathsWithTag(RequestContext requestContext) throws RegistryException
Handler
getResourcePathsWithTag
in class Handler
requestContext
- Information about the current request. requestContext.tag: Tag
RegistryException
- If the media type handler is supposed to handle the
getResourcePathsWithTag on the media type and if the
getResourcePathsWithTag fails due a handler specific errorpublic Collection executeQuery(RequestContext requestContext) throws RegistryException
Handler
executeQuery
in class Handler
requestContext
- Information about the current request. requestContext.resourcePath:
Path of Resource requestContext.queryParameters: Map of query
parameters.
RegistryException
- If the media type handler is supposed to handle the executeQuery on
the media type and if the executeQuery fails due a handler specific
errorpublic Association[] getAllAssociations(RequestContext requestContext) throws RegistryException
Handler
getAllAssociations
in class Handler
requestContext
- Information about the current request. requestContext.resourcePath:
Path of Resource
RegistryException
- If the media type handler is supposed to handle the
getAllAssociations on the media type and if the getAllAssociations
fails due a handler specific errorpublic Association[] getAssociations(RequestContext requestContext) throws RegistryException
Handler
getAssociations
in class Handler
requestContext
- Information about the current request. requestContext.resourcePath:
Path of Resource requestContext.associationType: Type of Association
RegistryException
- If the media type handler is supposed to handle the getAssociations
on the media type and if the getAssociations fails due a handler
specific errorpublic void addAssociation(RequestContext requestContext) throws RegistryException
Handler
addAssociation
in class Handler
requestContext
- Information about the current request. requestContext.sourcePath:
Source/Current Path requestContext.targetPath: Destination/New Path
requestContext.associationType: Type of Association
RegistryException
- If the media type handler is supposed to handle the addAssociation
on the media type and if the addAssociation fails due a handler
specific errorpublic void removeAssociation(RequestContext requestContext) throws RegistryException
Handler
removeAssociation
in class Handler
requestContext
- Information about the current request. requestContext.sourcePath:
Source/Current Path requestContext.targetPath: Destination/New Path
requestContext.associationType: Type of Association
RegistryException
- If the media type handler is supposed to handle the
removeAssociation on the media type and if the removeAssociation
fails due a handler specific errorpublic void importResource(RequestContext requestContext) throws RegistryException
Handler
importResource
in class Handler
requestContext
- Information about the current request.
requestContext.resourcePath: Path to add the new resource.
requestContext.sourceURL: URL to fetch the resource content
requestContext.resource: Resource instance containing the meta data for
the resource to be imported. Once import is done, new resource is
created combining the meta data of this meta data object and the
imported content.
RegistryException
- If the media type handler is supposed to handle the import on the
media type and if the import fails due a handler specific errorpublic void dump(RequestContext requestContext) throws RegistryException
Handler
dump
in class Handler
requestContext
- Information about the current request. requestContext.keywords: Search
keywords.
RegistryException
- If the media type handler is supposed to handle the resourceExists
on the media type and if the resourceExists fails due a handler
specific errorpublic void restore(RequestContext requestContext) throws RegistryException
Handler
restore
in class Handler
requestContext
- Information about the current request. requestContext.keywords: Search
keywords.
RegistryException
- If the media type handler is supposed to handle the resourceExists
on the media type and if the resourceExists fails due a handler
specific errorpublic void setId(java.lang.String id)
id
- instance identifierpublic void setConURL(java.lang.String conURL)
conURL
- connection URLpublic void setMountPoint(java.lang.String mountPoint)
mountPoint
- the mount pointpublic void setUserName(java.lang.String username)
username
- the username.public void setPassword(java.lang.String password)
password
- the password.public void setRegistryType(java.lang.String registryType)
registryType
- the type of remote registry.public void setSubPath(java.lang.String subPath)
subPath
- target sub path.public void setAuthor(java.lang.String author)
author
- the author.public void setRemote(boolean remote)
remote
- whether remote or not.public java.lang.String getDbConfig()
public void setDbConfig(java.lang.String dbConfig)
dbConfig
- the database configuration.public boolean getReadOnly()
public void setCacheEnabled(boolean cacheEnabled)
cacheEnabled
- whether caching is enabled or not.public boolean getCacheEnabled()
public void setReadOnly(boolean readOnly)
readOnly
- whether in read-only mode or not.public java.lang.String getRegistryRoot()
public void setRegistryRoot(java.lang.String registryRoot)
registryRoot
- the registry root.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |