org.wso2.carbon.governance.api.util
Class GovernanceUtils

java.lang.Object
  extended by org.wso2.carbon.governance.api.util.GovernanceUtils

public class GovernanceUtils
extends Object

Utilities used by various Governance API related functionality.


Constructor Summary
GovernanceUtils()
           
 
Method Summary
static void associateAspect(String path, String aspect, org.wso2.carbon.registry.core.Registry registry)
          Method to associate an aspect with a given resource on the registry.
static org.apache.axiom.om.OMElement buildOMElement(byte[] content)
          Method to build an AXIOM element from a byte stream.
static String derivePathFromQName(QName qName)
          Method to obtain a path from a qualified name.
static List<org.apache.axiom.om.OMElement> evaluateXPathToElements(String expression, org.apache.axiom.om.OMElement root)
           
static GovernanceArtifactConfiguration findGovernanceArtifactConfiguration(String key, org.wso2.carbon.registry.core.Registry registry)
          Query to search for a governance artifact configuration.
static List<GovernanceArtifactConfiguration> findGovernanceArtifactConfigurations(org.wso2.carbon.registry.core.Registry registry)
          Method to locate Governance Artifact configurations.
static String[] findGovernanceArtifacts(String mediaType, org.wso2.carbon.registry.core.Registry registry)
          Query to search for governance artifacts.
static String[] getAllArtifactIds(org.wso2.carbon.registry.core.Registry registry)
          Method to obtain all indexed governance artifact identifiers on the provided registry instance.
static GovernanceArtifact[] getAllArtifacts(org.wso2.carbon.registry.core.Registry registry)
          Method to obtain all indexed governance artifacts on the provided registry instance.
static String getArtifactPath(org.wso2.carbon.registry.core.Registry registry, String artifactId)
          Method to obtain the artifact path of a governance artifact on the registry.
static String getAttributeValue(org.apache.axiom.om.OMElement element, String name, String namespace)
          Method to obtain the value of a governance attribute.
static String[] getAvailableAspects()
          Method to obtain all available aspects for the given tenant.
static GovernanceArtifactConfiguration getGovernanceArtifactConfiguration(String elementString)
           
static org.wso2.carbon.registry.core.Registry getGovernanceSystemRegistry(org.wso2.carbon.registry.core.Registry registry)
          Returns the system governance registry.
static org.wso2.carbon.registry.core.Registry getGovernanceUserRegistry(org.wso2.carbon.registry.core.Registry registry, String username)
          Obtains the governance user registry from the given root registry instance.
static org.wso2.carbon.registry.core.Registry getGovernanceUserRegistry(org.wso2.carbon.registry.core.Registry registry, String username, int tenantId)
          Obtains the governance user registry from the given root registry instance.
static String getNameFromUrl(String url)
          Obtain a name that can represent a URL.
static String getPathFromPathExpression(String pathExpression, GovernanceArtifact artifact)
          Method to convert the expression specified for storing the path with corresponding values where the artifact is stored.
static String getPathFromPathExpression(String pathExpression, GovernanceArtifact artifact, String storagePath)
          Method to convert the expression specified for storing the path with corresponding values where the artifact is stored.
static String[] getPathsFromPathExpression(String pathExpression, GovernanceArtifact artifact)
          Method to convert the expression specified for storing the path with corresponding values where the artifact is stored.
static String[] getResultPaths(org.wso2.carbon.registry.core.Registry registry, String mediaType)
          Method to obtain a list of paths having resources of the given media type.
static boolean hasSamePath(String pathExpression, GovernanceArtifact newArtifact, GovernanceArtifact oldArtifact)
          Method to compare the old and new artifact paths
static void loadGovernanceArtifacts(org.wso2.carbon.registry.core.session.UserRegistry registry)
          Method to load the Governance Artifacts to be used by the API operations.
static void removeArtifact(org.wso2.carbon.registry.core.Registry registry, String artifactId)
          Method to remove a governance artifact from the registry.
static void removeAspect(String path, String aspect, org.wso2.carbon.registry.core.Registry registry)
          Method to remove an aspect from a given resource on the registry.
static GovernanceArtifact retrieveGovernanceArtifactById(org.wso2.carbon.registry.core.Registry registry, String artifactId)
          Method to obtain a governance artifact on the registry.
