|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.wso2.carbon.registry.app.RemoteRegistry
public class RemoteRegistry
This is a core class of the Remote Atom Based implementation of the Registry. This will be used mostly as a front-end client to access the Registry repository. This implementation is based on a REST-ful Atom Pub protocol implementation provided by Apache Abdera.
Constructor Summary | |
---|---|
RemoteRegistry(String registryURL,
String userName,
String password)
To create a remote registry to connect to a secure registry or a registry where we need to pass userName and the password to perform any operation. |
|
RemoteRegistry(URL registryURL)
To create a remote registry need to provide a URL of a remote registry and the URL should be something like http://localhost:8080/wso2registry/atom/r1 |
|
RemoteRegistry(URL registryURL,
String userName,
String password)
To create a remote registry to connect to a secure registry or a registry where we need to pass userName and the password to perform any operation. |
Method Summary | |
---|---|
boolean |
addAspect(String name,
Aspect aspect)
Add aspect by passing a name and the aspect object. |
void |
addAssociation(String sourcePath,
String associationPaths,
String associationType)
Adds an association stating that the resource at "associationPath" associate on the resource at "associationPath". |
String |
addComment(String resourcePath,
Comment comment)
|
String |
addComment(String resourcePath,
Comment comment)
Adds a comment to a resource. |
static void |
addPropertyExtensionElement(Properties properties,
org.apache.abdera.factory.Factory factory,
org.apache.abdera.model.ExtensibleElement entry,
QName node1name,
QName node2Name)
This will generate extension element and that will add to the entry , the created element will be something like <node1name> <node2Name> + <name></name> <value></value> </node2Name> </node1name> |
void |
addUser(String userName,
String password,
String confirmPassword,
String roleName,
String friendlyName)
Deprecated. |
void |
applyTag(String resourcePath,
String tag)
Applies the given tag to the resource in the given path. |
void |
associateAspect(String resourcePath,
String aspect)
Associate an Aspect with a resource. |
void |
beginTransaction()
Start a new transaction |
static String |
buildQueryString(Map parameters)
Method to build the query string from a parameter map. |
void |
commitTransaction()
Commit the currently active transaction |
String |
copy(String sourcePath,
String targetPath)
Copy a resource in the registry. |
void |
createLink(String path,
String target)
Create a symbolic link or mount a registry |
void |
createLink(String path,
String target,
String subTargetPath)
Create a symbolic link or mount a registry |
static void |
createPropertiesFromExtensionElement(Properties properties,
Resource resource)
Method to add resource properties from the properties extension element. |
void |
createVersion(String path)
Creates a new version of the resource. |
static Map |
decodeQueryString(String value)
Method to build the parameter map from a query string.. |
void |
delete(String path)
Deletes the resource at the given path. |
void |
dump(String path,
int timeout,
Writer writer)
check out the given path as an xml |
void |
dump(String path,
Writer writer)
Check out the given path as an xml. |
void |
editComment(String commentPath,
String text)
Change the text of an existing comment. |
static String |
encodeURL(String path)
Method to encode a registry path as a URL. |
Collection |
executeQuery(String path,
Map parameters)
Executes a custom query which lives at the given path in the Registry. |
Resource |
get(String path)
Returns the resource at the given path. |
Collection |
get(String path,
int start,
int pageSize)
Returns the Collection at the given path, with the content paginated according to the arguments. |
Association[] |
getAllAssociations(String resourcePath)
Get all associations of the given resource. |
String[] |
getAspectActions(String resourcePath,
String aspectName)
Obtain a list of the available actions on a given resource for a given Aspect. |
Association[] |
getAssociations(String resourcePath,
String associationType)
Get all associations of the given resource for a give association type. |
String[] |
getAvailableAspects()
Get a list of the available Aspects for this Registry |
float |
getAverageRating(String resourcePath)
Returns the average rating for the given resource. |
Comment[] |
getComments(String resourcePath)
Get all comments for the given resource. |
String |
getEventingServiceURL(String path)
Gets the URL of the WS-Eventing Service. |
LogEntryCollection |
getLogCollection(String resourcePath,
int action,
String userName,
Date from,
Date to,
boolean recentFirst)
Returns the logs of the activities occurred in the registry. |
LogEntry[] |
getLogs(String resourcePath,
int action,
String userName,
Date from,
Date to,
boolean recentFirst)
Returns the logs of the activities occurred in the registry. |
Resource |
getMetaData(String path)
Returns the meta data of the resource at a given path. |
int |
getRating(String path,
String userName)
Returns the rating given to the specified resource by the given user |
RegistryContext |
getRegistryContext()
Get the configuration for this Registry |
TaggedResourcePath[] |
getResourcePathsWithTag(String tag)
Returns the paths of all Resources that are tagged with the given tag. |
Tag[] |
getTags(String resourcePath)
Returns all tags used for tagging the given resource. |
String[] |
getVersions(String path)
Get a list of all versions of the resource located at the given path. |
String |
importResource(String suggestedPath,
String sourceURL,
Resource resource)
|
String |
importResource(String suggestedPath,
String sourceURL,
Resource resource)
Creates a resource by fetching the resource content from the given URL. |
void |
invokeAspect(String resourcePath,
String aspectName,
String action)
This invokes an action on a specified Aspect, which must be associated with the Resource at the given path. |
void |
invokeAspect(String resourcePath,
String aspectName,
String action,
Map<String,String> parameters)
This invokes an action on a specified Aspect, which must be associated with the Resource at the given path. |
String |
move(String currentPath,
String newPath)
Move a resource in the registry. |
Collection |
newCollection()
Creates a new collection. |
Resource |
newResource()
Creates a new resource. |
String |
put(String suggestedPath,
Resource resource)
|
String |
put(String suggestedPath,
Resource resource)
Adds or updates resources in the registry. |
void |
rateResource(String resourcePath,
int rating)
Rate the given resource. |
boolean |
removeAspect(String aspect)
Remove the given aspect from registry context. |
void |
removeAssociation(String sourcePath,
String associationPaths,
String associationType)
To remove an association for a given resource |
void |
removeComment(String commentPath)
Delete an existing comment. |
void |
removeLink(String path)
Remove a symbolic link or mount point created |
void |
removeTag(String path,
String tag)
Removes a tag on a resource. |
String |
rename(String currentPath,
String newPath)
Rename a resource in the registry. |
boolean |
resourceExists(String path)
Check whether a resource exists at the given path |
void |
restore(String path,
Reader reader)
Check in the input axiom element into database. |
void |
restore(String path,
Reader reader,
int timeout)
check in the input axiom element into database |
void |
restoreVersion(String versionPath)
Reverts a resource to a given version. |
void |
rollbackTransaction()
Rollback the currently active transaction |
Collection |
searchContent(String keywords)
Search the content of resources |
void |
setEventingServiceURL(String path,
String eventingServiceURL)
Sets the URL of the WS-Eventing Service. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RemoteRegistry(URL registryURL)
registryURL
- URL to the registry or to the resourcepublic RemoteRegistry(URL registryURL, String userName, String password) throws RegistryException
registryURL
- URL to the registry or to the resourceuserName
- user name of the registry, value can be null, if the value is null then
the user will be the anonymous.password
- password, value can be null
RegistryException
- if an error occurred.public RemoteRegistry(String registryURL, String userName, String password) throws MalformedURLException, RegistryException
registryURL
- URL to the registry or to the resource as a String.userName
- user name of the registry, value can be null, if the value is null then
the user will be the anonymous.password
- password, value can be null
RegistryException
- if an error occurred.
MalformedURLException
- if the URL was not properly formed.Method Detail |
---|
public Resource newResource() throws RegistryException
CoreRegistry
newResource
in interface CoreRegistry
RegistryException
- if the operation failed.public Collection newCollection() throws RegistryException
CoreRegistry
newCollection
in interface CoreRegistry
RegistryException
- if the operation failed.public Resource get(String path) throws RegistryException
CoreRegistry
get
in interface CoreRegistry
path
- Path of the resource. e.g. /project1/server/deployment.xml
RegistryException
- is thrown if the resource is not in the registrypublic Resource getMetaData(String path) throws RegistryException
Registry
getMetaData
in interface Registry
path
- Path of the resource. e.g. /project1/server/deployment.xml
RegistryException
- is thrown if the resource is not in the registrypublic String importResource(String suggestedPath, String sourceURL, Resource resource) throws RegistryException
importResource
in interface Registry
RegistryException
public Collection get(String path, int start, int pageSize) throws RegistryException
CoreRegistry
get
in interface CoreRegistry
path
- the path of the collection. MUST point to a collection!start
- the initial index of the child to return. If there are fewer children than
the specified value, a RegistryException will be thrown.pageSize
- the maximum number of results to return
RegistryException
- if the resource is not found, or if the path does not reference a
Collection, or if the start index is greater than the number of
children.public boolean resourceExists(String path) throws RegistryException
CoreRegistry
resourceExists
in interface CoreRegistry
path
- Path of the resource to be checked
RegistryException
- if an error occurspublic String put(String suggestedPath, Resource resource) throws RegistryException
put
in interface CoreRegistry
RegistryException
public String put(String suggestedPath, Resource resource) throws RegistryException
CoreRegistry
suggestedPath
- the path which we'd like to use for the new resource.resource
- Resource instance for the new resource
RegistryException
- is thrown depending on the implementation.public static void createPropertiesFromExtensionElement(Properties properties, Resource resource)
properties
- the properties extension element.resource
- the properties.public static void addPropertyExtensionElement(Properties properties, org.apache.abdera.factory.Factory factory, org.apache.abdera.model.ExtensibleElement entry, QName node1name, QName node2Name)
properties
- List of Name value pairsfactory
- Abdera Factoryentry
- Instance of entry where extension element need to addnode1name
- Name of node 1node2Name
- Name of node 2public String importResource(String suggestedPath, String sourceURL, Resource resource) throws RegistryException
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 contentresource
- a template Resource
RegistryException
- if we couldn't get or store the new resourcepublic void delete(String path) throws RegistryException
CoreRegistry
delete
in interface CoreRegistry
path
- Path of the resource to be deleted.
RegistryException
- is thrown depending on the implementation.public String rename(String currentPath, String newPath) throws RegistryException
Registry
rename
in interface Registry
currentPath
- current path of the resourcenewPath
- the name of the new resource
RegistryException
- if something went wrongpublic String move(String currentPath, String newPath) throws RegistryException
Registry
move
in interface Registry
currentPath
- current path of the resourcenewPath
- where we'd like to move the resource
RegistryException
- if something went wrongpublic String copy(String sourcePath, String targetPath) throws RegistryException
Registry
copy
in interface Registry
sourcePath
- current path of the resourcetargetPath
- where we'd like to copy the resource
RegistryException
- if something went wrongpublic void createVersion(String path) throws RegistryException
Registry
createVersion
in interface Registry
path
- the resource path.
RegistryException
- if something went wrong.public String[] getVersions(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(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 addAssociation(String sourcePath, String associationPaths, String associationType) throws RegistryException
Registry
addAssociation
in interface Registry
sourcePath
- Path of the source resourceassociationPaths
- Path of the target resourceassociationType
- Type of the association
RegistryException
- Depends on the implementationpublic void removeAssociation(String sourcePath, String associationPaths, String associationType) throws RegistryException
Registry
removeAssociation
in interface Registry
sourcePath
- Path of the source resourceassociationPaths
- Path of the target resourceassociationType
- Type of the association
RegistryException
- Depends on the implementationpublic Association[] getAllAssociations(String resourcePath) throws RegistryException
Registry
getAllAssociations
in interface Registry
resourcePath
- Path of the resource to analyse associations.
RegistryException
- If something went wrongpublic Association[] getAssociations(String resourcePath, String associationType) throws RegistryException
Registry
getAssociations
in interface Registry
resourcePath
- Path of the resource to analyse associations.associationType
- Type of the association , that could be dependency, or some other
type.
RegistryException
- If something went wrongpublic void applyTag(String resourcePath, String tag) throws RegistryException
Registry
applyTag
in interface Registry
resourcePath
- Path of the resource to be tagged.tag
- Tag. Any string can be used for the tag.
RegistryException
- is thrown if a resource does not exist in the given path.public TaggedResourcePath[] getResourcePathsWithTag(String tag) throws RegistryException
Registry
getResourcePathsWithTag
in interface Registry
tag
- the tag to search for
RegistryException
- if an error occurspublic Tag[] getTags(String resourcePath) throws RegistryException
Registry
getTags
in interface Registry
resourcePath
- Path of the resource
RegistryException
- is thrown if a resource does not exist in the given path.public void removeTag(String path, 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 String addComment(String resourcePath, Comment comment) throws RegistryException
addComment
in interface Registry
RegistryException
public String addComment(String resourcePath, Comment comment) throws RegistryException
Registry
resourcePath
- Path of the resource to add the comment.comment
- Comment instance for the new comment.
RegistryException
- is thrown if a resource does not exist in the given path.public void editComment(String commentPath, 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(String resourcePath) throws RegistryException
Registry
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(String resourcePath, int rating) throws RegistryException
Registry
rateResource
in interface Registry
resourcePath
- Path of the resource.rating
- Rating value between 1 and 5.
RegistryException
- Registry implementations may handle exceptions and throw
RegistryException if the exception has to be propagated to the
client.public float getAverageRating(String resourcePath) throws RegistryException
Registry
getAverageRating
in interface Registry
resourcePath
- Path of the resource.
RegistryException
- if an error occurspublic int getRating(String path, 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(String path, 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 static String buildQueryString(Map parameters)
parameters
- the parameter map.
public static Map decodeQueryString(String value)
value
- the query string.
public LogEntry[] getLogs(String resourcePath, int action, String userName, Date from, 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. For acceptable
values, see LogEntry.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 occurred 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 occurred 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 problemAccepted values for action parameter
public LogEntryCollection getLogCollection(String resourcePath, int action, String userName, Date from, Date to, boolean recentFirst) throws RegistryException
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. For acceptable
values, see LogEntry.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 occurred 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 occurred 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 problemAccepted values for action parameter
public static String encodeURL(String path)
path
- the registry path.
@Deprecated public void addUser(String userName, String password, String confirmPassword, String roleName, String friendlyName) throws RegistryException
RegistryException
public String[] getAvailableAspects()
Registry
getAvailableAspects
in interface Registry
public void associateAspect(String resourcePath, String aspect) throws RegistryException
Registry
associateAspect
in interface Registry
resourcePath
- Path of the resourceaspect
- Name of the aspect
RegistryException
- If some thing went wrong while doing associating the phasepublic void invokeAspect(String resourcePath, String aspectName, String action) throws RegistryException
Registry
invokeAspect
in interface Registry
resourcePath
- Path of the resourceaspectName
- Name of the aspectaction
- Which action was selected - actions are aspect-specific
RegistryException
- if the Aspect isn't associated with the Resource, or the action
isn't valid, or an Aspect-specific problem occurs.public void invokeAspect(String resourcePath, String aspectName, String action, Map<String,String> parameters) throws RegistryException
Registry
resourcePath
- Path of the resourceaspectName
- Name of the aspectaction
- Which action was selected - actions are aspect-specificparameters
- Parameters to be used for the operation
RegistryException
- if the Aspect isn't associated with the Resource, or the action
isn't valid, or an Aspect-specific problem occurs.public boolean removeAspect(String aspect) throws RegistryException
Registry
aspect
- the name of the aspect to be removed
RegistryException
- throws if the operation failpublic boolean addAspect(String name, Aspect aspect) throws RegistryException
Registry
name
- the name of the aspect to be addedaspect
- the name of the aspect object to be added to registry context
RegistryException
- throws if the operation failpublic void beginTransaction() throws RegistryException
TransactionManager
beginTransaction
in interface TransactionManager
RegistryException
- If an error occurs while starting a transactionpublic void commitTransaction() throws RegistryException
TransactionManager
commitTransaction
in interface TransactionManager
RegistryException
- If an error occurs while committing a transactionpublic void rollbackTransaction() throws RegistryException
TransactionManager
rollbackTransaction
in interface TransactionManager
RegistryException
- If an error occurs while rolling back a transactionpublic String[] getAspectActions(String resourcePath, String aspectName) throws RegistryException
Registry
getAspectActions
in interface Registry
resourcePath
- path of the ResourceaspectName
- name of the Aspect to query for available actions
RegistryException
- if the Aspect isn't associated or an Aspect-specific problem
occurspublic RegistryContext getRegistryContext()
Registry
public Collection searchContent(String keywords) throws RegistryException
Registry
searchContent
in interface Registry
keywords
- keywords to look for
RegistryException
- throws if the operation failpublic void createLink(String path, String target) throws RegistryException
Registry
createLink
in interface Registry
path
- the mount pathtarget
- the point to be mounted
RegistryException
- throws if the operation failpublic void createLink(String path, String target, String subTargetPath) throws RegistryException
Registry
createLink
in interface Registry
path
- the mount pathtarget
- the point to be mountedsubTargetPath
- sub path in the remote instance to be mounted
RegistryException
- throws if the operation failpublic void removeLink(String path) throws RegistryException
Registry
removeLink
in interface Registry
path
- the mount path
RegistryException
- throws if the operation failpublic void restore(String path, Reader reader) throws RegistryException
Registry
restore
in interface Registry
path
- path to check inreader
- reader containing resource
RegistryException
- throws if the operation failpublic void dump(String path, Writer writer) throws RegistryException
Registry
dump
in interface Registry
path
- path to check outwriter
- writer to write the response
RegistryException
- throws if the operation failpublic void restore(String path, Reader reader, int timeout) throws RegistryException
path
- path to check inreader
- reader containing resourcetimeout
- the time to wait.
RegistryException
- if the operation failed.public void dump(String path, int timeout, Writer writer) throws RegistryException
path
- path to check outwriter
- writer to write the responsetimeout
- the time to wait.
RegistryException
- if the operation failed.public String getEventingServiceURL(String path) throws RegistryException
Registry
getEventingServiceURL
in interface Registry
path
- the path to which the WS-Eventing Service URL is required
RegistryException
- throws if the operation failpublic void setEventingServiceURL(String path, String eventingServiceURL) throws RegistryException
Registry
setEventingServiceURL
in interface Registry
path
- the path to which the WS-Eventing Service URL is associatedeventingServiceURL
- the URL of the WS-Eventing Service
RegistryException
- throws if the operation failpublic void removeComment(String commentPath) throws RegistryException
Registry
removeComment
in interface Registry
commentPath
- path to comment resource ("..foo/r1;comment:1")
RegistryException
- Registry implementations may handle exceptions and throw
RegistryException if the exception has to be propagated to the
client.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |