java.lang.Object
- org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
- - org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler
 - - org.odpi.openmetadata.commonservices.generichandlers.AssetHandler
 - - org.odpi.openmetadata.commonservices.generichandlers.ITInfrastructureHandler

```
public class ITInfrastructureHandler
extends AssetHandler
```
OperatingPlatformHandler provides the exchange of metadata about hosts, software server platforms and software servers between the repository and the OMAS.

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
`ITInfrastructureHandler(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`	`addCloudPlatformClassification(String userId, String softwareServerPlatformGUID, String softwareServerPlatformGUIDParameterName, String implementationType, String methodName)`	Mark the software server platform as a Cloud Platform.
`void`	`addCloudProviderClassification(String userId, String hostGUID, String hostGUIDParameterName, String providerName, String methodName)`	Mark the host as a Cloud Provider.
`void`	`addCloudServiceClassification(String userId, String softwareCapabilityGUID, String softwareCapabilityGUIDParameterName, String offeringName, String serviceType, String methodName)`	Mark the software server capability as a Cloud Service.
`void`	`addCloudTenantClassification(String userId, String softwareServerGUID, String softwareServerGUIDParameterName, String tenantName, String tenantType, String methodName)`	Mark the software server as a Cloud Tenant.
`void`	`clearHostClusterMember(String userId, String externalSourceGUID, String externalSourceName, String hostClusterGUID, String hostClusterGUIDParameterName, String hostGUID, String hostGUIDParameterName, Date effectiveTime, String methodName)`	Remove a relationship between a host cluster and a host member.
`void`	`clearHostDeployedVirtualContainer(String userId, String externalSourceGUID, String externalSourceName, String hostGUID, String hostGUIDParameterName, String virtualContainerGUID, String virtualContainerGUIDParameterName, Date effectiveTime, String methodName)`	Remove a relationship between a host cluster and a host member.
`void`	`clearHostNetwork(String userId, String externalSourceGUID, String externalSourceName, String hostGUID, String hostGUIDParameterName, String networkGUID, String networkGUIDParameterName, Date effectiveTime, String methodName)`	Remove a relationship between a a host and a network.
`void`	`clearNetworkGatewayLink(String userId, String externalSourceGUID, String externalSourceName, String networkGatewayGUID, String networkGatewayGUIDParameterName, String networkGUID, String networkGUIDParameterName, Date effectiveTime, String methodName)`	Remove a relationship between a network gateway and the network it connects to.
`void`	`clearSoftwareCapabilityAssetUse(String userId, String externalSourceGUID, String externalSourceName, String softwareCapabilityGUID, String softwareCapabilityGUIDParameterName, String assetGUID, String assetGUIDParameterName, Date effectiveTime, String methodName)`	Remove a relationship between a software server and a software server capability.
`void`	`clearSoftwareServerDeployment(String userId, String externalSourceGUID, String externalSourceName, String softwareServerPlatformGUID, String softwareServerPlatformGUIDParameterName, String softwareServerGUID, String softwareServerGUIDParameterName, Date effectiveTime, String methodName)`	Remove a relationship between a software server platform and a software server.
`void`	`clearSoftwareServerEndpoint(String userId, String externalSourceGUID, String externalSourceName, String softwareServerGUID, String softwareServerGUIDParameterName, String endpointGUID, String endpointGUIDParameterName, Date effectiveTime, String methodName)`	Remove a relationship between a software server and one of its endpoints.
`void`	`clearSoftwareServerPlatformDeployment(String userId, String externalSourceGUID, String externalSourceName, String hostGUID, String hostGUIDParameterName, String softwareServerPlatformGUID, String softwareServerPlatformGUIDParameterName, Date effectiveTime, String methodName)`	Remove a relationship between a host and a software server platform.
`void`	`clearSupportedSoftwareCapability(String userId, String externalSourceGUID, String externalSourceName, String softwareServerGUID, String softwareServerGUIDParameterName, String softwareCapabilityGUID, String softwareCapabilityGUIDParameterName, Date effectiveTime, String methodName)`	Remove a relationship between a software server and a software server capability.
`void`	`removeCloudPlatformClassification(String userId, String softwareServerPlatformGUID, String softwareServerPlatformParameterName, String methodName)`	Remove the Cloud Platform designation from a software server platform.
`void`	`removeCloudProviderClassification(String userId, String hostGUID, String hostGUIDParameterName, String methodName)`	Remove the CloudProvider designation from a host.
`void`	`removeCloudServiceClassification(String userId, String softwareCapabilityGUID, String softwareCapabilityGUIDParameterName, String methodName)`	Remove the Cloud Service designation from a software server capability.
`void`	`removeCloudTenantClassification(String userId, String softwareServerGUID, String softwareServerGUIDParameterName, String methodName)`	Remove the Cloud Tenant designation from a software server.
`void`	`setupHostClusterMember(String userId, String externalSourceGUID, String externalSourceName, String hostClusterGUID, String hostClusterGUIDParameterName, String hostGUID, String hostGUIDParameterName, Date effectiveFrom, Date effectiveTo, String methodName)`	Create a relationship between a host cluster and a host.
`void`	`setupHostDeployedVirtualContainer(String userId, String externalSourceGUID, String externalSourceName, String hostGUID, String hostGUIDParameterName, String virtualContainerGUID, String virtualContainerGUIDParameterName, Date effectiveFrom, Date effectiveTo, String methodName)`	Create a relationship between a host cluster and a host.
`void`	`setupHostNetwork(String userId, String externalSourceGUID, String externalSourceName, String hostGUID, String hostGUIDParameterName, String networkGUID, String networkGUIDParameterName, Date effectiveFrom, Date effectiveTo, String methodName)`	Create a relationship between a host and a network.
`void`	`setupNetworkGatewayLink(String userId, String externalSourceGUID, String externalSourceName, String networkGatewayGUID, String networkGatewayGUIDParameterName, String networkGUID, String networkGUIDParameterName, Date effectiveFrom, Date effectiveTo, String methodName)`	Create a relationship between a network gateway and the network it connects to.
`void`	`setupSoftwareCapabilityAssetUse(String userId, String externalSourceGUID, String externalSourceName, String softwareCapabilityGUID, String softwareCapabilityGUIDParameterName, String assetGUID, String assetGUIDParameterName, String description, int useType, Date effectiveFrom, Date effectiveTo, String methodName)`	Create a relationship between a software server capability and an asset.
`void`	`setupSoftwareServerDeployment(String userId, String externalSourceGUID, String externalSourceName, String softwareServerPlatformGUID, String softwareServerPlatformGUIDParameterName, String softwareServerGUID, String softwareServerGUIDParameterName, Date deploymentTime, String deployer, int serverStatus, Date effectiveFrom, Date effectiveTo, String methodName)`	Create a relationship between a software server platform and a software server.
`void`	`setupSoftwareServerEndpoint(String userId, String externalSourceGUID, String externalSourceName, String softwareServerGUID, String softwareServerGUIDParameterName, String endpointGUID, String endpointGUIDParameterName, Date effectiveFrom, Date effectiveTo, String methodName)`	Create a relationship between a software server and one of its endpoints.
`void`	`setupSoftwareServerPlatformDeployment(String userId, String externalSourceGUID, String externalSourceName, String hostGUID, String hostGUIDParameterName, String softwareServerPlatformGUID, String softwareServerPlatformGUIDParameterName, Date deploymentTime, String deployer, int platformStatus, Date effectiveFrom, Date effectiveTo, String methodName)`	Create a relationship between a a host and a software server platform.
`void`	`setupSupportedSoftwareCapability(String userId, String externalSourceGUID, String externalSourceName, String softwareServerGUID, String softwareServerGUIDParameterName, String softwareCapabilityGUID, String softwareCapabilityGUIDParameterName, Date deploymentTime, String deployer, int serverCapabilityStatus, Date effectiveFrom, Date effectiveTo, String methodName)`	Create a relationship between a software server and a software server capability.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.AssetHandler
addAssetFromTemplate, addAssetOrigin, assetGUIDsScan, assetGUIDsScan, assetGUIDZoneScan, assetScan, assetScan, assetZoneScan, attachAssetToSoftwareServerCapability, attachSchemaTypeToAsset, classifyAssetAsReferenceData, createAssetInRepository, createAssetInRepository, createAssetInRepository, createAssetWithConnection, declassifyAssetAsReferenceData, detachSchemaTypeFromAsset, findAssetGUIDs, findAssetGUIDs, findAssets, findAssets, findAssetsByName, findAssetsByName, getAllAssetsWithConnection, getAssetByNameWithConnection, getAssetForConnection, getAssetForConnectionName, getAssetGUIDsByEndpoint, getAssetGUIDsByKeyword, getAssetGUIDsByName, getAssetGUIDsByName, getAssetGUIDsByTag, getAssetsByEndpoint, getAssetsByGlossaryTerm, getAssetsByKeyword, getAssetsByName, getAssetsByName, getAssetsByTag, getAssetWithConnection, getExternalSourceID, getTypesOfAssetDescriptions, getTypesOfAssetList, publishAsset, removeAssetOrigin, removeAssociatedSchemaType, removeLinkedDataSet, saveSemanticAssignments, updateAsset, updateAsset, updateAsset, updateAsset, updateAssetOwner, updateAssetWithConnection, updateAssetZones, withdrawAsset

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler
addOwner, addSecurityTags, addTemplateClassification, clearBusinessSignificant, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getCollectionMembers, getEntityByUniqueQualifiedName, getMoreInformation, getMoreInformation, getVendorProperties, linkElementsAsPeerDuplicates, removeOwner, removeResourceListMember, removeSecurityTags, removeSemanticAssignment, removeTemplateClassification, saveResourceListMember, saveSemanticAssignment, saveSemanticAssignment, setBusinessSignificant, setVendorProperties, unlinkElementsAsPeerDuplicates

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

