Package org.odpi.openmetadata.frameworks.openmetadata.connectorcontext

Class SpecificationPropertyClient

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.ConnectorContextClientBase

org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.SpecificationPropertyClient

public class SpecificationPropertyClient
extends ConnectorContextClientBase

Provides services for connectors to work with specification property elements.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.ConnectorContextClientBase

asOfTimeDefault, auditLog, connectorGUID, connectorUserId, externalSourceGUID, externalSourceIsHome, externalSourceName, forDuplicateProcessing, forLineage, governanceZonesFilterDefault, limitResultsByStatusDefault, localServerName, localServiceName, maxPageSize, parentContext, propertyHelper, sequencingOrderDefault, sequencingPropertyDefault, useCurrentEffectiveTime

Constructor Summary

Constructors

Constructor	Description
SpecificationPropertyClient(ConnectorContextBase parentContext, String localServerName, String localServiceName, String connectorUserId, String connectorGUID, String externalSourceGUID, String externalSourceName, OpenMetadataClient openMetadataClient, AuditLog auditLog, int maxPageSize)	Constructor for connector context client.

Method Summary

Modifier and Type	Method	Description
void	deleteSpecificationPropertyName(String specificationPropertyGUID, DeleteOptions deleteOptions)	Remove a specification property.
List<OpenMetadataRootElement>	findSpecificationProperties(String searchString, SearchOptions searchOptions)	Retrieve the list of specification property metadata elements that contain the search string.
List<OpenMetadataRootElement>	getSpecificationPropertiesByName(String name, QueryOptions queryOptions)	Return the list of keywords exactly matching the supplied specification property type.
List<OpenMetadataRootElement>	getSpecificationPropertiesByType(SpecificationPropertyType specificationPropertyType, QueryOptions queryOptions)	Return the list of keywords exactly matching the supplied specification property type.
OpenMetadataRootElement	getSpecificationPropertyByGUID(String specificationPropertyGUID, GetOptions getOptions)	Return the requested specification property.

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.ConnectorContextClientBase

getAdditionalProperties, getDeleteOptions, getDisplayName, getEffectiveTime, getGetOptions, getMaxPagingSize, getMetadataSourceOptions, getNewElementProperties, getQualifiedName, getQueryOptions, getQueryOptions, getQueryOptions, getQueryOptions, getSearchOptions, getSearchOptions, getUpdateOptions, isForDuplicateProcessing, isForLineage, isUseCurrentEffectiveTime, publishElement, setAsOfTimeDefault, setEffectiveTimeDefault, setExternalSourceIsHome, setForDuplicateProcessing, setForLineage, setGovernanceZonesFilterDefault, setLimitResultsByStatusDefault, setSequencingOrderDefault, setUseCurrentEffectiveTime, withdrawElement

Methods inherited from class java.lang.Object

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

Constructor Details

SpecificationPropertyClient

public SpecificationPropertyClient(ConnectorContextBase parentContext,
 String localServerName,
 String localServiceName,
 String connectorUserId,
 String connectorGUID,
 String externalSourceGUID,
 String externalSourceName,
 OpenMetadataClient openMetadataClient,
 AuditLog auditLog,
 int maxPageSize)

Constructor for connector context client.

Parameters:

parentContext - connector's context

localServerName - local server where this client is running - used for error handling

localServiceName - local service that his connector is hosted by - used for error handling

connectorUserId - the userId to use with all requests for open metadata

connectorGUID - the unique identifier that represents this connector in open metadata

externalSourceGUID - unique identifier of the software server capability for the source of metadata

externalSourceName - unique name of the software server capability for the source of metadata

openMetadataClient - client to access the open metadata store

auditLog - logging destination

maxPageSize - max number of elements that can be returned on a query

Method Details

deleteSpecificationPropertyName

public void deleteSpecificationPropertyName(String specificationPropertyGUID,
 DeleteOptions deleteOptions)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a specification property.

Parameters:

specificationPropertyGUID - unique identifier of the specification property element to remove

deleteOptions - options to control the delete operation

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

getSpecificationPropertyByGUID

public OpenMetadataRootElement getSpecificationPropertyByGUID(String specificationPropertyGUID,
 GetOptions getOptions)
                                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the requested specification property.

Parameters:

specificationPropertyGUID - unique identifier for the specification property object.

getOptions - multiple options to control the query

Returns:

specification property properties

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the element properties in the property server.

UserNotAuthorizedException - the user does not have permission to perform this request.

getSpecificationPropertiesByType

public List<OpenMetadataRootElement> getSpecificationPropertiesByType(SpecificationPropertyType specificationPropertyType,
 QueryOptions queryOptions)
                                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the list of keywords exactly matching the supplied specification property type.

Parameters:

specificationPropertyType - name of specificationPropertyType.

queryOptions - multiple options to control the query

Returns:

specificationPropertyType list

Throws:

InvalidParameterException - the userId is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getSpecificationPropertiesByName

public List<OpenMetadataRootElement> getSpecificationPropertiesByName(String name,
 QueryOptions queryOptions)
                                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the list of keywords exactly matching the supplied specification property type.

Parameters:

name - name of name.

queryOptions - multiple options to control the query

Returns:

name list

Throws:

InvalidParameterException - the userId is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

findSpecificationProperties

public List<OpenMetadataRootElement> findSpecificationProperties(String searchString,
 SearchOptions searchOptions)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of specification property metadata elements that contain the search string.

Parameters:

searchString - string to find in the properties

searchOptions - multiple options to control the query

Returns:

list of matching metadata elements

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)