SoftwareServerCapabilityHandler (OCF Metadata Management Server-side Handlers 2.2 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.SoftwareServerCapabilityHandler

```
public class SoftwareServerCapabilityHandler
extends Object
```
SoftwareServerCapabilityHandler provides the support for managing software server capabilities.

Constructor Summary

Constructors
Constructor and Description
`SoftwareServerCapabilityHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper)` 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`	`createDatabaseManager(String userId, 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 the capability for a relational database platform.
`String`	`createFileSystem(String userId, 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`	`createMetadataIntegrator(String userId, String uniqueName, String displayName, String description, String type, String version, String patchLevel, String source, Map<String,String> additionalProperties, Map<String,String> vendorProperties, String classificationGUID, String classificationName, String methodName)` Create the capability for a relational database platform.
`List<SoftwareServerCapability>`	`getSoftwareServerCapabilitiesByClassification(String userId, String classificationName, int startingFrom, int maxPageSize, String methodName)` Retrieve a list of defined software server capabilities.
`List<SoftwareServerCapability>`	`getSoftwareServerCapabilitiesByType(String userId, String typeGUID, String typeName, int startingFrom, int maxPageSize, String methodName)` Retrieve a list of defined software server capabilities.
`SoftwareServerCapability`	`getSoftwareServerCapabilityByGUID(String userId, String softwareServerCapabilityGUID, String methodName)` Retrieve a software server capability by its unique identifier (GUID).
`SoftwareServerCapability`	`getSoftwareServerCapabilityByUniqueName(String userId, String uniqueName, String methodName)` Retrieve a software server capability by its unique name.
`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.
`void`	`verifyIntegratorIdentity(String userId, String integratorGUID, String integratorName, String methodName)` Verify that the integrator identities are either null or refer to a valid software server capability.

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

Constructor Detail

SoftwareServerCapabilityHandler

public SoftwareServerCapabilityHandler(String serviceName,
                                       String serverName,
                                       InvalidParameterHandler invalidParameterHandler,
                                       RepositoryHandler repositoryHandler,
                                       OMRSRepositoryHelper repositoryHelper)

Construct the handler information needed to interact with the repository services

Parameters:: 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

Method Detail

createFileSystem

public String createFileSystem(String userId,
                               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.

Parameters:: userId - calling user; 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

createDatabaseManager

public String createDatabaseManager(String userId,
                                    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 the capability for a relational database platform.

Parameters:: userId - calling user; 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; additionalProperties - additional properties; vendorProperties - properties about the vendor and/or their product; methodName - calling method
Returns:: unique identifier for the database platform
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createMetadataIntegrator

public String createMetadataIntegrator(String userId,
                                       String uniqueName,
                                       String displayName,
                                       String description,
                                       String type,
                                       String version,
                                       String patchLevel,
                                       String source,
                                       Map<String,String> additionalProperties,
                                       Map<String,String> vendorProperties,
                                       String classificationGUID,
                                       String classificationName,
                                       String methodName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Create the capability for a relational database platform.

Parameters:: userId - calling user; 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; additionalProperties - additional properties; vendorProperties - properties about the vendor and/or their product; classificationGUID - unique identifier for the type of integrator; classificationName - unique name for the type of integrator; methodName - calling method
Returns:: unique identifier for the database platform
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getSoftwareServerCapabilityByGUID

public SoftwareServerCapability getSoftwareServerCapabilityByGUID(String userId,
                                                                  String softwareServerCapabilityGUID,
                                                                  String methodName)
                                                           throws InvalidParameterException,
                                                                  UserNotAuthorizedException,
                                                                  PropertyServerException

Retrieve a software server capability by its unique identifier (GUID).

Parameters:: userId - calling user; softwareServerCapabilityGUID - unique identifier used to locate the element; methodName - calling method
Returns:: retrieved properties
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getSoftwareServerCapabilityByUniqueName

public SoftwareServerCapability getSoftwareServerCapabilityByUniqueName(String userId,
                                                                        String uniqueName,
                                                                        String methodName)
                                                                 throws InvalidParameterException,
                                                                        UserNotAuthorizedException,
                                                                        PropertyServerException

Retrieve a software server capability by its unique name.

Parameters:: userId - calling user; uniqueName - unique name for the file system; methodName - calling method
Returns:: properties
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<SoftwareServerCapability> 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<SoftwareServerCapability> getSoftwareServerCapabilitiesByClassification(String userId,
                                                                                    String classificationName,
                                                                                    int startingFrom,
                                                                                    int maxPageSize,
                                                                                    String methodName)
                                                                             throws InvalidParameterException,
                                                                                    UserNotAuthorizedException,
                                                                                    PropertyServerException