ITInfrastructureHandler

public ITInfrastructureHandler(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

setupHostClusterMember

public void setupHostClusterMember(String userId,
                                   String externalSourceGUID,
                                   String externalSourceName,
                                   String hostClusterGUID,
                                   String hostClusterGUIDParameterName,
                                   String hostGUID,
                                   String hostGUIDParameterName,
                                   Date effectiveFrom,
                                   Date effectiveTo,
                                   String methodName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Create a relationship between a host cluster and a host.

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; hostClusterGUID - unique identifier of the host cluster; hostClusterGUIDParameterName - parameter supplying the hostClusterGUID; hostGUID - unique identifier of the member host; hostGUIDParameterName - parameter supplying the hostGUID; effectiveFrom - starting time for this relationship (null for all time); effectiveTo - ending time for this relationship; 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)

clearHostClusterMember

public void clearHostClusterMember(String userId,
                                   String externalSourceGUID,
                                   String externalSourceName,
                                   String hostClusterGUID,
                                   String hostClusterGUIDParameterName,
                                   String hostGUID,
                                   String hostGUIDParameterName,
                                   Date effectiveTime,
                                   String methodName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Remove a relationship between a host cluster and a host member.

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; hostClusterGUID - unique identifier of the host cluster; hostClusterGUIDParameterName - parameter supplying the hostClusterGUID; hostGUID - unique identifier of the member host; hostGUIDParameterName - parameter supplying the hostGUID; 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)

setupHostDeployedVirtualContainer

public void setupHostDeployedVirtualContainer(String userId,
                                              String externalSourceGUID,
                                              String externalSourceName,
                                              String hostGUID,
                                              String hostGUIDParameterName,
                                              String virtualContainerGUID,
                                              String virtualContainerGUIDParameterName,
                                              Date effectiveFrom,
                                              Date effectiveTo,
                                              String methodName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Create a relationship between a host cluster and a host.

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; virtualContainerGUID - unique identifier of the virtual container deployed on the host; virtualContainerGUIDParameterName - parameter supplying the virtualContainerGUID; effectiveFrom - starting time for this relationship (null for all time); effectiveTo - ending time for this relationship; 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)

clearHostDeployedVirtualContainer

public void clearHostDeployedVirtualContainer(String userId,
                                              String externalSourceGUID,
                                              String externalSourceName,
                                              String hostGUID,
                                              String hostGUIDParameterName,
                                              String virtualContainerGUID,
                                              String virtualContainerGUIDParameterName,
                                              Date effectiveTime,
                                              String methodName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Remove a relationship between a host cluster and a host member.

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 virtualContainerGUID; virtualContainerGUID - unique identifier of the virtual container deployed on the host; virtualContainerGUIDParameterName - parameter supplying the virtualContainerGUID; 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)

setupSoftwareServerPlatformDeployment

public void setupSoftwareServerPlatformDeployment(String userId,
                                                  String externalSourceGUID,
                                                  String externalSourceName,
                                                  String hostGUID,
                                                  String hostGUIDParameterName,
                                                  String softwareServerPlatformGUID,
                                                  String softwareServerPlatformGUIDParameterName,
                                                  Date deploymentTime,
                                                  String deployer,
                                                  int platformStatus,
                                                  Date effectiveFrom,
                                                  Date effectiveTo,
                                                  String methodName)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Create a relationship between a a host and a software server 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; softwareServerPlatformGUID - unique identifier of the software server platform; softwareServerPlatformGUIDParameterName - parameter supplying the softwareServerPlatformGUID; deploymentTime - date/time that the platform was deployed; deployer - user who issued the deploy command; platformStatus - operational status of the platform; effectiveFrom - starting time for this relationship (null for all time); effectiveTo - ending time for this relationship; 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)

