org.odpi.openmetadata.accessservices.dataengine.server.handlers

Class SoftwareServerRegistrationHandler

java.lang.Object

org.odpi.openmetadata.accessservices.dataengine.server.handlers.SoftwareServerRegistrationHandler

public class SoftwareServerRegistrationHandler
extends Object

SoftwareServerRegistrationHandler manages SoftwareServerCapability objects from the property server. It runs server-side in the DataEngine OMAS and creates software server capability entities through the OMRSRepositoryConnector.

Constructor Summary

Constructors

Constructor and Description
SoftwareServerRegistrationHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
String	createSoftwareServerCapability(String userId, String qualifiedName, String name, String description, String type, String version, String patchLevel, String source) Create the software server capability entity
String	getSoftwareServerCapabilityByQualifiedName(String userId, String qualifiedName) Return the guid of a software server capability entity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoftwareServerRegistrationHandler

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

createSoftwareServerCapability

public String createSoftwareServerCapability(String userId,
                                             String qualifiedName,
                                             String name,
                                             String description,
                                             String type,
                                             String version,
                                             String patchLevel,
                                             String source)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Create the software server capability entity

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the server

name - the name of the server

description - the description of the server

type - the type of the server

version - the version of the server

patchLevel - the patch level of the server

source - the source of the server

Returns:

unique identifier of the server in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getSoftwareServerCapabilityByQualifiedName

public String getSoftwareServerCapabilityByQualifiedName(String userId,
                                                         String qualifiedName)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Return the guid of a software server capability entity

Parameters:

userId - identifier of calling user

qualifiedName - qualified name of the server

Returns:

the guid of the server

Throws:

InvalidParameterException - one of the parameters is null or invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem retrieving the discovery engine definition