Package org.odpi.openmetadata.commonservices.generichandlers

Class SoftwareServerCapabilityHandler<B>

java.lang.Object

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

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

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

public class SoftwareServerCapabilityHandler<B>
extends ReferenceableHandler<B>

SoftwareServerCapabilityHandler provides the support for managing software server capabilities.

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

SoftwareServerCapabilityHandler(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 handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method	Description
void	addSoftwareServerCapabilityClassification(String userId, String externalSourceGUID, String externalSourceName, String softwareServerCapabilityGUID, String softwareServerCapabilityGUIDParameterName, String classificationName, Date effectiveFrom, Date effectiveTo, String methodName)	Create specialized Software Server Capabilities entities.
String	createFileSystem(String userId, String externalSourceGUID, String externalSourceName, String uniqueName, String displayName, String description, String type, String version, String patchLevel, String source, String format, String encryption, Map<String,String> additionalProperties, Map<String,String> vendorProperties, Date effectiveFrom, Date effectiveTo, String methodName)	Files live on a file system.
String	createSoftwareServerCapability(String userId, String externalSourceGUID, String externalSourceName, String specializedTypeGUID, String specializedTypeName, String classificationName, String uniqueName, String displayName, String description, String type, String version, String patchLevel, String source, Map<String,String> additionalProperties, Map<String,String> vendorProperties, String methodName)	Create specialized Software Server Capabilities entities.
String	createSoftwareServerCapability(String userId, String externalSourceGUID, String externalSourceName, String specializedTypeName, String classificationName, String uniqueName, String displayName, String description, String type, String version, String patchLevel, String source, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, Date effectiveFrom, Date effectiveTo, String methodName)	Create specialized Software Server Capabilities entities.
String	createSoftwareServerCapabilityFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String templateGUIDParameterName, String qualifiedName, String qualifiedNameParameterName, String displayName, String description, String methodName)	Create a new metadata element to represent a connection using an existing metadata element as a template.
List<B>	getSoftwareServerCapabilitiesByClassification(String userId, String classificationName, int startingFrom, int maxPageSize, Date effectiveTime, String methodName)	Retrieve a list of defined software server capabilities.
List<B>	getSoftwareServerCapabilitiesByType(String userId, String typeGUID, String typeName, int startingFrom, int maxPageSize, Date effectiveTime, String methodName)	Retrieve a list of defined software server capabilities.
List<String>	getSoftwareServerCapabilityGUIDsByClassification(String userId, String classificationName, int startingFrom, int maxPageSize, String methodName)	Retrieve a list of unique identifiers for defined software server capabilities.
List<String>	getSoftwareServerCapabilityGUIDsByType(String userId, String typeGUID, String typeName, int startingFrom, int maxPageSize, Date effectiveTime, String methodName)	Retrieve a list of unique identifiers for defined software server capabilities.
void	updateSoftwareServerCapability(String userId, String externalSourceGUID, String externalSourceName, String capabilityGUID, String capabilityGUIDParameterName, String uniqueName, String displayName, String description, String type, String version, String patchLevel, String source, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, boolean isMergeUpdate, Date effectiveFrom, Date effectiveTo, String methodName)	Update a software server capability entity - the classification is not updated - assumed not to change as the classification is like its type.

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

SoftwareServerCapabilityHandler

