org.odpi.openmetadata.accessservices.securityofficer.client

Interface GovernedAssetInterface

All Known Implementing Classes:

GovernedAssetClient

public interface GovernedAssetInterface

The Security Officer Open Metadata Access Service (OMAS) is used by enforcement engines to retrieve asset and classification information in a suitable form for implementing policies

This OMAS is mostly concerned with: - A Classification Definition - this tells us what the classification type is, what parms it may have - and can be useful for authoring and validation - An asset , or part (hence we call it an asset component) that has a classification

Furthermore in order to scope queries we restrict by - root classification - the node in the classification tree of where we are interested (for example all governance classifications) - root type - the base type that we are interested in

Method Summary

Modifier and Type	Method and Description
String	createSoftwareServerCapability(String userId, SoftwareServerCapabilityRequestBody softwareServerCapability) Create a Software Server Capability entity
GovernedAsset	getGovernedAsset(String userId, String assetGuid)
List<GovernedAsset>	getGovernedAssetList(String userId, String classification, List<String> entityTypes, Integer offset, Integer pageSize) Returns a list of the entities filtered by types that have the searched governed classification.
SoftwareServerCapability	getSoftwareServerCapabilityByGUID(String userId, String guid) Returns the Software Server Capability entity by global identifier

Method Detail

getGovernedAssetList

List<GovernedAsset> getGovernedAssetList(String userId,
                                         String classification,
                                         List<String> entityTypes,
                                         Integer offset,
                                         Integer pageSize)
                                  throws UserNotAuthorizedException,
                                         PropertyServerException,
                                         InvalidParameterException

Returns a list of the entities filtered by types that have the searched governed classification.

Parameters:

userId - - userId of user making request.

classification - - name of base classification type (can be null)

entityTypes - - String - root type of asset (can be null)

offset - - offset of full collection to begin the return results

pageSize - - limit the number of the results returned

Returns:

a list of the governed entities that have the Governed Classification Searched.

Throws:

UserNotAuthorizedException - - the requesting user is not authorized to issue this request.

PropertyServerException - - there is a problem retrieving information from the property server(s).

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

getGovernedAsset

GovernedAsset getGovernedAsset(String userId,
                               String assetGuid)
                        throws UserNotAuthorizedException,
                               PropertyServerException,
                               InvalidParameterException

Parameters:

userId - - String - userId of user making request.

assetGuid - - String - guid of asset component

Returns:

the the entity if this has a governed classification assigned

Throws:

UserNotAuthorizedException - - the requesting user is not authorized to issue this request.

PropertyServerException - - there is a problem retrieving information from the property server(s).

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

createSoftwareServerCapability

String createSoftwareServerCapability(String userId,
                                      SoftwareServerCapabilityRequestBody softwareServerCapability)
                               throws UserNotAuthorizedException,
                                      PropertyServerException,
                                      InvalidParameterException

Create a Software Server Capability entity

Parameters:

userId - - String - userId of user making request.

softwareServerCapability - - SoftwareServerCapabilityRequestBody

Returns:

the GUID of the Software Server entity created

Throws:

UserNotAuthorizedException - - the requesting user is not authorized to issue this request.

PropertyServerException - - there is a problem retrieving information from the property server(s).

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

getSoftwareServerCapabilityByGUID

SoftwareServerCapability getSoftwareServerCapabilityByGUID(String userId,
                                                           String guid)
                                                    throws UserNotAuthorizedException,
                                                           PropertyServerException,
                                                           InvalidParameterException

Returns the Software Server Capability entity by global identifier

Parameters:

userId - - the name of the calling user

guid - - guid of the software server

Returns:

the Software Server Capability entity associated with the provided GUID

Throws:

UserNotAuthorizedException - - the requesting user is not authorized to issue this request.

PropertyServerException - - there is a problem retrieving information from the property server(s).

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