SoftwareServerCapabilityHandler (Generic Handler Services 2.4 API)

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

```
public class SoftwareServerCapabilityHandler
extends ReferenceableHandler
```
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 and 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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, 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.
`List<B>`	`getSoftwareServerCapabilitiesByClassification(String userId, String classificationName, int startingFrom, int maxPageSize, String methodName)` Retrieve a list of defined software server capabilities.
`List<B>`	`getSoftwareServerCapabilitiesByType(String userId, String typeGUID, String typeName, int startingFrom, int maxPageSize, 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, String methodName)` Retrieve a list of unique identifiers for defined software server capabilities.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler
addSecurityTags, findBeanGUIDsByQualifiedName, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getMoreInformation, getMoreInformation, getVendorProperties, removeSecurityTags, removeSemanticAssignment, saveSemanticAssignment, saveSemanticAssignment

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findBeanGUIDs, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, relinkElementToNewElement, relinkElementToNewElement, setSecurityVerifier, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, validateAnchorEntity, validateAnchorEntity, 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,
                               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; 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. 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; 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

getSoftwareServerCapabilityGUIDsByType

public List<String> getSoftwareServerCapabilityGUIDsByType(String userId,
                                                           String typeGUID,
                                                           String typeName,
                                                           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; typeGUID - unique identifier of type; typeName - unique name of type; startingFrom - starting point in the list; maxPageSize - maximum number of results; 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,
                                                   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; 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,
                                                             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; 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

Class SoftwareServerCapabilityHandler<B>

Field Summary

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