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

Interface SoftwareServerPlatformManagerInterface

public interface SoftwareServerPlatformManagerInterface

SoftwareServerPlatformManagerInterface defines the client side interface for the IT Infrastructure OMAS that is relevant for software server platform assets. It provides the ability to define and maintain the metadata about a platform and relationships between platforms and hosts.

Method Summary

Modifier and Type	Method	Description
String	createSoftwareServerPlatform(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, SoftwareServerPlatformProperties platformProperties)	Create a new metadata element to represent a platform.
String	createSoftwareServerPlatformFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a platform using an existing metadata element as a template.
List<SoftwareServerPlatformElement>	findSoftwareServerPlatforms(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of platform metadata elements that contain the search string.
SoftwareServerPlatformElement	getSoftwareServerPlatformByGUID(String userId, String guid)	Retrieve the platform metadata element with the supplied unique identifier.
List<SoftwareServerPlatformElement>	getSoftwareServerPlatformsByName(String userId, String name, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of platform metadata elements with a matching qualified or display name.
List<SoftwareServerPlatformElement>	getSoftwareServerPlatformsForInfrastructureManager(String userId, String infrastructureManagerGUID, String infrastructureManagerName, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of platforms created by this caller.
void	publishSoftwareServerPlatform(String userId, String platformGUID)	Update the zones for the platform asset so that it becomes visible to consumers.
void	removeSoftwareServerPlatform(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String platformGUID)	Remove the metadata element representing a platform.
void	updateSoftwareServerPlatform(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String platformGUID, boolean isMergeUpdate, SoftwareServerPlatformProperties platformProperties)	Update the metadata element representing a platform.
void	withdrawSoftwareServerPlatform(String userId, String platformGUID)	Update the zones for the platform asset so that it is no longer visible to consumers.

Method Details

createSoftwareServerPlatform

String createSoftwareServerPlatform(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 SoftwareServerPlatformProperties platformProperties)
                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Create a new metadata element to represent a platform.

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

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

platformProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

createSoftwareServerPlatformFromTemplate

String createSoftwareServerPlatformFromTemplate(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 String templateGUID,
 TemplateProperties templateProperties)
                                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

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

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

infrastructureManagerIsHome - should the platform 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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

updateSoftwareServerPlatform

void updateSoftwareServerPlatform(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String platformGUID,
 boolean isMergeUpdate,
 SoftwareServerPlatformProperties platformProperties)
                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update the metadata element representing a platform.

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

platformGUID - unique identifier of the metadata element to update

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

platformProperties - new properties for this element

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

publishSoftwareServerPlatform

void publishSoftwareServerPlatform(String userId,
 String platformGUID)
                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update the zones for the platform asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the IT Infrastructure OMAS).

Parameters:

userId - calling user

platformGUID - unique identifier of the metadata element to publish

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawSoftwareServerPlatform

void withdrawSoftwareServerPlatform(String userId,
 String platformGUID)
                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update the zones for the platform asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the IT Infrastructure OMAS. This is the setting when the platform is first created).

Parameters:

userId - calling user

platformGUID - unique identifier of the metadata element to withdraw

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

removeSoftwareServerPlatform

void removeSoftwareServerPlatform(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String platformGUID)
                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Remove the metadata element representing a platform.

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

platformGUID - unique identifier of the metadata element to remove

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

findSoftwareServerPlatforms

List<SoftwareServerPlatformElement> findSoftwareServerPlatforms(String userId,
 String searchString,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the list of platform 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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

getSoftwareServerPlatformsByName

List<SoftwareServerPlatformElement> getSoftwareServerPlatformsByName(String userId,
 String name,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the list of platform 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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

getSoftwareServerPlatformsForInfrastructureManager

List<SoftwareServerPlatformElement> getSoftwareServerPlatformsForInfrastructureManager(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the list of platforms 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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

getSoftwareServerPlatformByGUID

SoftwareServerPlatformElement getSoftwareServerPlatformByGUID(String userId,
 String guid)
                                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the platform metadata element with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)