Package org.odpi.openmetadata.commonservices.generichandlers

Class OperatingPlatformHandler<B>

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.OperatingPlatformHandler<B>

public class OperatingPlatformHandler<B>
extends OpenMetadataAPIGenericHandler<B>

OperatingPlatformHandler provides the exchange of metadata about operating platforms between the repository and the OMAS. Supports external elements and effectivity dates.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

OpenMetadataAPIGenericHandler.AnchorIdentifiers

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler

assetActionDescription, auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, qualifiedNamePropertyNamesList, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors

Constructor

Description

OperatingPlatformHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)

Construct the operating platform handler with information needed to work with B objects.

Method Summary

Modifier and Type	Method	Description
void	clearNestedOperatingPlatform(String userId, String externalSourceGUID, String externalSourceName, String hostGUID, String hostGUIDParameterName, String operatingPlatformGUID, String operatingPlatformGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Remove a relationship between a host and an operating platform..
void	createOperatingPlatform(String userId, String externalSourceGUID, String externalSourceName, String qualifiedName, String name, String description, String operatingSystem, int byteOrdering, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName)	Create a definition of an operating platform.
B	getOperatingPlatform(String userId, String qualifiedName, String qualifiedNameParameter, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Return information about a specific operating platform.
List<B>	getOperatingPlatforms(String userId, int startingFrom, int pageSize, Date effectiveTime, String methodName)	Return information about the defined operating platforms.
void	removeOperatingPlatform(String userId, String externalSourceGUID, String externalSourceName, String operatingPlatformGUID, String operatingPlatformGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Remove the metadata element representing a operatingPlatform.
void	setupHostOperatingPlatform(String userId, String externalSourceGUID, String externalSourceName, String hostGUID, String hostGUIDParameterName, String operatingPlatformGUID, String operatingPlatformGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Create a relationship between a host and an operating platform.
void	updateOperatingPlatform(String userId, String externalSourceGUID, String externalSourceName, String operatingPlatformGUID, String operatingPlatformGUIDParameterName, String qualifiedName, String name, String description, String operatingSystem, int byteOrdering, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, boolean isMergeUpdate, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Update the operating platform.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

addAnchorGUIDToBuilder, addAnchorsClassification, archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanInRepository, createBeanInRepository, deleteAnchoredEntity, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteRelationship, findAttachmentLinks, findBeans, findBeans, findBeans, findEntities, findEntities, findEntities, findEntities, getAllAttachmentLinks, getAnchorGUIDForEntity, getAnchorGUIDFromAnchorsClassification, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLink, getAttachmentLink, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanHistory, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getDomainName, getDomainName, getEntitiesByIntValue, getEntitiesByType, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRelationshipHistory, getSpecification, getSupplementaryProperties, getUniqueAttachmentLink, getUniqueAttachmentLink, getValidatedBeans, getValidatedEntities, linkElementToElement, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, multiLinkElementToElement, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, uncheckedLinkElementToElement, undoBeanUpdateInRepository, undoBeanUpdateInRepository, undoBeanUpdateInRepository, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, updateRelationshipProperties, validateAnchorEntity, validateAnchorForEntities, validateAnchorForEntity, validateAnchorForEntity, validateAnchorGUID, validateRelationship, validateUniqueProperty, verifyExternalSourceIdentity

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler

getConverter, getElementStub, getRepositoryHandler, getRepositoryHelper, getServerName, getServiceName, getSupportedZones, getTypeDefByName, setSecurityVerifier

Methods inherited from class java.lang.Object

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

Constructor Details

OperatingPlatformHandler

public OperatingPlatformHandler(OpenMetadataAPIGenericConverter<B> converter,
 Class<B> beanClass,
 String serviceName,
 String serverName,
 InvalidParameterHandler invalidParameterHandler,
 RepositoryHandler repositoryHandler,
 OMRSRepositoryHelper repositoryHelper,
 String localServerUserId,
 OpenMetadataServerSecurityVerifier securityVerifier,
 List<String> supportedZones,
 List<String> defaultZones,
 List<String> publishZones,
 AuditLog auditLog)

Construct the operating platform handler with information needed to work with B objects.

Parameters:

converter - specific converter for this bean class

beanClass - name of bean class that is represented by the generic class B

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

supportedZones - list of operating platforms that the access service is allowed to serve B instances from.

defaultZones - list of operating platforms that the access service should set in all new B instances.

publishZones - list of operating platforms that the access service sets up in published B instances.

auditLog - destination for audit log events.

Method Details

createOperatingPlatform

public void createOperatingPlatform(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String qualifiedName,
 String name,
 String description,
 String operatingSystem,
 int byteOrdering,
 Map<String,String> additionalProperties,
 String suppliedTypeName,
 Map<String,Object> extendedProperties,
 Date effectiveFrom,
 Date effectiveTo,
 Date effectiveTime,
 String methodName)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a definition of an operating platform.

Parameters:

userId - calling user

externalSourceGUID - guid of the software capability entity that represented the external source - null for local

externalSourceName - name of the software capability entity that represented the external source

qualifiedName - unique name for the operating platform - used in other configuration

name - short display name for the operating platform

description - description of the operating platform

operatingSystem - the operating system running on this platform

byteOrdering - the identifier of the endianness

additionalProperties - additional properties for an operating platform

suppliedTypeName - type of operatingPlatform

extendedProperties - properties for an operating platform subtype

effectiveFrom - starting time for this relationship (null for all time)

effectiveTo - ending time for this relationship (null for all time)

effectiveTime - the time that the retrieved elements must be effective for

methodName - calling method

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateOperatingPlatform

public void updateOperatingPlatform(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String operatingPlatformGUID,
 String operatingPlatformGUIDParameterName,
 String qualifiedName,
 String name,
 String description,
 String operatingSystem,
 int byteOrdering,
 Map<String,String> additionalProperties,
 String suppliedTypeName,
 Map<String,Object> extendedProperties,
 boolean isMergeUpdate,
 Date effectiveFrom,
 Date effectiveTo,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the operating platform.

Parameters:

userId - calling user

externalSourceGUID - guid of the software capability entity that represented the external source - null for local

externalSourceName - name of the software capability entity that represented the external source

operatingPlatformGUID - unique identifier of the operating platform to update

operatingPlatformGUIDParameterName - parameter passing the operatingPlatformGUID

qualifiedName - unique name for the operating platform - used in other configuration

name - short display name for the operating platform

description - description of the governance operating platform

operatingSystem - name of the operating system running on the platform

byteOrdering - byte ordering used by the hardware

additionalProperties - additional properties for a governance operatingPlatform

suppliedTypeName - name of subtype or null

extendedProperties - properties for a governance operatingPlatform subtype

isMergeUpdate - should the properties be merged with existing properties or replace the existing properties?

effectiveFrom - starting time for this relationship (null for all time)

effectiveTo - ending time for this relationship (null for all time)

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

effectiveTime - the time that the retrieved elements must be effective for

methodName - calling method

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setupHostOperatingPlatform

public void setupHostOperatingPlatform(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String hostGUID,
 String hostGUIDParameterName,
 String operatingPlatformGUID,
 String operatingPlatformGUIDParameterName,
 Date effectiveFrom,
 Date effectiveTo,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a relationship between a host and an operating platform.

Parameters:

userId - calling user

externalSourceGUID - guid of the software capability entity that represented the external source - null for local

externalSourceName - name of the software capability entity that represented the external source

hostGUID - unique identifier of the host

hostGUIDParameterName - parameter supplying the hostGUID

operatingPlatformGUID - unique identifier of the operating platform

operatingPlatformGUIDParameterName - parameter supplying the operatingPlatformGUID

effectiveFrom - starting time for this relationship (null for all time)

effectiveTo - ending time for this relationship (null for all time)

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

effectiveTime - the time that the retrieved elements must be effective for

methodName - calling method

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)

clearNestedOperatingPlatform

public void clearNestedOperatingPlatform(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String hostGUID,
 String hostGUIDParameterName,
 String operatingPlatformGUID,
 String operatingPlatformGUIDParameterName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a relationship between a host and an operating platform..

Parameters:

userId - calling user

externalSourceGUID - guid of the software capability entity that represented the external source - null for local

externalSourceName - name of the software capability entity that represented the external source

hostGUID - unique identifier of the host

hostGUIDParameterName - parameter supplying the hostGUID

operatingPlatformGUID - unique identifier of the operating platform

operatingPlatformGUIDParameterName - parameter supplying the operatingPlatformGUID

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

methodName - calling method

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)

removeOperatingPlatform

public void removeOperatingPlatform(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String operatingPlatformGUID,
 String operatingPlatformGUIDParameterName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a operatingPlatform.

Parameters:

userId - calling user

externalSourceGUID - guid of the software capability entity that represented the external source - null for local

externalSourceName - name of the software capability entity that represented the external source

operatingPlatformGUID - unique identifier of the metadata element to remove

operatingPlatformGUIDParameterName - parameter supplying the operatingPlatformGUID

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

methodName - calling method

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)

getOperatingPlatform

public B getOperatingPlatform(String userId,
 String qualifiedName,
 String qualifiedNameParameter,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about a specific operating platform.

Parameters:

userId - calling user

qualifiedName - unique name for the operating platform

qualifiedNameParameter - name of parameter supplying the qualifiedName

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

methodName - calling method

Returns:

properties of the operating platform

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getOperatingPlatforms

public List<B> getOperatingPlatforms(String userId,
 int startingFrom,
 int pageSize,
 Date effectiveTime,
 String methodName)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the defined operating platforms.

Parameters:

userId - calling user

startingFrom - position in the list (used when there are so many reports that paging is needed

pageSize - maximum number of elements to return on this call

effectiveTime - the time that the retrieved elements must be effective for

methodName - calling method

Returns:

properties of the operating platform

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem