Package org.odpi.openmetadata.accessservices.itinfrastructure.client

Class CapabilityManagerClient

java.lang.Object

org.odpi.openmetadata.accessservices.itinfrastructure.client.ITInfrastructureClientBase

org.odpi.openmetadata.accessservices.itinfrastructure.client.CapabilityManagerClient

All Implemented Interfaces:

DeploymentManagementInterface, ServerPurposeManagerInterface, SoftwareCapabilityManagerInterface, SoftwareServerCapabilityManagerInterface

public class CapabilityManagerClient
extends ITInfrastructureClientBase
implements SoftwareCapabilityManagerInterface, SoftwareServerCapabilityManagerInterface

CapabilityManagerClient supports the APIs to maintain software server capabilities and their related objects.

Constructor Summary

Constructors

Constructor	Description
CapabilityManagerClient(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
CapabilityManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
CapabilityManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
CapabilityManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize)	Create a new client that is going to be used in an OMAG Server.
CapabilityManagerClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.

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 server capability.
String	createSoftwareCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String classificationName, SoftwareCapabilityProperties capabilityProperties)	Create a new metadata element to represent a software server 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.
String	createSoftwareServerCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String classificationName, SoftwareServerCapabilityProperties capabilityProperties)	Deprecated.
String	createSoftwareServerCapabilityFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String templateGUID, TemplateProperties templateProperties)	Deprecated.
void	deployCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String capabilityGUID, String infrastructureAssetGUID, CapabilityDeploymentProperties deploymentProperties)	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<SoftwareServerCapabilityElement>	findSoftwareServerCapabilities(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize)	Deprecated.
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 server 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 server 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.
List<SoftwareServerCapabilityElement>	getSoftwareServerCapabilitiesByName(String userId, String name, Date effectiveTime, int startFrom, int pageSize)	Deprecated.
SoftwareServerCapabilityElement	getSoftwareServerCapabilityByGUID(String userId, String guid)	Deprecated.
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 server capability.
void	removeSoftwareCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String capabilityGUID)	Remove the metadata element representing a software capability.
void	removeSoftwareServerCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String capabilityGUID)	Deprecated.
void	updateCapabilityDeployment(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String deploymentGUID, boolean isMergeUpdate, CapabilityDeploymentProperties deploymentProperties)	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 server capability.
void	updateSoftwareCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String capabilityGUID, boolean isMergeUpdate, SoftwareCapabilityProperties capabilityProperties)	Update the metadata element representing a software capability.
void	updateSoftwareServerCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String capabilityGUID, boolean isMergeUpdate, SoftwareServerCapabilityProperties capabilityProperties)	Deprecated.

Methods inherited from class org.odpi.openmetadata.accessservices.itinfrastructure.client.ITInfrastructureClientBase

addServerPurpose, clearDeployment, clearServerPurpose, deployITAsset, getDeployedITAssets, getDeploymentDestinations, updateITAssetDeployment, updateServerPurpose

Methods inherited from class java.lang.Object

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

Constructor Details

CapabilityManagerClient

public CapabilityManagerClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog,
 int maxPageSize)
                        throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

CapabilityManagerClient

public CapabilityManagerClient(String serverName,
 String serverPlatformURLRoot,
 int maxPageSize)
                        throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

CapabilityManagerClient

public CapabilityManagerClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 int maxPageSize)
                        throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

CapabilityManagerClient

public CapabilityManagerClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog,
 int maxPageSize)
                        throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - maximum value allowed for page size

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

CapabilityManagerClient

public CapabilityManagerClient(String serverName,
 String serverPlatformURLRoot,
 ITInfrastructureRESTClient restClient,
 int maxPageSize)
                        throws InvalidParameterException

Create a new client that is going to be used in an OMAG Server.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

restClient - client that issues the REST API calls

maxPageSize - maximum number of results supported by this server

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

createSoftwareServerCapability

@Deprecated
public String createSoftwareServerCapability(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 String classificationName,
 SoftwareServerCapabilityProperties capabilityProperties)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Deprecated.

Create a new metadata element to represent a software server capability.

Specified by:

createSoftwareServerCapability in interface SoftwareServerCapabilityManagerInterface

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?

classificationName - optional classification name that refines the type of the software server 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)

createSoftwareServerCapabilityFromTemplate

@Deprecated
public String createSoftwareServerCapabilityFromTemplate(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 String templateGUID,
 TemplateProperties templateProperties)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Deprecated.

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

Specified by:

