Package org.odpi.openmetadata.accessservices.itinfrastructure.api

Interface SoftwareCapabilityManagerInterface

All Known Implementing Classes:

CapabilityManagerClient

public interface SoftwareCapabilityManagerInterface

SoftwareCapabilityManagerInterface defines the client side interface for the IT Infrastructure OMAS that is relevant for cataloguing software capabilities. It provides the ability to define and maintain the metadata about a software capability and the assets it interacts with.

Method Summary

Modifier and Type	Method	Description
String	createServerAssetUse(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String capabilityGUID, String assetGUID, ServerAssetUseProperties properties)	Create a new metadata relationship to represent the use of an asset by a software capability.
String	createSoftwareCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String classificationName, SoftwareCapabilityProperties capabilityProperties)	Create a new metadata element to represent a software capability.
String	createSoftwareCapabilityFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a software capability using an existing metadata element as a template.
void	deployCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String capabilityGUID, String infrastructureAssetGUID, CapabilityDeploymentProperties properties)	Link a software capability to a software server.
List<SoftwareCapabilityElement>	findSoftwareCapabilities(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of software capability metadata elements that contain the search string.
List<ServerAssetUseElement>	getCapabilityUsesForAsset(String userId, String assetGUID, ServerAssetUseType useType, Date effectiveTime, int startFrom, int pageSize)	Return the list of software server capabilities that make use of a specific asset.
List<SoftwareCapabilityElement>	getDeployedSoftwareCapabilities(String userId, String itAssetGUID, Date effectiveTime, int startFrom, int pageSize)	Retrieve the software capabilities that are deployed to an IT asset.
ServerAssetUseElement	getServerAssetUseByGUID(String userId, String guid)	Retrieve the server asset use type relationship with the supplied unique identifier.
List<ServerAssetUseElement>	getServerAssetUsesForCapability(String userId, String capabilityGUID, ServerAssetUseType useType, Date effectiveTime, int startFrom, int pageSize)	Return the list of server asset use relationships associated with a software capability.
List<ServerAssetUseElement>	getServerAssetUsesForElements(String userId, String capabilityGUID, String assetGUID, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of relationships between a specific software capability and a specific asset.
List<SoftwareCapabilityElement>	getSoftwareCapabilitiesByName(String userId, String name, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of software capability metadata elements with a matching qualified or display name.
List<SoftwareCapabilityElement>	getSoftwareCapabilitiesForInfrastructureManager(String userId, String infrastructureManagerGUID, String infrastructureManagerName, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of capabilities created by this caller.
SoftwareCapabilityElement	getSoftwareCapabilityByGUID(String userId, String guid)	Retrieve the software capability metadata element with the supplied unique identifier.
List<RelatedAssetElement>	getSoftwareCapabilityDeployments(String userId, String guid, Date effectiveTime, int startFrom, int pageSize)	Retrieve the IT asset metadata elements where the software with the supplied unique identifier is deployed.
void	removeCapabilityDeployment(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String itAssetGUID, String capabilityGUID, Date effectiveTime)	Remove the link between a software server capability and a software server.
void	removeServerAssetUse(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String serverAssetUseGUID)	Remove the metadata relationship to represent the use of an asset by a software capability.
void	removeSoftwareCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String capabilityGUID)	Remove the metadata element representing a software capability.
void	updateCapabilityDeployment(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String deploymentGUID, boolean isMergeUpdate, CapabilityDeploymentProperties properties)	Update the properties of a server capability's deployment.
void	updateServerAssetUse(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String serverAssetUseGUID, boolean isMergeUpdate, ServerAssetUseProperties properties)	Update the metadata relationship to represent the use of an asset by a software capability.
void	updateSoftwareCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String capabilityGUID, boolean isMergeUpdate, SoftwareCapabilityProperties capabilityProperties)	Update the metadata element representing a software capability.

Method Details

createSoftwareCapability

String createSoftwareCapability(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 String classificationName,
 SoftwareCapabilityProperties capabilityProperties)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a software capability.

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software capability representing the caller

infrastructureManagerName - unique name of software capability representing the caller

infrastructureManagerIsHome - should the software capability be marked as owned by the infrastructure manager so others can not update?

classificationName - optional classification name that refines the type of the software capability.

capabilityProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createSoftwareCapabilityFromTemplate

String createSoftwareCapabilityFromTemplate(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 String templateGUID,
 TemplateProperties templateProperties)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a software capability using an existing metadata element as a template.

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software capability representing the caller

infrastructureManagerName - unique name of software capability representing the caller

infrastructureManagerIsHome - should the software capability be marked as owned by the infrastructure manager so others can not update?

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateSoftwareCapability

void updateSoftwareCapability(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String capabilityGUID,
 boolean isMergeUpdate,
 SoftwareCapabilityProperties capabilityProperties)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a software capability.

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software capability representing the caller

infrastructureManagerName - unique name of software capability representing the caller

capabilityGUID - unique identifier of the metadata element to update

isMergeUpdate - are unspecified properties unchanged (true) or removed?

capabilityProperties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

deployCapability

void deployCapability(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 String capabilityGUID,
 String infrastructureAssetGUID,
 CapabilityDeploymentProperties properties)
               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Link a software capability to a software server.

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

infrastructureManagerIsHome - should the software server capability be marked as owned by the infrastructure manager so others can not update?

capabilityGUID - unique identifier of the software server capability

infrastructureAssetGUID - unique identifier of the software server

properties - describes the deployment of the capability onto the server

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateCapabilityDeployment

void updateCapabilityDeployment(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String deploymentGUID,
 boolean isMergeUpdate,
 CapabilityDeploymentProperties properties)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the properties of a server capability's deployment.

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

deploymentGUID - unique identifier of the relationship

isMergeUpdate - are unspecified properties unchanged (true) or removed?

properties - describes the deployment of the capability onto the server

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeCapabilityDeployment

void removeCapabilityDeployment(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String itAssetGUID,
 String capabilityGUID,
 Date effectiveTime)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the link between a software server capability and a software server.

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

itAssetGUID - unique identifier of the software server/platform/host

capabilityGUID - unique identifier of the software server capability

effectiveTime - time that the relationship is effective

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeSoftwareCapability

void removeSoftwareCapability(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String capabilityGUID)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a software capability.

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software capability representing the caller

infrastructureManagerName - unique name of software capability representing the caller

capabilityGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findSoftwareCapabilities

List<SoftwareCapabilityElement> findSoftwareCapabilities(String userId,
 String searchString,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of software capability metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSoftwareCapabilitiesByName

List<SoftwareCapabilityElement> getSoftwareCapabilitiesByName(String userId,
 String name,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of software capability metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSoftwareCapabilityDeployments

List<RelatedAssetElement> getSoftwareCapabilityDeployments(String userId,
 String guid,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the IT asset metadata elements where the software with the supplied unique identifier is deployed.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of related IT Assets

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDeployedSoftwareCapabilities

List<SoftwareCapabilityElement> getDeployedSoftwareCapabilities(String userId,
 String itAssetGUID,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the software capabilities that are deployed to an IT asset.

Parameters:

userId - calling user

itAssetGUID - unique identifier of the hosting metadata element

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of related IT Assets

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSoftwareCapabilitiesForInfrastructureManager

List<SoftwareCapabilityElement> getSoftwareCapabilitiesForInfrastructureManager(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of capabilities created by this caller.

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSoftwareCapabilityByGUID

SoftwareCapabilityElement getSoftwareCapabilityByGUID(String userId,
 String guid)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the software capability metadata element with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createServerAssetUse

String createServerAssetUse(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 String capabilityGUID,
 String assetGUID,
 ServerAssetUseProperties properties)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata relationship to represent the use of an asset by a software capability.

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software capability representing the caller

infrastructureManagerName - unique name of software capability representing the caller

infrastructureManagerIsHome - should the software capability be marked as owned by the infrastructure manager so others can not update?

capabilityGUID - unique identifier of a software capability

assetGUID - unique identifier of an asset

properties - properties about the ServerAssetUse relationship

Returns:

unique identifier of the new ServerAssetUse relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateServerAssetUse

void updateServerAssetUse(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String serverAssetUseGUID,
 boolean isMergeUpdate,
 ServerAssetUseProperties properties)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata relationship to represent the use of an asset by a software capability.

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software capability representing the caller

infrastructureManagerName - unique name of software capability representing the caller

serverAssetUseGUID - unique identifier of the relationship between a software capability and an asset

isMergeUpdate - are unspecified properties unchanged (true) or removed?

properties - new properties for the ServerAssetUse relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeServerAssetUse

void removeServerAssetUse(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String serverAssetUseGUID)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata relationship to represent the use of an asset by a software capability.

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software capability representing the caller

infrastructureManagerName - unique name of software capability representing the caller

serverAssetUseGUID - unique identifier of the relationship between a software capability and an asset

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getServerAssetUsesForCapability

List<ServerAssetUseElement> getServerAssetUsesForCapability(String userId,
 String capabilityGUID,
 ServerAssetUseType useType,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of server asset use relationships associated with a software capability.

Parameters:

userId - calling user

capabilityGUID - unique identifier of the software capability to query

useType - value to search for. Null means all use types.

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching relationships

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getCapabilityUsesForAsset

List<ServerAssetUseElement> getCapabilityUsesForAsset(String userId,
 String assetGUID,
 ServerAssetUseType useType,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of software server capabilities that make use of a specific asset.

Parameters:

userId - calling user

assetGUID - unique identifier of the asset to query

useType - Optionally restrict the search to a specific user type. Null means all use types.

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching relationships

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getServerAssetUsesForElements

List<ServerAssetUseElement> getServerAssetUsesForElements(String userId,
 String capabilityGUID,
 String assetGUID,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of relationships between a specific software capability and a specific asset.

Parameters:

userId - calling user

capabilityGUID - unique identifier of a software capability

assetGUID - unique identifier of an asset

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching relationships

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getServerAssetUseByGUID

ServerAssetUseElement getServerAssetUseByGUID(String userId,
 String guid)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the server asset use type relationship with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

requested relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)