|
||||||||||
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()
Default constructor. |
|
JDBCRegistry(javax.sql.DataSource dataSource)
Constructs a JDBC registry to be used without any security (authorizations on actions). |
|
JDBCRegistry(javax.sql.DataSource dataSource,
UserRealm realm)
Constructs a JDBC registry to be used with secure registries. |
Method Summary | |
---|---|
java.lang.String |
addComment(java.lang.String resourcePath,
Comment comment)
Adds a comment to a resource. |
void |
addDependencies(java.lang.String dependentPath,
java.lang.String[] dependencyPaths)
Adds a dependency stating that the resource at "dependentPath" depends on the resource at "dependencyPath". |
void |
addHandler(Filter filter,
Handler handler)
|
void |
applyTag(java.lang.String resourcePath,
java.lang.String tag)
Applies the given tag to the resource in the given path. |
void |
configure(javax.sql.DataSource dataSource,
RegistryRealm realm)
Configures and initiates the JDBC registry with a (new) datasource and a realm. |
void |
delete(java.lang.String path)
Deletes the resource in the given path. |
void |
editComment(java.lang.String commentPath,
java.lang.String text)
Change the text of an existing comment. |
Collection |
executeQuery(java.lang.String path,
java.util.Map parameters)
Executes a custom query which lives at the given path in the Registry. |
Resource |
get(java.lang.String path)
Returns the resource in the given path. |
DependencyChain[] |
getAllDependencies(java.lang.String resourcePath)
Get all dependencies of the given resource. |
DependentChain[] |
getAllDependents(java.lang.String resourcePath)
Get all dependents of the given resource. |
float |
getAverageRating(java.lang.String resourcePath)
Returns the average rating (from all users) for the given resource. |
Comment[] |
getComments(java.lang.String resourcePath)
Returns all comments for the given resource. |
UserRealm |
getDefaultRealm()
|
LogEntry[] |
getLogs(java.lang.String resourcePath,
int action,
java.lang.String userName,
java.util.Date from,
java.util.Date to,
boolean recentFirst)
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)
Get a list of all versions of the resource located at the given path. |
java.lang.String |
importResource(java.lang.String suggestedPath,
java.lang.String sourceURL,
Resource metadata)
Creates a resource by fetching the resource content from the given URL. |
Collection |
newCollection()
|
Resource |
newResource()
|
java.lang.String |
put(java.lang.String suggestedPath,
Resource resource)
Adds or updates resources in the registry. |
void |
rateResource(java.lang.String resourcePath,
int rating)
Rates the given resource. |
void |
removeTag(java.lang.String path,
java.lang.String tag)
Removes a tag on a resource. |
java.lang.String |
rename(java.lang.String currentPath,
java.lang.String newPath)
Move or rename a resource in the registry. |
boolean |
resourceExists(java.lang.String path)
Check whether a resource exists at 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()
public JDBCRegistry(javax.sql.DataSource dataSource) throws RegistryException
dataSource
- Data source to be used to store resources and metadata.
RegistryException
- : If something went wrong while initpublic JDBCRegistry(javax.sql.DataSource dataSource, UserRealm realm) throws RegistryException
dataSource
- Data source to be used to store resources and metadata. Note that the same
data source may or may not be used as the data source of user manager.realm
- User manager realm to handle authorizations. It is strongly recommended to
use a realm instance constructed using the RegistryRealmFactory. All
initial users, roles and authorizations will be set on realms obtained
using the RegistryRealmFactory.
RegistryException
- : If something went wrongMethod Detail |
---|
public void configure(javax.sql.DataSource dataSource, RegistryRealm realm) throws RegistryException
dataSource
- the DataSource to userealm
- Realm to use
RegistryException
- : If something went wrong while initpublic Resource newResource() throws RegistryException
newResource
in interface CoreRegistry
RegistryException
public Collection newCollection() throws RegistryException
newCollection
in interface CoreRegistry
RegistryException
public UserRealm getDefaultRealm()
public Resource get(java.lang.String path) throws RegistryException
get
in interface CoreRegistry
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
CoreRegistry
resourceExists
in interface CoreRegistry
path
- Path of the resource to be checked
RegistryException
- if an error occurspublic java.lang.String put(java.lang.String suggestedPath, Resource resource) throws RegistryException
put
in interface CoreRegistry
suggestedPath
- the path which we'd like to use for the new resource.resource
- Resource instance for the new resource
RegistryException
public java.lang.String importResource(java.lang.String suggestedPath, java.lang.String sourceURL, Resource metadata) throws RegistryException
Registry
importResource
in interface Registry
suggestedPath
- path where we'd like to add the new resource. Although this path is
specified by the caller of the method, resource may not be actually
added at this path.sourceURL
- where to fetch the resource contentmetadata
- a template Resource
RegistryException
- if we couldn't get or store the new resourcepublic java.lang.String rename(java.lang.String currentPath, java.lang.String newPath) throws RegistryException
Registry
rename
in interface Registry
currentPath
- current path of the resourcenewPath
- where we'd like to move the reosurce
RegistryException
- if something went wrongpublic void delete(java.lang.String path) throws RegistryException
delete
in interface CoreRegistry
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
- if there is an errorpublic 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
- if there is an errorpublic void addDependencies(java.lang.String dependentPath, java.lang.String[] dependencyPaths) throws RegistryException
Registry
addDependencies
in interface Registry
dependentPath
- Path of the dependent resourcedependencyPaths
- Paths of dependency resources
RegistryException
- Depends on the implementationpublic DependencyChain[] getAllDependencies(java.lang.String resourcePath) throws RegistryException
Registry
getAllDependencies
in interface Registry
resourcePath
- Path of the resource to analyse dependencies. This can be a path of a
current resource or an old verion of a resource.
RegistryException
public DependentChain[] getAllDependents(java.lang.String resourcePath) throws RegistryException
Registry
getAllDependents
in interface Registry
resourcePath
- Path of the resource to analyse dependents. This can be a path of a
current resource or an old verion of a resource.
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 removeTag(java.lang.String path, java.lang.String tag) throws RegistryException
Registry
removeTag
in interface Registry
path
- Resource path tagged with the given tag.tag
- Name of the tag to be removed.
RegistryException
- if there's a problempublic java.lang.String 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 void editComment(java.lang.String commentPath, java.lang.String text) throws RegistryException
Registry
editComment
in interface Registry
commentPath
- path to comment resource ("..foo/r1;comment:1")text
- new text for the comment.
RegistryException
- Registry implementations may handle exceptions and throw
RegistryException if the exception has to be propagated to the
client.public Comment[] getComments(java.lang.String resourcePath) throws RegistryException
getComments
in interface Registry
resourcePath
- Path of the resource.
RegistryException
- Registry implementations may handle exceptions and throw
RegistryException if the exception has to be propagated to the
client.public 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 float 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
- if there is a problempublic Collection executeQuery(java.lang.String path, java.util.Map parameters) throws RegistryException
Registry
executeQuery
in interface Registry
path
- Path of the query to execute.parameters
- a Map of query parameters (name -> value)
RegistryException
- depends on the implementation.public void shutdown() throws RegistryException
RegistryException
public LogEntry[] getLogs(java.lang.String resourcePath, int action, java.lang.String userName, java.util.Date from, java.util.Date to, boolean recentFirst) throws RegistryException
Registry
getLogs
in interface Registry
resourcePath
- If given, only the logs related to the resource path will be returned. If
null, logs for all resources will be returned.action
- Only the logs pertaining to this action 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.recentFirst
- If true, returned activities will be most-recent first. If false,
returned activities will be oldest first.
RegistryException
- if there is a problempublic void addHandler(Filter filter, Handler handler)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |