org.odpi.openmetadata.accessservices.governanceengine.client

Class GovernanceEngine

java.lang.Object

org.odpi.openmetadata.accessservices.governanceengine.client.GovernanceEngine

All Implemented Interfaces:

GovernanceEngineInterface

public class GovernanceEngine
extends Object
implements GovernanceEngineInterface

The Governance Engine Open Metadata Access Service (OMAS) provides an interface to support a policy engine such as Apache Ranger. See interface definition for more explanation

Constructor Summary

Constructors

Constructor and Description
GovernanceEngine(String serverName, String newServerURL) Create a new GovernanceEngine client.

Method Summary

Modifier and Type	Method and Description
SoftwareServerCapability	createSoftwareServerCapability(String userId, SoftwareServerCapability softwareServerCapability) Create a Software Server Capability entity
GovernedAsset	getGovernedAsset(String userId, String assetGuid)
List<GovernedAsset>	getGovernedAssetList(String userId, String classification, String type)
SoftwareServerCapability	getSoftwareServerCapabilityByGUID(String userId, String guid) Fetch the Software Server Capability entity by global identifier

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceEngine

public GovernanceEngine(String serverName,
                        String newServerURL)

Create a new GovernanceEngine client.

Parameters:

serverName - - the network address of the process running the OMAS REST servers

newServerURL - - the network address of the process running the OMAS REST servers

Method Detail

getGovernedAssetList

public List<GovernedAsset> getGovernedAssetList(String userId,
                                                String classification,
                                                String type)
                                         throws InvalidParameterException

Specified by:

getGovernedAssetList in interface GovernanceEngineInterface

Parameters:

userId - - String - userId of user making request.

classification - - String - name of base classification type

type - - String - root asset type

Returns:

governedAssetList - map of classification

Throws:

InvalidParameterException - - one of the parameters is null or invalid.

getGovernedAsset

public GovernedAsset getGovernedAsset(String userId,
                                      String assetGuid)
                               throws InvalidParameterException

Specified by:

getGovernedAsset in interface GovernanceEngineInterface

Parameters:

userId - - String - userId of user making request.

assetGuid - - String - guid of asset component

Returns:

AssetTagMap - map of classification

Throws:

InvalidParameterException - - one of the parameters is null or invalid

createSoftwareServerCapability

public SoftwareServerCapability createSoftwareServerCapability(String userId,
                                                               SoftwareServerCapability softwareServerCapability)
                                                        throws InvalidParameterException

Create a Software Server Capability entity

Specified by:

createSoftwareServerCapability in interface GovernanceEngineInterface

Parameters:

userId - - String - userId of user making request.

softwareServerCapability - - SoftwareServerCapabilityRequestBody

Returns:

the Software Server entity created

Throws:

InvalidParameterException

getSoftwareServerCapabilityByGUID

public SoftwareServerCapability getSoftwareServerCapabilityByGUID(String userId,
                                                                  String guid)
                                                           throws InvalidParameterException

Fetch the Software Server Capability entity by global identifier

Specified by:

getSoftwareServerCapabilityByGUID in interface GovernanceEngineInterface

Parameters:

userId - the name of the calling user

guid - guid of the software server

Returns:

unique identifier of the created process

Throws:

InvalidParameterException