org.wso2.carbon.governance.api.generic
Class GenericArtifactManager

java.lang.Object
  org.wso2.carbon.governance.api.generic.GenericArtifactManager

public class GenericArtifactManager
extends Object

Manager class for a generic governance artifact.

Constructor Summary

GenericArtifactManager(org.wso2.carbon.registry.core.Registry registry, String key)
Constructor accepting an instance of the registry, and key identifying the type of manager.

GenericArtifactManager(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	addGenericArtifact(GenericArtifact artifact) Adds the given artifact to the registry.
GenericArtifact[]	findGenericArtifacts(GenericArtifactFilter criteria) Finds all artifacts matching the given filter criteria.
String[]	getAllGenericArtifactIds() Finds all identifiers of the artifacts on the registry.
GenericArtifact[]	getAllGenericArtifacts() Finds all artifacts on the registry.
GenericArtifact	getGenericArtifact(String artifactId) Fetches the given artifact on the registry.
GenericArtifact	newGovernanceArtifact(org.apache.axiom.om.OMElement content) Creates a new artifact from the given content.
GenericArtifact	newGovernanceArtifact(QName qName) Creates a new artifact from the given qualified name.
void	removeGenericArtifact(String artifactId) Removes the given artifact from the registry.
void	updateGenericArtifact(GenericArtifact 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

GenericArtifactManager

public GenericArtifactManager(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.

GenericArtifactManager

public GenericArtifactManager(org.wso2.carbon.registry.core.Registry registry,
                              String key)
                       throws org.wso2.carbon.registry.core.exceptions.RegistryException

Constructor accepting an instance of the registry, and key identifying the type of manager.

Parameters:

registry - the instance of the registry.

key - the key short name of the artifact type.

Throws:

org.wso2.carbon.registry.core.exceptions.RegistryException

Method Detail

newGovernanceArtifact

public GenericArtifact newGovernanceArtifact(QName qName)
                                      throws GovernanceException

Creates a new artifact from the given qualified name.

Parameters:

qName - the qualified name of this artifact.

Returns:

the artifact added.

Throws:

GovernanceException - if the operation failed.

newGovernanceArtifact

public GenericArtifact 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.

addGenericArtifact

public void addGenericArtifact(GenericArtifact artifact)
                        throws GovernanceException

Adds the given artifact to the registry.

Parameters:

artifact - the artifact.

Throws:

GovernanceException - if the operation failed.

updateGenericArtifact

public void updateGenericArtifact(GenericArtifact artifact)
                           throws GovernanceException

Updates the given artifact on the registry.

Parameters:

artifact - the artifact.

Throws:

GovernanceException - if the operation failed.

getGenericArtifact

public GenericArtifact getGenericArtifact(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.

removeGenericArtifact

public void removeGenericArtifact(String artifactId)
                           throws GovernanceException

Removes the given artifact from the registry.

Parameters:

artifactId - the identifier of the artifact.

Throws:

GovernanceException - if the operation failed.

findGenericArtifacts

public GenericArtifact[] findGenericArtifacts(GenericArtifactFilter 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.

getAllGenericArtifacts

public GenericArtifact[] getAllGenericArtifacts()
                                         throws GovernanceException

Finds all artifacts on the registry.

Returns:

all artifacts on the registry.

Throws:

GovernanceException - if the operation failed.

getAllGenericArtifactIds

public String[] getAllGenericArtifactIds()
                                  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.