|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.wso2.carbon.governance.api.util.GovernanceUtils
public class GovernanceUtils
Utilities used by various Governance API related functionality.
Constructor Summary | |
---|---|
GovernanceUtils()
|
Method Summary | |
---|---|
static void |
addGovernanceArtifactEntry(Registry registry,
String artifactId,
String artifactPath)
Method to register a governance artifact. |
static void |
associateAspect(String path,
String aspect,
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,
Registry registry)
Query to search for a governance artifact configuration. |
static List<GovernanceArtifactConfiguration> |
findGovernanceArtifactConfigurations(Registry registry)
Method to locate Governance Artifact configurations. |
static String[] |
findGovernanceArtifacts(String mediaType,
Registry registry)
Query to search for governance artifacts. |
static String[] |
getAllArtifactIds(Registry registry)
Method to obtain all indexed governance artifact identifiers on the provided registry instance. |
static GovernanceArtifact[] |
getAllArtifacts(Registry registry)
Method to obtain all indexed governance artifacts on the provided registry instance. |
static String |
getArtifactPath(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 Registry |
getGovernanceSystemRegistry(Registry registry)
Returns the system governance registry. |
static Registry |
getGovernanceUserRegistry(Registry registry,
String username)
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(Registry registry,
String mediaType)
Method to obtain a list of paths having resources of the given media type. |
static void |
loadGovernanceArtifacts(UserRegistry registry)
Method to load the Governance Artifacts to be used by the API operations. |
static void |
removeArtifact(Registry registry,
String artifactId)
Method to remove a governance artifact from the registry. |
static void |
removeAspect(String path,
String aspect,
Registry registry)
Method to remove an aspect from a given resource on the registry. |
static GovernanceArtifact |
retrieveGovernanceArtifactById(Registry registry,
String artifactId)
Method to obtain a governance artifact on the registry. |
static GovernanceArtifact |
retrieveGovernanceArtifactByPath(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(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 |
---|
public GovernanceUtils()
Method Detail |
---|
public static void setRegistryService(RegistryService registryService)
registryService
- the registryService.public static String[] findGovernanceArtifacts(String mediaType, Registry registry) throws RegistryException
mediaType
- the media type of the artifacts to be searched for.registry
- the registry instance to run query on.
RegistryException
- if the operation failed.public static GovernanceArtifactConfiguration findGovernanceArtifactConfiguration(String key, Registry registry) throws RegistryException
key
- the key of the artifact configuration.registry
- the registry instance to run query on.
RegistryException
- if the operation failed.public static String[] getResultPaths(Registry registry, String mediaType) throws GovernanceException
registry
- the registry instance to run query on.mediaType
- the media type.
GovernanceException
- if the operation failed.public static void loadGovernanceArtifacts(UserRegistry registry) throws RegistryException
registry
- the registry instance used to search for artifacts.
RegistryException
- if the operation failed.public static List<GovernanceArtifactConfiguration> findGovernanceArtifactConfigurations(Registry registry) throws RegistryException
registry
- the registry instance to run query on.
GovernanceException
- if the operation failed.
RegistryException
public static void setTenantGovernanceSystemRegistry(int tenantId) throws RegistryException
RegistryException
public static void unsetTenantGovernanceSystemRegistry() throws RegistryException
RegistryException
public static Registry getGovernanceSystemRegistry(Registry registry) throws RegistryException
registry
- the user registry.
RegistryException
- throws if an error occurspublic static Registry getGovernanceUserRegistry(Registry registry, String username) throws RegistryException
registry
- the remote client registry instance.username
- the name of the user to connect as.
RegistryException
- throws if an error occurspublic static void removeArtifact(Registry registry, String artifactId) throws GovernanceException
registry
- the registry instance.artifactId
- the identifier of the artifact.
GovernanceException
- if the operation failed.public static String getArtifactPath(Registry registry, String artifactId) throws GovernanceException
registry
- the registry instance.artifactId
- the identifier of the artifact.
GovernanceException
- if the operation failed.public static String getAttributeValue(org.apache.axiom.om.OMElement element, String name, String namespace)
element
- the payload element.name
- the attribute name.namespace
- the namespace of the payload element.
public static String[] getAllArtifactIds(Registry registry) throws GovernanceException
registry
- the registry instance.
GovernanceException
- if the operation failed.public static GovernanceArtifact[] getAllArtifacts(Registry registry) throws GovernanceException
registry
- the registry instance.
GovernanceException
- if the operation failed.public static GovernanceArtifact retrieveGovernanceArtifactById(Registry registry, String artifactId) throws GovernanceException
registry
- the registry instance.artifactId
- the identifier of the artifact.
GovernanceException
- if the operation failed.public static GovernanceArtifact retrieveGovernanceArtifactByPath(Registry registry, String artifactPath) throws GovernanceException
registry
- the registry instance.artifactPath
- the path of the artifact.
GovernanceException
- if the operation failed.public static void addGovernanceArtifactEntry(Registry registry, String artifactId, String artifactPath) throws GovernanceException
registry
- the registry instance.artifactId
- the identifier of the artifact.artifactPath
- the path of the artifact.
GovernanceException
- if the operation failed.public static org.apache.axiom.om.OMElement buildOMElement(byte[] content) throws GovernanceException
content
- the stream of bytes.
GovernanceException
- if the operation failed.public static String serializeOMElement(org.apache.axiom.om.OMElement element) throws GovernanceException
element
- the XML element.
GovernanceException
- if the operation failed.public static String getPathFromPathExpression(String pathExpression, GovernanceArtifact artifact, String storagePath) throws GovernanceException
pathExpression
- the expression specified for storing the pathartifact
- the governance artifactstoragePath
- the storage path of the artifact
GovernanceException
- if the operation failed.public static String getPathFromPathExpression(String pathExpression, GovernanceArtifact artifact) throws GovernanceException
pathExpression
- the expression specified for storing the pathartifact
- the governance artifact
GovernanceException
- if the operation failed.public static String[] getPathsFromPathExpression(String pathExpression, GovernanceArtifact artifact) throws GovernanceException
pathExpression
- the expression specified for storing the pathartifact
- the governance artifact
GovernanceException
- if the operation failed.public static String[] getAvailableAspects() throws RegistryException
RegistryException
- if the operation failed.public static String derivePathFromQName(QName qName)
qName
- the qualified name.
public static String getNameFromUrl(String url)
url
- the URL.
public static List<org.apache.axiom.om.OMElement> evaluateXPathToElements(String expression, org.apache.axiom.om.OMElement root) throws org.jaxen.JaxenException
org.jaxen.JaxenException
public static void associateAspect(String path, String aspect, Registry registry) throws RegistryException
path
- the path of the resource.aspect
- the aspect to add.registry
- the registry instance on which the resource is available.
RegistryException
- if the operation failed.public static void removeAspect(String path, String aspect, Registry registry) throws RegistryException
path
- the path of the resource.aspect
- the aspect to be removed.registry
- the registry instance on which the resource is available.
RegistryException
- if the operation failed.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |