org.wso2.carbon.governance.api.common
Class GovernanceArtifactManager

java.lang.Object
  org.wso2.carbon.governance.api.common.GovernanceArtifactManager

public class GovernanceArtifactManager
extends Object

Base Manager Functionality which can be used by any Artifact Manager instance.

Constructor Summary

GovernanceArtifactManager(org.wso2.carbon.registry.core.Registry registry, String mediaType, String artifactNameAttribute, String artifactNamespaceAttribute, String artifactElementRoot, String artifactElementNamespace, String pathExpression, org.wso2.carbon.registry.core.Association[] relationshipDefinitions)
Constructor accepting an instance of the registry, and also details on the type of manager.

Method Summary

void	addGovernanceArtifact(GovernanceArtifact artifact) Adds the given artifact to the registry.
GovernanceArtifact[]	findGovernanceArtifacts(GovernanceArtifactFilter criteria) Finds all artifacts matching the given filter criteria.
String[]	getAllGovernanceArtifactIds() Finds all identifiers of the artifacts on the registry.
GovernanceArtifact[]	getAllGovernanceArtifacts() Finds all artifacts of a given type on the registry.
GovernanceArtifact	getGovernanceArtifact(String artifactId) Fetches the given artifact on the registry.
GovernanceArtifact	newGovernanceArtifact() Creates a new artifact from the given qualified name.
GovernanceArtifact	newGovernanceArtifact(org.apache.axiom.om.OMElement content) Creates a new artifact from the given content.
void	removeGovernanceArtifact(String artifactId) Removes the given artifact from the registry.
protected void	setContent(GovernanceArtifact artifact, org.wso2.carbon.registry.core.Resource resource) Sets content of the given artifact to the given resource on the registry.
void	updateGovernanceArtifact(GovernanceArtifact artifact) Updates the given artifact on the registry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GovernanceArtifactManager

public GovernanceArtifactManager(org.wso2.carbon.registry.core.Registry registry,
                                 String mediaType,
                                 String artifactNameAttribute,
                                 String artifactNamespaceAttribute,
                                 String artifactElementRoot,
                                 String artifactElementNamespace,
                                 String pathExpression,
                                 org.wso2.carbon.registry.core.Association[] relationshipDefinitions)

Constructor accepting an instance of the registry, and also details on the type of manager.

Parameters:

registry - the instance of the registry.

mediaType - the media type of resources being saved or fetched.

artifactNameAttribute - the attribute that specifies the name of the artifact.

artifactNamespaceAttribute - the attribute that specifies the namespace of the artifact.

artifactElementRoot - the attribute that specifies the root artifact element.

artifactElementNamespace - the attribute that specifies the artifact element's namespace.

pathExpression - the expression that can be used to compute where to store the artifact.

relationshipDefinitions - the relationship definitions for the types of associations that will be created when the artifact gets updated.

Method Detail

newGovernanceArtifact

public GovernanceArtifact newGovernanceArtifact()
                                         throws GovernanceException

Creates a new artifact from the given qualified name.

Returns:

the artifact added.

Throws:

GovernanceException - if the operation failed.

newGovernanceArtifact

public GovernanceArtifact newGovernanceArtifact(org.apache.axiom.om.OMElement content)
                                         throws GovernanceException

Creates a new artifact from the given content.

Parameters:

content - the artifact content.

Returns:

the artifact added.

Throws:

GovernanceException - if the operation failed.

addGovernanceArtifact

public void addGovernanceArtifact(GovernanceArtifact artifact)
                           throws GovernanceException

Adds the given artifact to the registry.

Parameters:

artifact - the artifact.

Throws:

GovernanceException - if the operation failed.

updateGovernanceArtifact

public void updateGovernanceArtifact(GovernanceArtifact artifact)
                              throws GovernanceException

Updates the given artifact on the registry.

Parameters:

artifact - the artifact.

Throws:

GovernanceException - if the operation failed.

getGovernanceArtifact

public GovernanceArtifact getGovernanceArtifact(String artifactId)
                                         throws GovernanceException

Fetches the given artifact on the registry.

Parameters:

artifactId - the identifier of the artifact.

Returns:

the artifact.

Throws:

GovernanceException - if the operation failed.

removeGovernanceArtifact

public void removeGovernanceArtifact(String artifactId)
                              throws GovernanceException

Removes the given artifact from the registry.

Parameters:

artifactId - the identifier of the artifact.

Throws:

GovernanceException - if the operation failed.

setContent

protected void setContent(GovernanceArtifact artifact,
                          org.wso2.carbon.registry.core.Resource resource)
                   throws GovernanceException

Sets content of the given artifact to the given resource on the registry.

Parameters:

artifact - the artifact.

resource - the content resource.

Throws:

GovernanceException - if the operation failed.

findGovernanceArtifacts

public GovernanceArtifact[] findGovernanceArtifacts(GovernanceArtifactFilter criteria)
                                             throws GovernanceException

Finds all artifacts matching the given filter criteria.

Parameters:

criteria - the filter criteria to be matched.

Returns:

the artifacts that match.

Throws:

GovernanceException - if the operation failed.

getAllGovernanceArtifacts

public GovernanceArtifact[] getAllGovernanceArtifacts()
                                               throws GovernanceException

Finds all artifacts of a given type on the registry.

Returns:

all artifacts of the given type on the registry.

Throws:

GovernanceException - if the operation failed.

getAllGovernanceArtifactIds

public String[] getAllGovernanceArtifactIds()
                                     throws GovernanceException

Finds all identifiers of the artifacts on the registry.

Returns:

an array of identifiers of the artifacts.

Throws:

GovernanceException - if the operation failed.