|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.wso2.registry.jdbc.JDBCRegistry
public class JDBCRegistry
JDBC based implementation of the Registry. This will be used mostly as the back-end by other Registry implementations. This can use either an in-memory database or a external database configured using data source. At the initializing, it checks if a data source named "jdbc/WSO2RegistryDB" is configured. If such data source is found, it is used as the database. If a data source is not found, an in-memory database is created using the HSQL.
Constructor Summary | |
---|---|
JDBCRegistry(org.wso2.usermanager.Realm realm)
|
Method Summary | |
---|---|
void |
addComment(java.lang.String resourcePath,
Comment comment)
Adds a comment to a resource. |
void |
applyTag(java.lang.String resourcePath,
java.lang.String tag)
Applies the given tag to the resource in the given path. |
void |
defineQuery(java.lang.String name,
java.lang.String query)
|
void |
delete(java.lang.String path)
Deletes the resource in the given path. |
Artifact |
executeQuery(java.lang.String path,
java.lang.Object[] parameters)
Executes a custom query defined by users. |
Artifact |
get(java.lang.String path)
Returns the resource in the given path. |
int |
getAverageRating(java.lang.String resourcePath)
Returns the avarage rating for the given resource. |
Comment[] |
getComments(java.lang.String resourcePath)
Retruns all comments for the given resource. |
LogEntry[] |
getLogs(java.lang.String resourcePath,
java.lang.String userName,
java.util.Date from,
java.util.Date to)
Returns the logs of the activities occured in the registy. |
int |
getRating(java.lang.String path,
java.lang.String userName)
Returns the rating given to the specified resource by the given user |
TaggedResourcePath[] |
getResourcePathsWithTag(java.lang.String tag)
Returns the paths of the resources, which are tagged using the given tag. |
Tag[] |
getTags(java.lang.String resourcePath)
Returns all tags used for tagging the given resource. |
java.lang.String[] |
getVersions(java.lang.String path)
Returns the paths of the versions of the resource located at the given path. |
void |
put(java.lang.String path,
Artifact artifact)
Adds or updates resources in the registry. |
void |
rateResource(java.lang.String resourcePath,
int rating)
Rates the given resource. |
boolean |
resourceExists(java.lang.String path)
Check whether a resource exist in the given path |
void |
restoreVersion(java.lang.String versionPath)
Reverts a resource to a given version. |
void |
shutdown()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JDBCRegistry(org.wso2.usermanager.Realm realm) throws RegistryException
RegistryException
Method Detail |
---|
public Artifact get(java.lang.String path) throws RegistryException
get
in interface Registry
path
- Path of the resource. e.g. /project1/server/deployment.xml
RegistryException
- ResourceNotFound exception is thrown if the resource is not in the
registrypublic boolean resourceExists(java.lang.String path) throws RegistryException
Registry
resourceExists
in interface Registry
path
- Path of the resource to be checked
RegistryException
- if an error occurspublic void put(java.lang.String path, Artifact artifact) throws RegistryException
put
in interface Registry
path
- Path of the new resourceartifact
- Resource instance for the new resource
RegistryException
- : if the user is not authorizedpublic void delete(java.lang.String path) throws RegistryException
delete
in interface Registry
path
- Path of the resource to be deleted.
RegistryException
- : if the user is not authorizedpublic java.lang.String[] getVersions(java.lang.String path) throws RegistryException
Registry
getVersions
in interface Registry
path
- Path of a current version of a resource
RegistryException
public void restoreVersion(java.lang.String versionPath) throws RegistryException
Registry
restoreVersion
in interface Registry
versionPath
- path of the version to be reverted. It is not necessary to provide the
path of the resource as it can be derived from the version path.
RegistryException
public void applyTag(java.lang.String resourcePath, java.lang.String tag) throws RegistryException
applyTag
in interface Registry
resourcePath
- Path of the resource to be tagged.tag
- Tag. Any string can be used for the tag.
RegistryException
- ResourceNotFound exception is thrown if a resource does not exist
in the given path.public TaggedResourcePath[] getResourcePathsWithTag(java.lang.String tag) throws RegistryException
getResourcePathsWithTag
in interface Registry
tag
- Tag
RegistryException
- if an error occurspublic Tag[] getTags(java.lang.String resourcePath) throws RegistryException
getTags
in interface Registry
resourcePath
- Path of the resource
RegistryException
- ResourceNotFound exception is thrown if a resource does not exist
in the given path.public void addComment(java.lang.String resourcePath, Comment comment) throws RegistryException
addComment
in interface Registry
resourcePath
- Path of the resource to add the comment.comment
- Comment instance for the new comment.
RegistryException
- ResourceNotFound exception is thrown if a resource does not exist
in the given path.public Comment[] getComments(java.lang.String resourcePath) throws RegistryException
getComments
in interface Registry
resourcePath
- Path of the resource.
RegistryException
- if an error occurspublic void rateResource(java.lang.String resourcePath, int rating) throws RegistryException
rateResource
in interface Registry
resourcePath
- Path of the resource.rating
- rating value.
RegistryException
- ResourceNotFound exception is thrown if a resource does not exist
in the given path.public int getAverageRating(java.lang.String resourcePath) throws RegistryException
getAverageRating
in interface Registry
resourcePath
- Path of the resource.
RegistryException
- if an error occurspublic int getRating(java.lang.String path, java.lang.String userName) throws RegistryException
Registry
getRating
in interface Registry
path
- Path of the resourceuserName
- username of the user
RegistryException
public void defineQuery(java.lang.String name, java.lang.String query) throws RegistryException
RegistryException
public Artifact executeQuery(java.lang.String path, java.lang.Object[] parameters) throws RegistryException
Registry
executeQuery
in interface Registry
path
- Path of the query to execute.parameters
- Query parameters.
RegistryException
- depends on the implementation.public void shutdown() throws RegistryException
RegistryException
public LogEntry[] getLogs(java.lang.String resourcePath, java.lang.String userName, java.util.Date from, java.util.Date to) throws RegistryException
Registry
getLogs
in interface Registry
resourcePath
- If given, only the logs related to the resource path is returned.
If null, logs for all resources will be returned.userName
- If given, only the logs for activities done by the given user will be
returned. If null, logs for all users will be returned.from
- If given, logs for activities occured after the given date will be returned. If
null, there will not be a bound for the starting date.to
- If given, logs for activities occured before the given date will be returned. If
null, there will not be a bound for the ending date.
RegistryException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |