Package org.odpi.openmetadata.frameworks.discovery

Class DiscoveryAssetCatalogStore

java.lang.Object

org.odpi.openmetadata.frameworks.discovery.DiscoveryAssetCatalogStore

public abstract class DiscoveryAssetCatalogStore
extends Object

DiscoveryAssetCatalogStore provides access to the asset catalog to enable it to step through the assets available in the asset catalog.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	maxPageSize
protected String	userId

Constructor Summary

Constructors

Constructor	Description
DiscoveryAssetCatalogStore(String userId, int maxPageSize)	Constructor sets the max page size which is used by the caller to ensure they do not ask for too many assets at once.

Method Summary

Modifier and Type	Method	Description
abstract List<String>	findAssets(String searchString, int startFrom, int pageSize)	Return the list of assets that have the search string somewhere in their properties.
abstract List<String>	getAssets(int startFrom, int pageSize)	Return the next set of assets to process.
abstract List<String>	getAssetsByEndpoint(String networkAddress, int startFrom, int pageSize)	Return the list of assets that have the same endpoint address.
abstract 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.
abstract List<String>	getAssetsByQualifiedName(String name, int startFrom, int pageSize)	Return the assets with the same qualified name.
int	getMaxPageSize()	Return the maximum number of assets that can be returned by getAssets().

Methods inherited from class java.lang.Object

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

Field Detail

userId

protected String userId

maxPageSize

protected int maxPageSize

Constructor Detail

DiscoveryAssetCatalogStore

public DiscoveryAssetCatalogStore(String userId,
                                  int maxPageSize)

Constructor sets the max page size which is used by the caller to ensure they do not ask for too many assets at once.

Parameters:

userId - calling user

maxPageSize - maximum number of assets that can be returned on a single request.

Method Detail

getMaxPageSize

public int getMaxPageSize()

Return the maximum number of assets that can be returned by getAssets().

Returns:

integer

getAssets

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

Return the next set of assets to process.

Parameters:

startFrom - starting point of the query

pageSize - maximum 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.

getAssetsByQualifiedName

public abstract 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.

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 abstract 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.

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 abstract 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.

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 abstract List<String> getAssetsByEndpoint(String networkAddress,
                                                 int startFrom,
                                                 int pageSize)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

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

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.