createSoftwareServerCapabilityFromTemplate in interface SoftwareServerCapabilityManagerInterface

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?

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)

updateSoftwareServerCapability

@Deprecated
public void updateSoftwareServerCapability(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String capabilityGUID,
 boolean isMergeUpdate,
 SoftwareServerCapabilityProperties capabilityProperties)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Deprecated.

Update the metadata element representing a software server capability.

Specified by:

updateSoftwareServerCapability in interface SoftwareServerCapabilityManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server 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)

removeSoftwareServerCapability

@Deprecated
public void removeSoftwareServerCapability(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String capabilityGUID)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Deprecated.

Remove the metadata element representing a software server capability.

Specified by:

removeSoftwareServerCapability in interface SoftwareServerCapabilityManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server 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)

findSoftwareServerCapabilities

@Deprecated
public List<SoftwareServerCapabilityElement> findSoftwareServerCapabilities(String userId,
 String searchString,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Deprecated.

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

Specified by:

findSoftwareServerCapabilities in interface SoftwareServerCapabilityManagerInterface

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)

getSoftwareServerCapabilitiesByName

@Deprecated
public List<SoftwareServerCapabilityElement> getSoftwareServerCapabilitiesByName(String userId,
 String name,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Deprecated.

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

Specified by:

getSoftwareServerCapabilitiesByName in interface SoftwareServerCapabilityManagerInterface

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)

getSoftwareServerCapabilityByGUID

@Deprecated
public SoftwareServerCapabilityElement getSoftwareServerCapabilityByGUID(String userId,
 String guid)
                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Deprecated.

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

Specified by:

getSoftwareServerCapabilityByGUID in interface SoftwareServerCapabilityManagerInterface

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)

createSoftwareCapability

public 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 server capability.

Specified by:

createSoftwareCapability in interface SoftwareCapabilityManagerInterface

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?

classificationName - optional classification name that refines the type of the software server 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

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

Specified by:

createSoftwareCapabilityFromTemplate in interface SoftwareCapabilityManagerInterface

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?

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

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

Specified by:

updateSoftwareCapability in interface SoftwareCapabilityManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server 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

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

Link a software capability to a software server.

Specified by:

deployCapability in interface SoftwareCapabilityManagerInterface

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

deploymentProperties - 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

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

Update the properties of a server capability's deployment.

Specified by:

updateCapabilityDeployment in interface SoftwareCapabilityManagerInterface

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

deploymentProperties - describes the deployment of the capability onto the server

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

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeCapabilityDeployment

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

Specified by:

removeCapabilityDeployment in interface SoftwareCapabilityManagerInterface

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

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

Remove the metadata element representing a software capability.

Specified by:

removeSoftwareCapability in interface SoftwareCapabilityManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server 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

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

Specified by:

findSoftwareCapabilities in interface SoftwareCapabilityManagerInterface

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

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

Specified by:

getSoftwareCapabilitiesByName in interface SoftwareCapabilityManagerInterface

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

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

Specified by:

getSoftwareCapabilityDeployments in interface SoftwareCapabilityManagerInterface

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

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

Specified by:

getDeployedSoftwareCapabilities in interface SoftwareCapabilityManagerInterface

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

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

Specified by:

getSoftwareCapabilitiesForInfrastructureManager in interface SoftwareCapabilityManagerInterface

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

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

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

Specified by:

getSoftwareCapabilityByGUID in interface SoftwareCapabilityManagerInterface

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

public 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 server capability.

Specified by:

createServerAssetUse in interface SoftwareCapabilityManagerInterface

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 a software server 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

public 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 server capability.

Specified by:

updateServerAssetUse in interface SoftwareCapabilityManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

serverAssetUseGUID - unique identifier of the relationship between a software server 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

public 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 server capability.

Specified by:

removeServerAssetUse in interface SoftwareCapabilityManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

serverAssetUseGUID - unique identifier of the relationship between a software server 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

public 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 server capability.

Specified by:

getServerAssetUsesForCapability in interface SoftwareCapabilityManagerInterface

Parameters:

userId - calling user

capabilityGUID - unique identifier of the software server capability to query

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

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective time for the query

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

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

Specified by:

getCapabilityUsesForAsset in interface SoftwareCapabilityManagerInterface

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

public 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 server capability and a specific asset.

Specified by:

getServerAssetUsesForElements in interface SoftwareCapabilityManagerInterface

Parameters:

userId - calling user

capabilityGUID - unique identifier of a software server 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

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

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

Specified by:

getServerAssetUseByGUID in interface SoftwareCapabilityManagerInterface

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)