static GovernanceArtifact retrieveGovernanceArtifactByPath(org.wso2.carbon.registry.core.Registry registry, String artifactPath)
          Method to obtain a governance artifact on the registry by the artifact path.
static String serializeOMElement(org.apache.axiom.om.OMElement element)
          Method to serialize an XML element into a string.
static void setRegistryService(org.wso2.carbon.registry.core.service.RegistryService registryService)
          Setting the registry service.
static void setTenantGovernanceSystemRegistry(int tenantId)
           
static void unsetTenantGovernanceSystemRegistry()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GovernanceUtils

public GovernanceUtils()
Method Detail

setRegistryService

public static void setRegistryService(org.wso2.carbon.registry.core.service.RegistryService registryService)
Setting the registry service.

Parameters:
registryService - the registryService.

findGovernanceArtifacts

public static String[] findGovernanceArtifacts(String mediaType,
                                               org.wso2.carbon.registry.core.Registry registry)
                                        throws org.wso2.carbon.registry.core.exceptions.RegistryException
Query to search for governance artifacts.

Parameters:
mediaType - the media type of the artifacts to be searched for.
registry - the registry instance to run query on.
Returns:
the list of artifact paths.
Throws:
org.wso2.carbon.registry.core.exceptions.RegistryException - if the operation failed.

findGovernanceArtifactConfiguration

public static GovernanceArtifactConfiguration findGovernanceArtifactConfiguration(String key,
                                                                                  org.wso2.carbon.registry.core.Registry registry)
                                                                           throws org.wso2.carbon.registry.core.exceptions.RegistryException
Query to search for a governance artifact configuration.

Parameters:
key - the key of the artifact configuration.
registry - the registry instance to run query on.
Returns:
the artifact configuration.
Throws:
org.wso2.carbon.registry.core.exceptions.RegistryException - if the operation failed.

getResultPaths

public static String[] getResultPaths(org.wso2.carbon.registry.core.Registry registry,
                                      String mediaType)
                               throws GovernanceException
Method to obtain a list of paths having resources of the given media type.

Parameters:
registry - the registry instance to run query on.
mediaType - the media type.
Returns:
an array of resource paths.
Throws:
GovernanceException - if the operation failed.

loadGovernanceArtifacts

public static void loadGovernanceArtifacts(org.wso2.carbon.registry.core.session.UserRegistry registry)
                                    throws org.wso2.carbon.registry.core.exceptions.RegistryException
Method to load the Governance Artifacts to be used by the API operations.

Parameters:
registry - the registry instance used to search for artifacts.
Throws:
org.wso2.carbon.registry.core.exceptions.RegistryException - if the operation failed.

getGovernanceArtifactConfiguration

public static GovernanceArtifactConfiguration getGovernanceArtifactConfiguration(String elementString)

findGovernanceArtifactConfigurations

public static List<GovernanceArtifactConfiguration> findGovernanceArtifactConfigurations(org.wso2.carbon.registry.core.Registry registry)
                                                                                  throws org.wso2.carbon.registry.core.exceptions.RegistryException
Method to locate Governance Artifact configurations.

Parameters:
registry - the registry instance to run query on.
Returns:
an array of resource paths.
Throws:
GovernanceException - if the operation failed.
org.wso2.carbon.registry.core.exceptions.RegistryException

setTenantGovernanceSystemRegistry

public static void setTenantGovernanceSystemRegistry(int tenantId)
                                              throws org.wso2.carbon.registry.core.exceptions.RegistryException
Throws:
org.wso2.carbon.registry.core.exceptions.RegistryException

unsetTenantGovernanceSystemRegistry

public static void unsetTenantGovernanceSystemRegistry()
                                                throws org.wso2.carbon.registry.core.exceptions.RegistryException
Throws:
org.wso2.carbon.registry.core.exceptions.RegistryException

getGovernanceSystemRegistry

public static org.wso2.carbon.registry.core.Registry getGovernanceSystemRegistry(org.wso2.carbon.registry.core.Registry registry)
                                                                          throws org.wso2.carbon.registry.core.exceptions.RegistryException
Returns the system governance registry.

Parameters:
registry - the user registry.
Returns:
the system registry.
Throws:
org.wso2.carbon.registry.core.exceptions.RegistryException - throws if an error occurs

getGovernanceUserRegistry

public static org.wso2.carbon.registry.core.Registry getGovernanceUserRegistry(org.wso2.carbon.registry.core.Registry registry,
                                                                               String username)
                                                                        throws org.wso2.carbon.registry.core.exceptions.RegistryException
Obtains the governance user registry from the given root registry instance. This is useful when creating a governance user registry out of a remote client registry instance.

Parameters:
registry - the remote client registry instance.
username - the name of the user to connect as.
Returns:
the system registry.
Throws:
org.wso2.carbon.registry.core.exceptions.RegistryException - throws if an error occurs

getGovernanceUserRegistry

public static org.wso2.carbon.registry.core.Registry getGovernanceUserRegistry(org.wso2.carbon.registry.core.Registry registry,
                                                                               String username,
                                                                               int tenantId)
                                                                        throws org.wso2.carbon.registry.core.exceptions.RegistryException
Obtains the governance user registry from the given root registry instance. This is useful when creating a tenant aware governance user registry out of a remote client registry instance.

Parameters:
registry - registry the remote client registry instance.
username - username the name of the user to connect as.
tenantId - tenant id
Returns:
the system registry
Throws:
org.wso2.carbon.registry.core.exceptions.RegistryException - throws if an error occurs

removeArtifact

public static void removeArtifact(org.wso2.carbon.registry.core.Registry registry,
                                  String artifactId)
                           throws GovernanceException
Method to remove a governance artifact from the registry.

Parameters:
registry - the registry instance.
artifactId - the identifier of the artifact.
Throws:
GovernanceException - if the operation failed.

getArtifactPath

public static String getArtifactPath(org.wso2.carbon.registry.core.Registry registry,
                                     String artifactId)
                              throws GovernanceException
Method to obtain the artifact path of a governance artifact on the registry.

Parameters:
registry - the registry instance.
artifactId - the identifier of the artifact.
Returns:
the artifact path.
Throws:
GovernanceException - if the operation failed.

getAttributeValue

public static String getAttributeValue(org.apache.axiom.om.OMElement element,
                                       String name,
                                       String namespace)
Method to obtain the value of a governance attribute.

Parameters:
element - the payload element.
name - the attribute name.
namespace - the namespace of the payload element.
Returns:
the value of the attribute by the given name if it exists or an empty string.

getAllArtifactIds

public static String[] getAllArtifactIds(org.wso2.carbon.registry.core.Registry registry)
                                  throws GovernanceException
Method to obtain all indexed governance artifact identifiers on the provided registry instance.

Parameters:
registry - the registry instance.
Returns:
list of governance artifact identifiers.
Throws:
GovernanceException - if the operation failed.

getAllArtifacts

public static GovernanceArtifact[] getAllArtifacts(org.wso2.carbon.registry.core.Registry registry)
                                            throws GovernanceException
Method to obtain all indexed governance artifacts on the provided registry instance.

Parameters:
registry - the registry instance.
Returns:
list of governance artifacts
Throws:
GovernanceException - if the operation failed.

retrieveGovernanceArtifactById

public static GovernanceArtifact retrieveGovernanceArtifactById(org.wso2.carbon.registry.core.Registry registry,
                                                                String artifactId)
                                                         throws GovernanceException
Method to obtain a governance artifact on the registry.

Parameters:
registry - the registry instance.
artifactId - the identifier of the artifact.
Returns:
the artifact.
Throws:
GovernanceException - if the operation failed.

retrieveGovernanceArtifactByPath

public static GovernanceArtifact retrieveGovernanceArtifactByPath(org.wso2.carbon.registry.core.Registry registry,
                                                                  String artifactPath)
                                                           throws GovernanceException
Method to obtain a governance artifact on the registry by the artifact path.

Parameters:
registry - the registry instance.
artifactPath - the path of the artifact.
Returns:
the artifact.
Throws:
GovernanceException - if the operation failed.

buildOMElement

public static org.apache.axiom.om.OMElement buildOMElement(byte[] content)
                                                    throws org.wso2.carbon.registry.core.exceptions.RegistryException
Method to build an AXIOM element from a byte stream.

Parameters:
content - the stream of bytes.
Returns:
the AXIOM element.
Throws:
GovernanceException - if the operation failed.
org.wso2.carbon.registry.core.exceptions.RegistryException

serializeOMElement

public static String serializeOMElement(org.apache.axiom.om.OMElement element)
                                 throws GovernanceException
Method to serialize an XML element into a string.

Parameters:
element - the XML element.
Returns:
the corresponding String representation
Throws:
GovernanceException - if the operation failed.

getPathFromPathExpression

public static String getPathFromPathExpression(String pathExpression,
                                               GovernanceArtifact artifact,
                                               String storagePath)
                                        throws GovernanceException
Method to convert the expression specified for storing the path with corresponding values where the artifact is stored.

Parameters:
pathExpression - the expression specified for storing the path
artifact - the governance artifact
storagePath - the storage path of the artifact
Returns:
the path with corresponding values where the artifact is stored
Throws:
GovernanceException - if the operation failed.

getPathFromPathExpression

public static String getPathFromPathExpression(String pathExpression,
                                               GovernanceArtifact artifact)
                                        throws GovernanceException
Method to convert the expression specified for storing the path with corresponding values where the artifact is stored.

Parameters:
pathExpression - the expression specified for storing the path
artifact - the governance artifact
Returns:
the path with corresponding values where the artifact is stored
Throws:
GovernanceException - if the operation failed.

hasSamePath

public static boolean hasSamePath(String pathExpression,
                                  GovernanceArtifact newArtifact,
                                  GovernanceArtifact oldArtifact)
                           throws GovernanceException
Method to compare the old and new artifact paths

Parameters:
pathExpression - the expression specified for storing the path
newArtifact - updated artifact
oldArtifact - existing artifact
Returns:
whether the paths are same for old artifact and new artifact
Throws:
GovernanceException - if the operation failed.

getPathsFromPathExpression

public static String[] getPathsFromPathExpression(String pathExpression,
                                                  GovernanceArtifact artifact)
                                           throws GovernanceException
Method to convert the expression specified for storing the path with corresponding values where the artifact is stored. This method will return multiple paths.

Parameters:
pathExpression - the expression specified for storing the path
artifact - the governance artifact
Returns:
the paths with corresponding values where the artifact is stored
Throws:
GovernanceException - if the operation failed.

getAvailableAspects

public static String[] getAvailableAspects()
                                    throws org.wso2.carbon.registry.core.exceptions.RegistryException
Method to obtain all available aspects for the given tenant.

Returns:
list of available aspects.
Throws:
org.wso2.carbon.registry.core.exceptions.RegistryException - if the operation failed.

derivePathFromQName

public static String derivePathFromQName(QName qName)
Method to obtain a path from a qualified name.

Parameters:
qName - the qualified name.
Returns:
the corresponding path.

getNameFromUrl

public static String getNameFromUrl(String url)
Obtain a name that can represent a URL.

Parameters:
url - the URL.
Returns:
the name.

evaluateXPathToElements

public static List<org.apache.axiom.om.OMElement> evaluateXPathToElements(String expression,
                                                                          org.apache.axiom.om.OMElement root)
                                                                   throws org.jaxen.JaxenException
Throws:
org.jaxen.JaxenException

associateAspect

public static void associateAspect(String path,
                                   String aspect,
                                   org.wso2.carbon.registry.core.Registry registry)
                            throws org.wso2.carbon.registry.core.exceptions.RegistryException
Method to associate an aspect with a given resource on the registry.

Parameters:
path - the path of the resource.
aspect - the aspect to add.
registry - the registry instance on which the resource is available.
Throws:
org.wso2.carbon.registry.core.exceptions.RegistryException - if the operation failed.

removeAspect

public static void removeAspect(String path,
                                String aspect,
                                org.wso2.carbon.registry.core.Registry registry)
                         throws org.wso2.carbon.registry.core.exceptions.RegistryException
Method to remove an aspect from a given resource on the registry.

Parameters:
path - the path of the resource.
aspect - the aspect to be removed.
registry - the registry instance on which the resource is available.
Throws:
org.wso2.carbon.registry.core.exceptions.RegistryException - if the operation failed.


Copyright © 2012 WSO2 Inc. All Rights Reserved.