java.lang.Object
- 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.

Field Summary
- Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
  auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clearNestedOperatingPlatform(String userId, String externalSourceGUID, String externalSourceName, String hostGUID, String hostGUIDParameterName, String operatingPlatformGUID, String operatingPlatformGUIDParameterName, 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, String methodName)`	Create a definition of a operating platform.
`B`	`getOperatingPlatform(String userId, String qualifiedName, String qualifiedNameParameter, 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, 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, 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, String methodName)`	Update the operating platform.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
addAnchorsClassification, archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteAnchoredEntity, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteRelationship, entityMatchSearchCriteria, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findEntities, findEntities, getAllAttachmentLinks, getAnchorGUIDFromAnchorsClassification, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntitiesFromUser, getAttachedEntity, getAttachedEntity, getAttachedEntity, getAttachedEntityFromUser, getAttachedFilteredEntities, getAttachedFilteredEntities, getAttachedFilteredEntities, getAttachmentLink, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEffectiveTime, getEffectiveTime, getEntitiesByIntValue, getEntitiesByType, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHandler, getRepositoryHelper, getServerName, getServiceName, getTypeDefByName, getUniqueAttachmentLink, getUniqueAttachmentLink, isBeanIsolated, isEntityATypeOf, linkElementToElement, linkElementToElement, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, multiLinkElementToElement, regexSearchCriteria, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, validateUniqueProperty, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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 Detail

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,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Create a definition of a operating platform.

Parameters:: userId - calling user; externalSourceGUID - guid of the software server capability entity that represented the external source - null for local; externalSourceName - name of the software server 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 a operating platform; suppliedTypeName - type of operatingPlatform; extendedProperties - properties for a operating platform subtype; effectiveFrom - starting time for this relationship (null for all time); effectiveTo - ending time for this relationship (null for all time); 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,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Update the operating platform.

Parameters:: userId - calling user; externalSourceGUID - guid of the software server capability entity that represented the external source - null for local; externalSourceName - name of the software server 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 sub type 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); 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,
                                       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 server capability entity that represented the external source - null for local; externalSourceName - name of the software server 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); 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,
                                         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 server capability entity that represented the external source - null for local; externalSourceName - name of the software server 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; 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)

removeOperatingPlatform

public void removeOperatingPlatform(String userId,
                                    String externalSourceGUID,
                                    String externalSourceName,
                                    String operatingPlatformGUID,
                                    String operatingPlatformGUIDParameterName,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Remove the metadata element representing a operatingPlatform.

Parameters:: userId - calling user; externalSourceGUID - guid of the software server capability entity that represented the external source - null for local; externalSourceName - name of the software server capability entity that represented the external source; operatingPlatformGUID - unique identifier of the metadata element to remove; operatingPlatformGUIDParameterName - parameter supplying the operatingPlatformGUID; 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,
                              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; 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

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

Class OperatingPlatformHandler<B>

Field Summary

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