Package org.odpi.openmetadata.viewservices.assetcatalog.server.spring

Class AssetController

java.lang.Object

org.odpi.openmetadata.viewservices.assetcatalog.server.spring.AssetController

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/asset-catalog/old/assets")
@Deprecated
public class AssetController
extends Object

Deprecated.

Constructor Summary

Constructors

Constructor	Description
AssetController()	Deprecated.

Method Summary

Modifier and Type	Method	Description
AssetCatalogBean	getAsset(String serverName, String guid)	Deprecated. Fetch asset's header, classification and properties.
Elements	getAssetContext(String serverName, String guid)	Deprecated. Return the full context of an asset/glossary term based on its identifier.
List<Type>	getSupportedTypes(String serverName)	Deprecated. Returns the list with supported types for search, including the subtypes supported
List<Elements>	searchAssets(String serverName, String searchCriteria, List<String> types, String sequencingProperty, SequencingOrder sequencingOrder, boolean caseSensitive, boolean exactMatch, Integer from, Integer pageSize)	Deprecated. Return a list of assets matching the search criteria without the full context
List<Elements>	searchAssetsByTypeGUID(String serverName, String typeGUID)	Deprecated. Return a list of assets matching the type GUID without the full context The list includes also subtypes
List<Elements>	searchAssetsByTypeName(String serverName, String typeName)	Deprecated. Return a list of assets matching the type name without the full context The list includes also subtypes

Methods inherited from class java.lang.Object

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

Constructor Details

AssetController

public AssetController()

Deprecated.

Method Details

searchAssets

@GetMapping(path="/search")
public List<Elements> searchAssets(@PathVariable
 String serverName,
 @RequestParam("q")
 String searchCriteria,
 @RequestParam("types")
 List<String> types,
 @RequestParam(name="sequencingProperty",defaultValue="displayName")
 String sequencingProperty,
 @RequestParam(name="sequencingOrder",defaultValue="PROPERTY_ASCENDING")
 SequencingOrder sequencingOrder,
 @RequestParam(defaultValue="false")
 boolean caseSensitive,
 @RequestParam(defaultValue="false")
 boolean exactMatch,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="10")
 Integer pageSize)
                            throws PropertyServerException,
UserNotAuthorizedException,
InvalidParameterException

Deprecated.

Return a list of assets matching the search criteria without the full context

Parameters:

serverName - name of the server to route the request to

searchCriteria - the query parameter with the search phrase

types - OM types list to search for

sequencingProperty - name of the property based on which to sort the result

sequencingOrder - PROPERTY_ASCENDING or PROPERTY_DESCENDING

caseSensitive - set case sensitive flag

exactMatch - set exact match flag

from - the offset for the results

pageSize - the number of results per page

Returns:

list of assets

Throws:

PropertyServerException - if a configuration on the backend

UserNotAuthorizedException - security access problem

InvalidParameterException - if parameter validation fails

searchAssetsByTypeName

@GetMapping(path="/search-by-type-name/{typeName}")
public List<Elements> searchAssetsByTypeName(@PathVariable
 String serverName,
 @PathVariable("typeName")
 String typeName)
                                      throws PropertyServerException,
UserNotAuthorizedException,
InvalidParameterException

Deprecated.

Return a list of assets matching the type name without the full context The list includes also subtypes

Parameters:

serverName - name of the server to route the request to

typeName - the assets type name to search for

Returns:

list of assets by type name

Throws:

PropertyServerException - if a configuration on the backend

UserNotAuthorizedException - security access problem

InvalidParameterException - if parameter validation fails

searchAssetsByTypeGUID

@GetMapping(path="/search-by-type-guid/{typeGUID}")
public List<Elements> searchAssetsByTypeGUID(@PathVariable
 String serverName,
 @PathVariable("typeGUID")
 String typeGUID)
                                      throws PropertyServerException,
UserNotAuthorizedException,
InvalidParameterException

Deprecated.

Return a list of assets matching the type GUID without the full context The list includes also subtypes

Parameters:

serverName - name of the server to route the request to

typeGUID - the assets type GUID to search for

Returns:

list of assets by type GUID

Throws:

PropertyServerException - if a configuration on the backend

UserNotAuthorizedException - security access problem

InvalidParameterException - if parameter validation fails

getSupportedTypes

@GetMapping(path="/types")
public List<Type> getSupportedTypes(@PathVariable
 String serverName)
                             throws PropertyServerException,
UserNotAuthorizedException,
InvalidParameterException

Deprecated.

Returns the list with supported types for search, including the subtypes supported

Parameters:

serverName - name of the server to route the request to

Returns:

the supported types from Asset Consumer OMAS

Throws:

PropertyServerException - if a configuration on the backend

InvalidParameterException - if parameter validation fails

UserNotAuthorizedException - security access problem

getAsset

@GetMapping("/{guid}")
public AssetCatalogBean getAsset(@PathVariable
 String serverName,
 @PathVariable("guid")
 String guid)
                          throws PropertyServerException,
UserNotAuthorizedException,
InvalidParameterException

Deprecated.

Fetch asset's header, classification and properties.

Parameters:

serverName - name of the server to route the request to

guid - of the Entity to be retrieved

Returns:

the entity details

Throws:

PropertyServerException - if a configuration on the backend

UserNotAuthorizedException - security access problem

InvalidParameterException - if parameter validation fails

getAssetContext

@GetMapping("/{guid}/context")
public Elements getAssetContext(@PathVariable
 String serverName,
 @PathVariable("guid")
 String guid)
                         throws PropertyServerException,
UserNotAuthorizedException,
InvalidParameterException

Deprecated.

Return the full context of an asset/glossary term based on its identifier. The response contains the list of the connections assigned to the asset.

Parameters:

serverName - name of the server to route the request to

guid - of the Entity to be retrieved

Returns:

the entity context

Throws:

PropertyServerException - if a configuration on the backend

UserNotAuthorizedException - security access problem

InvalidParameterException - if parameter validation fails