public SoftwareServerCapabilityHandler(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 handler information needed to interact with the repository services

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 zones that the access service is allowed to serve Asset instances from.

defaultZones - list of zones that the access service should set in all new Asset instances.

publishZones - list of zones that the access service sets up in published Asset instances.

auditLog - destination for audit log events.

Method Detail

createFileSystem

public String createFileSystem(String userId,
                               String externalSourceGUID,
                               String externalSourceName,
                               String uniqueName,
                               String displayName,
                               String description,
                               String type,
                               String version,
                               String patchLevel,
                               String source,
                               String format,
                               String encryption,
                               Map<String,String> additionalProperties,
                               Map<String,String> vendorProperties,
                               Date effectiveFrom,
                               Date effectiveTo,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Files live on a file system. This method creates a top level anchor for a file system. It has its own method because ot the extra properties in the FileSystem classification

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

uniqueName - qualified name for the file system

displayName - short display name

description - description of the file system

type - type of file system

version - version of file system

patchLevel - patchLevel of software supporting the file system

source - supplier of the software for this file system

format - format of files on this file system

encryption - encryption type - null for unencrypted

additionalProperties - additional properties

vendorProperties - properties about the vendor and/or their product

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

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

methodName - calling method

Returns:

unique identifier for the file system

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

createSoftwareServerCapability

public String createSoftwareServerCapability(String userId,
                                             String externalSourceGUID,
                                             String externalSourceName,
                                             String specializedTypeName,
                                             String classificationName,
                                             String uniqueName,
                                             String displayName,
                                             String description,
                                             String type,
                                             String version,
                                             String patchLevel,
                                             String source,
                                             Map<String,String> additionalProperties,
                                             Map<String,Object> extendedProperties,
                                             Map<String,String> vendorProperties,
                                             Date effectiveFrom,
                                             Date effectiveTo,
                                             String methodName)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Create specialized Software Server Capabilities entities. Most software service capabilities either specialize Software Server Capability or have a special classification.

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

specializedTypeName - unique name of the software server capability type

classificationName - name of classification if any

uniqueName - qualified name for the software server capability

displayName - short display name

description - description of the file system

type - type of file system

version - version of file system

patchLevel - patchLevel of software supporting the file system

source - supplier of the software for this file system

additionalProperties - additional properties

extendedProperties - properties defined for the subtype

vendorProperties - properties about the vendor and/or their product

effectiveFrom - when is this element effective from

effectiveTo - when is this element effect to

methodName - calling method

Returns:

unique identifier for the file system

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

createSoftwareServerCapability

public String createSoftwareServerCapability(String userId,
                                             String externalSourceGUID,
                                             String externalSourceName,
                                             String specializedTypeGUID,
                                             String specializedTypeName,
                                             String classificationName,
                                             String uniqueName,
                                             String displayName,
                                             String description,
                                             String type,
                                             String version,
                                             String patchLevel,
                                             String source,
                                             Map<String,String> additionalProperties,
                                             Map<String,String> vendorProperties,
                                             String methodName)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Create specialized Software Server Capabilities entities. Most software service capabilities either specialize Software Server Capability or have a special classification.

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

specializedTypeGUID - unique identifier of the software server capability type

specializedTypeName - unique name of the software server capability type

classificationName - name of classification if any

uniqueName - qualified name for the software server capability

displayName - short display name

description - description of the file system

type - type of file system

version - version of file system

patchLevel - patchLevel of software supporting the file system

source - supplier of the software for this file system

additionalProperties - additional properties

vendorProperties - properties about the vendor and/or their product

methodName - calling method

Returns:

unique identifier for the file system

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

createSoftwareServerCapabilityFromTemplate

public String createSoftwareServerCapabilityFromTemplate(String userId,
                                                         String externalSourceGUID,
                                                         String externalSourceName,
                                                         String templateGUID,
                                                         String templateGUIDParameterName,
                                                         String qualifiedName,
                                                         String qualifiedNameParameterName,
                                                         String displayName,
                                                         String description,
                                                         String methodName)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Create a new metadata element to represent a connection using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.

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

templateGUID - unique identifier of the metadata element to copy

templateGUIDParameterName - parameter name for templateGUID

qualifiedName - unique name for the element - used in other configuration

qualifiedNameParameterName - parameter name for qualifiedName

displayName - short display name for the new element

description - description of the new element

methodName - calling method

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

addSoftwareServerCapabilityClassification

public void addSoftwareServerCapabilityClassification(String userId,
                                                      String externalSourceGUID,
                                                      String externalSourceName,
                                                      String softwareServerCapabilityGUID,
                                                      String softwareServerCapabilityGUIDParameterName,
                                                      String classificationName,
                                                      Date effectiveFrom,
                                                      Date effectiveTo,
                                                      String methodName)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Create specialized Software Server Capabilities entities. Most software service capabilities either specialize Software Server Capability or have a special classification. Metadata 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

softwareServerCapabilityGUID - unique identifier for the software server capability that is to be classified

softwareServerCapabilityGUIDParameterName - parameter supplying softwareServerCapabilityGUID

classificationName - name of classification if any

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 null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateSoftwareServerCapability

public void updateSoftwareServerCapability(String userId,
                                           String externalSourceGUID,
                                           String externalSourceName,
                                           String capabilityGUID,
                                           String capabilityGUIDParameterName,
                                           String uniqueName,
                                           String displayName,
                                           String description,
                                           String type,
                                           String version,
                                           String patchLevel,
                                           String source,
                                           Map<String,String> additionalProperties,
                                           Map<String,Object> extendedProperties,
                                           Map<String,String> vendorProperties,
                                           boolean isMergeUpdate,
                                           Date effectiveFrom,
                                           Date effectiveTo,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Update a software server capability entity - the classification is not updated - assumed not to change as the classification is like its type.

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

capabilityGUID - unique identifier for the capability

capabilityGUIDParameterName - parameter providing capabilityGUID

uniqueName - qualified name for the software server capability

displayName - short display name

description - description of the file system

type - type of file system

version - version of file system

patchLevel - patchLevel of software supporting the file system

source - supplier of the software for this file system

additionalProperties - additional properties

extendedProperties - properties defined for the subtype

vendorProperties - properties about the vendor and/or their product

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

effectiveFrom - when is this element effective from

effectiveTo - when is this element effect to

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSoftwareServerCapabilityGUIDsByType

public List<String> getSoftwareServerCapabilityGUIDsByType(String userId,
                                                           String typeGUID,
                                                           String typeName,
                                                           int startingFrom,
                                                           int maxPageSize,
                                                           Date effectiveTime,
                                                           String methodName)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Retrieve a list of unique identifiers for defined software server capabilities.

Parameters:

userId - calling user

typeGUID - unique identifier of type

typeName - unique name of type

startingFrom - starting point in the list

maxPageSize - maximum number of results

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

methodName - calling method

Returns:

List of unique identifiers

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSoftwareServerCapabilitiesByType

public List<B> getSoftwareServerCapabilitiesByType(String userId,
                                                   String typeGUID,
                                                   String typeName,
                                                   int startingFrom,
                                                   int maxPageSize,
                                                   Date effectiveTime,
                                                   String methodName)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve a list of defined software server capabilities.

Parameters:

userId - calling user

typeGUID - unique identifier of type

typeName - unique name of type

startingFrom - starting point in the list

maxPageSize - maximum number of results

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

methodName - calling method

Returns:

List of beans

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSoftwareServerCapabilitiesByClassification

public List<B> getSoftwareServerCapabilitiesByClassification(String userId,
                                                             String classificationName,
                                                             int startingFrom,
                                                             int maxPageSize,
                                                             Date effectiveTime,
                                                             String methodName)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException

Retrieve a list of defined software server capabilities.

Parameters:

userId - calling user

classificationName - name of classification

startingFrom - starting point in the list

maxPageSize - maximum number of results

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

methodName - calling method

Returns:

List of beans

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSoftwareServerCapabilityGUIDsByClassification

public List<String> getSoftwareServerCapabilityGUIDsByClassification(String userId,
                                                                     String classificationName,
                                                                     int startingFrom,
                                                                     int maxPageSize,
                                                                     String methodName)
                                                              throws InvalidParameterException,
                                                                     UserNotAuthorizedException,
                                                                     PropertyServerException

Retrieve a list of unique identifiers for defined software server capabilities.

Parameters:

userId - calling user

classificationName - name of the classification that identifies the type of software server capability required

startingFrom - starting point in the list

maxPageSize - maximum number of results

methodName - calling method

Returns:

List of unique identifiers for the retrieved entities

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem