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

Interface SoftwareServerCapabilityManagerInterface

All Known Implementing Classes:

CapabilityManagerClient

public interface SoftwareServerCapabilityManagerInterface

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

Method Summary

Modifier and Type	Method	Description
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.
List<SoftwareServerCapabilityElement>	findSoftwareServerCapabilities(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize)	Deprecated.
List<SoftwareServerCapabilityElement>	getSoftwareServerCapabilitiesByName(String userId, String name, Date effectiveTime, int startFrom, int pageSize)	Deprecated.
SoftwareServerCapabilityElement	getSoftwareServerCapabilityByGUID(String userId, String guid)	Deprecated.
void	removeSoftwareServerCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String capabilityGUID)	Deprecated.
void	updateSoftwareServerCapability(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String capabilityGUID, boolean isMergeUpdate, SoftwareServerCapabilityProperties capabilityProperties)	Deprecated.

Method Details

createSoftwareServerCapability

@Deprecated
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.

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

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

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
void removeSoftwareServerCapability(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String capabilityGUID)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Deprecated.

Remove the metadata element representing a software server capability.

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

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

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
SoftwareServerCapabilityElement getSoftwareServerCapabilityByGUID(String userId,
 String guid)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Deprecated.

Retrieve the software server 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)