Package org.odpi.openmetadata.frameworks.openmetadata.connectorcontext

Class OperatingPlatformClient

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.ConnectorContextClientBase

org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.OperatingPlatformClient

public class OperatingPlatformClient
extends ConnectorContextClientBase

Provides services for connectors to work with operating platforms and the software packages they depend on.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.ConnectorContextClientBase

asOfTimeDefault, auditLog, connectorGUID, connectorUserId, egeriaRelease, externalSourceGUID, externalSourceIsHome, externalSourceName, forDuplicateProcessing, forLineage, governanceZonesFilterDefault, limitResultsByStatusDefault, localServerName, localServiceName, maxPageSize, parentContext, propertyHelper, sequencingOrderDefault, sequencingPropertyDefault, useCurrentEffectiveTime

Constructor Summary

Constructors

Constructor	Description
OperatingPlatformClient(ConnectorContextBase parentContext, String localServerName, String localServiceName, String connectorUserId, String connectorGUID, String externalSourceGUID, String externalSourceName, OpenMetadataClient openMetadataClient, AuditLog auditLog, int maxPageSize)	Constructor for connector context client.

Method Summary

Modifier and Type	Method	Description
void	clearSoftwarePackageManifest(String elementGUID, MetadataSourceOptions metadataSourceOptions)	Remove the software package manifest designation from the element.
String	createOperatingPlatform(NewElementOptions newElementOptions, Map<String,ClassificationProperties> initialClassifications, OperatingPlatformProperties properties, RelationshipProperties parentRelationshipProperties)	Create a new operating platform.
String	createOperatingPlatformFromTemplate(TemplateOptions templateOptions, String templateGUID, EntityProperties replacementProperties, Map<String,ClassificationProperties> replacementClassifications, Map<String,String> placeholderProperties, RelationshipProperties parentRelationshipProperties)	Create a new metadata element to represent an operating platform using an existing element as a template.
void	deleteOperatingPlatform(String operatingPlatformGUID, DeleteOptions deleteOptions)	Delete an operating platform.
void	detachOperatingPlatformManifest(String operatingPlatformGUID, String collectionGUID, DeleteOptions deleteOptions)	Detach an operating platform from a collection of software packages that it was packaged with.
void	detachOperatingPlatformUse(String operatingPlatformGUID, String itInfrastructureGUID, DeleteOptions deleteOptions)	Detach an operating platform from the IT infrastructure that it was installed on.
void	detachSoftwarePackageDependency(String assetGUID, String collectionGUID, DeleteOptions deleteOptions)	Detach an asset from a collection of software packages that it no longer depends on.
List<OpenMetadataRootElement>	findOperatingPlatforms(String searchString, SearchOptions searchOptions)	Retrieve the list of operating platform metadata elements that contain the search string.
OpenMetadataRootElement	getOperatingPlatformByGUID(String operatingPlatformGUID, GetOptions getOptions)	Return the properties of a specific operating platform.
List<OpenMetadataRootElement>	getOperatingPlatformsByName(String name, QueryOptions queryOptions)	Returns the list of operating platforms with a particular name.
void	linkOperatingPlatformManifest(String operatingPlatformGUID, String collectionGUID, MakeAnchorOptions makeAnchorOptions, OperatingPlatformManifestProperties relationshipProperties)	Attach an operating platform to the collection of software packages that it is packaged with.
void	linkOperatingPlatformUse(String operatingPlatformGUID, String itInfrastructureGUID, MakeAnchorOptions makeAnchorOptions, OperatingPlatformUseProperties relationshipProperties)	Attach an operating platform to the IT infrastructure that it is installed on.
void	linkSoftwarePackageDependency(String assetGUID, String collectionGUID, MakeAnchorOptions makeAnchorOptions, SoftwarePackageDependencyProperties relationshipProperties)	Attach an asset to the collection of software packages that it depends on when it is running.
void	setSoftwarePackageManifest(String elementGUID, SoftwarePackageManifestProperties properties, MetadataSourceOptions metadataSourceOptions)	Classify an element to indicate that it describes a list of software packages.
boolean	updateOperatingPlatform(String operatingPlatformGUID, UpdateOptions updateOptions, OperatingPlatformProperties properties)	Update the properties of an operating platform.

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.ConnectorContextClientBase

getAdditionalProperties, getConnectorGUID, getDeleteOptions, getDisplayName, getEffectiveTime, getEgeriaRelease, getGetOptions, getMakeAnchorOptions, getMaxPagingSize, getMetadataSourceOptions, getNewElementProperties, getQualifiedName, getQueryOptions, getQueryOptions, getQueryOptions, getQueryOptions, getSearchOptions, getSearchOptions, getSearchOptions, getUpdateOptions, isForDuplicateProcessing, isForLineage, isUseCurrentEffectiveTime, publishElement, setAsOfTimeDefault, setEffectiveTimeDefault, setExternalSource, setExternalSourceIsHome, setForDuplicateProcessing, setForLineage, setGovernanceZonesFilterDefault, setLimitResultsByStatusDefault, setSequencingOrderDefault, setUseCurrentEffectiveTime, withdrawElement

Methods inherited from class java.lang.Object

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

Constructor Details

OperatingPlatformClient

public OperatingPlatformClient(ConnectorContextBase parentContext,
 String localServerName,
 String localServiceName,
 String connectorUserId,
 String connectorGUID,
 String externalSourceGUID,
 String externalSourceName,
 OpenMetadataClient openMetadataClient,
 AuditLog auditLog,
 int maxPageSize)

Constructor for connector context client.

Parameters:

parentContext - connector's context

localServerName - local server where this client is running - used for error handling

localServiceName - local service that his connector is hosted by - used for error handling

connectorUserId - the userId to use with all requests for open metadata

connectorGUID - the unique identifier that represents this connector in open metadata

externalSourceGUID - unique identifier of the software server capability for the source of metadata

externalSourceName - unique name of the software server capability for the source of metadata

openMetadataClient - client to access the open metadata store

auditLog - logging destination

maxPageSize - max number of elements that can be returned on a query

Method Details

createOperatingPlatform

public String createOperatingPlatform(NewElementOptions newElementOptions,
 Map<String,ClassificationProperties> initialClassifications,
 OperatingPlatformProperties properties,
 RelationshipProperties parentRelationshipProperties)
                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create a new operating platform.

Parameters:

newElementOptions - details of the element to create

initialClassifications - map of classification names to classification properties to include in the entity creation request

properties - properties for the new element.

parentRelationshipProperties - properties to include in parent relationship

Returns:

unique identifier of the newly created element

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

createOperatingPlatformFromTemplate

public String createOperatingPlatformFromTemplate(TemplateOptions templateOptions,
 String templateGUID,
 EntityProperties replacementProperties,
 Map<String,ClassificationProperties> replacementClassifications,
 Map<String,String> placeholderProperties,
 RelationshipProperties parentRelationshipProperties)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Parameters:

templateOptions - details of the element to create

templateGUID - the unique identifier of the existing element to copy

replacementProperties - properties of the new metadata element. These override the template values

replacementClassifications - map of classification names to classification properties to include in the entity creation request. These override the template values.

placeholderProperties - property name-to-property value map to replace any placeholder values in the template element - and their anchored elements, which are also copied as part of this operation.

parentRelationshipProperties - properties to include in parent relationship

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 - a problem reported in the open metadata server(s)

updateOperatingPlatform

public boolean updateOperatingPlatform(String operatingPlatformGUID,
 UpdateOptions updateOptions,
 OperatingPlatformProperties properties)
                                throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update the properties of an operating platform.

Parameters:

operatingPlatformGUID - unique identifier of the operating platform (returned from create)

updateOptions - provides a structure for the additional options when updating an element.

properties - properties for the element.

Returns:

boolean - true if an update occurred

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

linkOperatingPlatformUse

public void linkOperatingPlatformUse(String operatingPlatformGUID,
 String itInfrastructureGUID,
 MakeAnchorOptions makeAnchorOptions,
 OperatingPlatformUseProperties relationshipProperties)
                              throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Attach an operating platform to the IT infrastructure that it is installed on.

Parameters:

operatingPlatformGUID - unique identifier of the operating platform

itInfrastructureGUID - unique identifier of the IT infrastructure that the operating platform is installed on

makeAnchorOptions - options to control access to open metadata

relationshipProperties - description of the relationship.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

detachOperatingPlatformUse

public void detachOperatingPlatformUse(String operatingPlatformGUID,
 String itInfrastructureGUID,
 DeleteOptions deleteOptions)
                                throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Detach an operating platform from the IT infrastructure that it was installed on.

Parameters:

operatingPlatformGUID - unique identifier of the operating platform

itInfrastructureGUID - unique identifier of the IT infrastructure that the operating platform was installed on

deleteOptions - options to control access to open metadata

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

linkOperatingPlatformManifest

public void linkOperatingPlatformManifest(String operatingPlatformGUID,
 String collectionGUID,
 MakeAnchorOptions makeAnchorOptions,
 OperatingPlatformManifestProperties relationshipProperties)
                                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Attach an operating platform to the collection of software packages that it is packaged with.

Parameters:

operatingPlatformGUID - unique identifier of the operating platform

collectionGUID - unique identifier of the collection of software packages

makeAnchorOptions - options to control access to open metadata

relationshipProperties - description of the relationship.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

detachOperatingPlatformManifest

public void detachOperatingPlatformManifest(String operatingPlatformGUID,
 String collectionGUID,
 DeleteOptions deleteOptions)
                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Detach an operating platform from a collection of software packages that it was packaged with.

Parameters:

operatingPlatformGUID - unique identifier of the operating platform

collectionGUID - unique identifier of the collection of software packages

deleteOptions - options to control access to open metadata

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

linkSoftwarePackageDependency

public void linkSoftwarePackageDependency(String assetGUID,
 String collectionGUID,
 MakeAnchorOptions makeAnchorOptions,
 SoftwarePackageDependencyProperties relationshipProperties)
                                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Attach an asset to the collection of software packages that it depends on when it is running.

Parameters:

assetGUID - unique identifier of the asset

collectionGUID - unique identifier of the collection of software packages

makeAnchorOptions - options to control access to open metadata

relationshipProperties - description of the relationship.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

detachSoftwarePackageDependency

public void detachSoftwarePackageDependency(String assetGUID,
 String collectionGUID,
 DeleteOptions deleteOptions)
                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Detach an asset from a collection of software packages that it no longer depends on.

Parameters:

assetGUID - unique identifier of the asset

collectionGUID - unique identifier of the collection of software packages

deleteOptions - options to control access to open metadata

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

setSoftwarePackageManifest

public void setSoftwarePackageManifest(String elementGUID,
 SoftwarePackageManifestProperties properties,
 MetadataSourceOptions metadataSourceOptions)
                                throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Classify an element to indicate that it describes a list of software packages.

Parameters:

elementGUID - unique identifier of the element.

properties - properties for the classification

metadataSourceOptions - options to control access to open metadata

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

clearSoftwarePackageManifest

public void clearSoftwarePackageManifest(String elementGUID,
 MetadataSourceOptions metadataSourceOptions)
                                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Remove the software package manifest designation from the element.

Parameters:

elementGUID - unique identifier of the element.

metadataSourceOptions - options to control access to open metadata

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

deleteOperatingPlatform

public void deleteOperatingPlatform(String operatingPlatformGUID,
 DeleteOptions deleteOptions)
                             throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Delete an operating platform.

Parameters:

operatingPlatformGUID - unique identifier of the element

deleteOptions - options for a delete request

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

getOperatingPlatformsByName

public List<OpenMetadataRootElement> getOperatingPlatformsByName(String name,
 QueryOptions queryOptions)
                                                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Returns the list of operating platforms with a particular name.

Parameters:

name - name of the element to return - match is full text match in qualifiedName, identifier or displayName

queryOptions - multiple options to control the query

Returns:

a list of elements

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

getOperatingPlatformByGUID

public OpenMetadataRootElement getOperatingPlatformByGUID(String operatingPlatformGUID,
 GetOptions getOptions)
                                                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the properties of a specific operating platform.

Parameters:

operatingPlatformGUID - unique identifier of the required element

getOptions - multiple options to control the query

Returns:

retrieved properties

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

findOperatingPlatforms

public List<OpenMetadataRootElement> findOperatingPlatforms(String searchString,
 SearchOptions searchOptions)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of operating platform metadata elements that contain the search string.

Parameters:

searchString - string to find in the properties

searchOptions - multiple options to control the query

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 - a problem reported in the open metadata server(s)