clearSoftwareServerPlatformDeployment

public void clearSoftwareServerPlatformDeployment(String userId,
                                                  String externalSourceGUID,
                                                  String externalSourceName,
                                                  String hostGUID,
                                                  String hostGUIDParameterName,
                                                  String softwareServerPlatformGUID,
                                                  String softwareServerPlatformGUIDParameterName,
                                                  Date effectiveTime,
                                                  String methodName)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Remove a relationship between a host and a software server 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; softwareServerPlatformGUID - unique identifier of the software server platform; softwareServerPlatformGUIDParameterName - parameter supplying the softwareServerPlatformGUID; 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)

setupSoftwareServerDeployment

public void setupSoftwareServerDeployment(String userId,
                                          String externalSourceGUID,
                                          String externalSourceName,
                                          String softwareServerPlatformGUID,
                                          String softwareServerPlatformGUIDParameterName,
                                          String softwareServerGUID,
                                          String softwareServerGUIDParameterName,
                                          Date deploymentTime,
                                          String deployer,
                                          int serverStatus,
                                          Date effectiveFrom,
                                          Date effectiveTo,
                                          String methodName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Create a relationship between a software server platform and a software server.

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; softwareServerPlatformGUID - unique identifier of the software server platform; softwareServerPlatformGUIDParameterName - parameter supplying the softwareServerPlatformGUID; softwareServerGUID - unique identifier of the software server; softwareServerGUIDParameterName - parameter supplying the softwareServerGUID; deploymentTime - date/time that the capability was deployed; deployer - user who issued the deploy command; serverStatus - operational status of the server; effectiveFrom - starting time for this relationship (null for all time); effectiveTo - ending time for this relationship; 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)

clearSoftwareServerDeployment

public void clearSoftwareServerDeployment(String userId,
                                          String externalSourceGUID,
                                          String externalSourceName,
                                          String softwareServerPlatformGUID,
                                          String softwareServerPlatformGUIDParameterName,
                                          String softwareServerGUID,
                                          String softwareServerGUIDParameterName,
                                          Date effectiveTime,
                                          String methodName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Remove a relationship between a software server platform and a software server.

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; softwareServerPlatformGUID - unique identifier of the software server platform; softwareServerPlatformGUIDParameterName - parameter supplying the softwareServerPlatformGUID; softwareServerGUID - unique identifier of the software server; softwareServerGUIDParameterName - parameter supplying the softwareServerGUID; effectiveTime - the time that the retrieved elements must be effective for; effectiveTime - time that this relationship must be active (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)

setupSoftwareServerEndpoint

public void setupSoftwareServerEndpoint(String userId,
                                        String externalSourceGUID,
                                        String externalSourceName,
                                        String softwareServerGUID,
                                        String softwareServerGUIDParameterName,
                                        String endpointGUID,
                                        String endpointGUIDParameterName,
                                        Date effectiveFrom,
                                        Date effectiveTo,
                                        String methodName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Create a relationship between a software server and one of its endpoints.

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; softwareServerGUID - unique identifier of the software server; softwareServerGUIDParameterName - parameter supplying the softwareServerGUID; endpointGUID - unique identifier of the endpoint; endpointGUIDParameterName - parameter supplying the endpointGUID; effectiveFrom - starting time for this relationship (null for all time); effectiveTo - ending time for this relationship; 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)

clearSoftwareServerEndpoint

public void clearSoftwareServerEndpoint(String userId,
                                        String externalSourceGUID,
                                        String externalSourceName,
                                        String softwareServerGUID,
                                        String softwareServerGUIDParameterName,
                                        String endpointGUID,
                                        String endpointGUIDParameterName,
                                        Date effectiveTime,
                                        String methodName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Remove a relationship between a software server and one of its endpoints.

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; softwareServerGUID - unique identifier of the software server; softwareServerGUIDParameterName - parameter supplying the softwareServerGUID; endpointGUID - unique identifier of the endpoint; endpointGUIDParameterName - parameter supplying the endpointGUID; 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)

setupSupportedSoftwareCapability

public void setupSupportedSoftwareCapability(String userId,
                                             String externalSourceGUID,
                                             String externalSourceName,
                                             String softwareServerGUID,
                                             String softwareServerGUIDParameterName,
                                             String softwareCapabilityGUID,
                                             String softwareCapabilityGUIDParameterName,
                                             Date deploymentTime,
                                             String deployer,
                                             int serverCapabilityStatus,
                                             Date effectiveFrom,
                                             Date effectiveTo,
                                             String methodName)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Create a relationship between a software server and a software server capability.

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; softwareServerGUID - unique identifier of the software server; softwareServerGUIDParameterName - parameter supplying the softwareServerGUID; softwareCapabilityGUID - unique identifier of the software server capability; softwareCapabilityGUIDParameterName - parameter supplying the softwareCapabilityGUID; deploymentTime - date/time that the capability was deployed; deployer - user who issued the deploy command; serverCapabilityStatus - operational status of the capability; effectiveFrom - starting time for this relationship (null for all time); effectiveTo - ending time for this relationship; 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)

clearSupportedSoftwareCapability

public void clearSupportedSoftwareCapability(String userId,
                                             String externalSourceGUID,
                                             String externalSourceName,
                                             String softwareServerGUID,
                                             String softwareServerGUIDParameterName,
                                             String softwareCapabilityGUID,
                                             String softwareCapabilityGUIDParameterName,
                                             Date effectiveTime,
                                             String methodName)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Remove a relationship between a software server and a software server capability.

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; softwareServerGUID - unique identifier of the software server; softwareServerGUIDParameterName - parameter supplying the softwareServerGUID; softwareCapabilityGUID - unique identifier of the software server capability; softwareCapabilityGUIDParameterName - parameter supplying the softwareCapabilityGUID; 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)

setupSoftwareCapabilityAssetUse

public void setupSoftwareCapabilityAssetUse(String userId,
                                            String externalSourceGUID,
                                            String externalSourceName,
                                            String softwareCapabilityGUID,
                                            String softwareCapabilityGUIDParameterName,
                                            String assetGUID,
                                            String assetGUIDParameterName,
                                            String description,
                                            int useType,
                                            Date effectiveFrom,
                                            Date effectiveTo,
                                            String methodName)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Create a relationship between a software server capability and an asset.

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; softwareCapabilityGUID - unique identifier of the software server capability; softwareCapabilityGUIDParameterName - parameter supplying the softwareCapabilityGUID; assetGUID - unique identifier of the asset; assetGUIDParameterName - parameter supplying the assetGUID; description - description of the use; useType - server asset use type; effectiveFrom - starting time for this relationship (null for all time); effectiveTo - ending time for this relationship; 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)

