Package org.odpi.openmetadata.accessservices.discoveryengine.client

Class DiscoveryAssetCatalogStoreClient

java.lang.Object

org.odpi.openmetadata.frameworks.discovery.DiscoveryAssetCatalogStore

org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAssetCatalogStoreClient

public class DiscoveryAssetCatalogStoreClient
extends DiscoveryAssetCatalogStore

DiscoveryAssetCatalogStoreClient is the open metadata default implementation of the Open Discovery Framework (ODF) DiscoveryAssetCatalogStore. It uses the open metadata services through the Discovery Engine OMAS to provide access to the requested assets.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.discovery.DiscoveryAssetCatalogStore

maxPageSize, userId

Constructor Summary

Constructors

Constructor	Description
DiscoveryAssetCatalogStoreClient(String userId, DiscoveryEngineClient discoveryEngineClient, int maxPageSize)	Create a discovery asset catalog store that call call the discovery engine client.

Method Summary

Modifier and Type	Method	Description
List<String>	findAssets(String searchString, int startFrom, int pageSize)	Return the list of assets that have the search string somewhere in their properties.
List<String>	getAssets(int startFrom, int pageSize)	Return the next set of assets to process.
List<String>	getAssetsByEndpoint(String networkAddress, int startFrom, int pageSize)	Return the list of assets that have the same endpoint address.
List<String>	getAssetsByName(String name, int startFrom, int pageSize)	Return the list of matching assets that have the supplied name as either the qualified name or display name.
List<String>	getAssetsByQualifiedName(String name, int startFrom, int pageSize)	Return the assets with the same qualified name.

Methods inherited from class org.odpi.openmetadata.frameworks.discovery.DiscoveryAssetCatalogStore

getMaxPageSize

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoveryAssetCatalogStoreClient

public DiscoveryAssetCatalogStoreClient(String userId,
                                        DiscoveryEngineClient discoveryEngineClient,
                                        int maxPageSize)

Create a discovery asset catalog store that call call the discovery engine client.

Parameters:

userId - calling user

discoveryEngineClient - client for the Discovery Engine OMAS

maxPageSize - maximum number of results to return.

Method Detail

getAssets

public List<String> getAssets(int startFrom,
                              int pageSize)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Return the next set of assets to process.

Specified by:

getAssets in class DiscoveryAssetCatalogStore

Parameters:

startFrom - starting point of the query

pageSize - maximum number of results to return

Returns:

list of unique identifiers for located assets

Throws:

InvalidParameterException - one of the parameters is not recognized

UserNotAuthorizedException - the user is not authorized to access the asset and/or connection

PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.

getAssetsByQualifiedName

public List<String> getAssetsByQualifiedName(String name,
                                             int startFrom,
                                             int pageSize)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Return the assets with the same qualified name. If all is well there should be only one returned.

Specified by:

getAssetsByQualifiedName in class DiscoveryAssetCatalogStore

Parameters:

name - the qualified name to query on

startFrom - place to start in query

pageSize - number of results to return

Returns:

list of unique identifiers for matching assets

Throws:

InvalidParameterException - one of the parameters is not recognized

UserNotAuthorizedException - the user is not authorized to access the asset and/or connection

PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.

getAssetsByName

public List<String> getAssetsByName(String name,
                                    int startFrom,
                                    int pageSize)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Return the list of matching assets that have the supplied name as either the qualified name or display name. This is an exact match retrieval.

Specified by:

getAssetsByName in class DiscoveryAssetCatalogStore

Parameters:

name - name to query for

startFrom - place to start in query

pageSize - number of results to return

Returns:

list of unique identifiers for matching assets

Throws:

InvalidParameterException - one of the parameters is not recognized

UserNotAuthorizedException - the user is not authorized to access the asset and/or connection

PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.

findAssets

public List<String> findAssets(String searchString,
                               int startFrom,
                               int pageSize)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Return the list of assets that have the search string somewhere in their properties. The search string may be a regular expression.

Specified by:

findAssets in class DiscoveryAssetCatalogStore

Parameters:

searchString - value to search for

startFrom - place to start in query

pageSize - number of results to return

Returns:

list of unique identifiers for matching assets

Throws:

InvalidParameterException - one of the parameters is not recognized

UserNotAuthorizedException - the user is not authorized to access the asset and/or connection

PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.

getAssetsByEndpoint

public List<String> getAssetsByEndpoint(String networkAddress,
                                        int startFrom,
                                        int pageSize)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Return the list of assets that have the same endpoint address.

Specified by:

getAssetsByEndpoint in class DiscoveryAssetCatalogStore

Parameters:

networkAddress - address to query on

startFrom - place to start in query

pageSize - number of results to return

Returns:

list of unique identifiers for matching assets

Throws:

InvalidParameterException - one of the parameters is not recognized

UserNotAuthorizedException - the user is not authorized to access the asset and/or connection

PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.