clearSoftwareCapabilityAssetUse

public void clearSoftwareCapabilityAssetUse(String userId,
                                            String externalSourceGUID,
                                            String externalSourceName,
                                            String softwareCapabilityGUID,
                                            String softwareCapabilityGUIDParameterName,
                                            String assetGUID,
                                            String assetGUIDParameterName,
                                            Date effectiveTime,
                                            String methodName)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Remove a relationship between a software server and a software server capability.

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; softwareCapabilityGUID - unique identifier of the software server capability; softwareCapabilityGUIDParameterName - parameter supplying the assetGUID; assetGUID - unique identifier of the asset; assetGUIDParameterName - parameter supplying the assetGUID; 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)

setupHostNetwork

public void setupHostNetwork(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String hostGUID,
                             String hostGUIDParameterName,
                             String networkGUID,
                             String networkGUIDParameterName,
                             Date effectiveFrom,
                             Date effectiveTo,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Create a relationship between a host and a network.

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; networkGUID - unique identifier of the network; networkGUIDParameterName - parameter supplying the networkGUID; effectiveFrom - starting time for this relationship (null for all time); effectiveTo - ending time for this relationship; 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)

clearHostNetwork

public void clearHostNetwork(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String hostGUID,
                             String hostGUIDParameterName,
                             String networkGUID,
                             String networkGUIDParameterName,
                             Date effectiveTime,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove a relationship between a a host and a network.

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; networkGUID - unique identifier of the network; networkGUIDParameterName - parameter supplying the networkGUID; 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)

setupNetworkGatewayLink

public void setupNetworkGatewayLink(String userId,
                                    String externalSourceGUID,
                                    String externalSourceName,
                                    String networkGatewayGUID,
                                    String networkGatewayGUIDParameterName,
                                    String networkGUID,
                                    String networkGUIDParameterName,
                                    Date effectiveFrom,
                                    Date effectiveTo,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Create a relationship between a network gateway and the network it connects to.

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; networkGatewayGUID - unique identifier of the network gateway; networkGatewayGUIDParameterName - parameter supplying the networkGatewayGUID; networkGUID - unique identifier of The network; networkGUIDParameterName - parameter supplying the networkGUID; effectiveFrom - starting time for this relationship (null for all time); effectiveTo - ending time for this relationship; 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)

clearNetworkGatewayLink

public void clearNetworkGatewayLink(String userId,
                                    String externalSourceGUID,
                                    String externalSourceName,
                                    String networkGatewayGUID,
                                    String networkGatewayGUIDParameterName,
                                    String networkGUID,
                                    String networkGUIDParameterName,
                                    Date effectiveTime,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Remove a relationship between a network gateway and the network it connects to.

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; networkGatewayGUID - unique identifier of the network gateway; networkGatewayGUIDParameterName - parameter supplying the networkGatewayGUID; networkGUID - unique identifier of the network; networkGUIDParameterName - parameter supplying the networkGUID; 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)

addCloudProviderClassification

public void addCloudProviderClassification(String userId,
                                           String hostGUID,
                                           String hostGUIDParameterName,
                                           String providerName,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Mark the host as a Cloud Provider.

Parameters:: userId - calling user; hostGUID - unique identifier of host; hostGUIDParameterName - parameter name supplying hostGUID; providerName - name of the cloud provider; methodName - calling method
Throws:: InvalidParameterException - entity not known, null userId or guid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

removeCloudProviderClassification

public void removeCloudProviderClassification(String userId,
                                              String hostGUID,
                                              String hostGUIDParameterName,
                                              String methodName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Remove the CloudProvider designation from a host.

Parameters:: userId - calling user; hostGUID - unique identifier of host; hostGUIDParameterName - parameter name supplying hostGUID; methodName - calling method
Throws:: InvalidParameterException - entity not known, null userId or guid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

addCloudPlatformClassification

public void addCloudPlatformClassification(String userId,
                                           String softwareServerPlatformGUID,
                                           String softwareServerPlatformGUIDParameterName,
                                           String implementationType,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Mark the software server platform as a Cloud Platform.

Parameters:: userId - calling user; softwareServerPlatformGUID - unique identifier of software server platform; softwareServerPlatformGUIDParameterName - parameter name supplying softwareServerPlatformGUID; implementationType - type of cloud platform implementation; methodName - calling method
Throws:: InvalidParameterException - entity not known, null userId or guid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

removeCloudPlatformClassification

public void removeCloudPlatformClassification(String userId,
                                              String softwareServerPlatformGUID,
                                              String softwareServerPlatformParameterName,
                                              String methodName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Remove the Cloud Platform designation from a software server platform.

Parameters:: userId - calling user; softwareServerPlatformGUID - unique identifier of software server platform; softwareServerPlatformParameterName - parameter name supplying softwareServerPlatformGUID; methodName - calling method
Throws:: InvalidParameterException - entity not known, null userId or guid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

addCloudTenantClassification

public void addCloudTenantClassification(String userId,
                                         String softwareServerGUID,
                                         String softwareServerGUIDParameterName,
                                         String tenantName,
                                         String tenantType,
                                         String methodName)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Mark the software server as a Cloud Tenant.

Parameters:: userId - calling user; softwareServerGUID - unique identifier of software server; softwareServerGUIDParameterName - parameter name supplying softwareServerGUID; tenantName - name of the tenant; tenantType - type of tenant; methodName - calling method
Throws:: InvalidParameterException - entity not known, null userId or guid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

removeCloudTenantClassification

public void removeCloudTenantClassification(String userId,
                                            String softwareServerGUID,
                                            String softwareServerGUIDParameterName,
                                            String methodName)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Remove the Cloud Tenant designation from a software server.

Parameters:: userId - calling user; softwareServerGUID - unique identifier of software server; softwareServerGUIDParameterName - parameter name supplying softwareServerGUID; methodName - calling method
Throws:: InvalidParameterException - entity not known, null userId or guid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

addCloudServiceClassification

public void addCloudServiceClassification(String userId,
                                          String softwareCapabilityGUID,
                                          String softwareCapabilityGUIDParameterName,
                                          String offeringName,
                                          String serviceType,
                                          String methodName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Mark the software server capability as a Cloud Service.

Parameters:: userId - calling user; softwareCapabilityGUID - unique identifier of software server capability; softwareCapabilityGUIDParameterName - parameter name supplying softwareCapabilityGUID; offeringName - name of the service; serviceType - type of service; methodName - calling method
Throws:: InvalidParameterException - entity not known, null userId or guid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

removeCloudServiceClassification

public void removeCloudServiceClassification(String userId,
                                             String softwareCapabilityGUID,
                                             String softwareCapabilityGUIDParameterName,
                                             String methodName)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Remove the Cloud Service designation from a software server capability.

Parameters:: userId - calling user; softwareCapabilityGUID - unique identifier of software server capability; softwareCapabilityGUIDParameterName - parameter name supplying softwareCapabilityGUID; methodName - calling method
Throws:: InvalidParameterException - entity not known, null userId or guid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

Class ITInfrastructureHandler<B>

Field Summary

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