org.odpi.openmetadata.accessservices.assetconsumer.server

Class AssetConsumerRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.assetconsumer.server.AssetConsumerRESTServices

public class AssetConsumerRESTServices
extends Object

The AssetConsumerRESTServices provides the server-side implementation of the AssetConsumer Open Metadata Assess Service (OMAS). This interface provides connections to assets and APIs for adding feedback on the asset.

Constructor Summary

Constructors

Constructor and Description
AssetConsumerRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
GUIDResponse	addCommentReply(String userId, String commentGUID, CommentRequestBody requestBody) Adds a reply to a comment.
GUIDResponse	addCommentToAsset(String userId, String guid, CommentRequestBody requestBody) Adds a comment to the asset.
GUIDResponse	addLikeToAsset(String userId, String guid, NullRequestBody requestBody) Adds a "Like" to the asset.
VoidResponse	addLogMessageToAsset(String userId, String guid, LogRecordRequestBody requestBody) Creates an Audit log record for the asset.
GUIDResponse	addPrivateTagToAsset(String userId, String guid, TagRequestBody requestBody) Adds a new private tag to the asset's properties.
GUIDResponse	addRatingToAsset(String userId, String guid, RatingRequestBody requestBody) Adds a rating to the asset.
GUIDResponse	addTagToAsset(String userId, String guid, TagRequestBody requestBody) Adds a new public tag to the asset's properties.
ConnectionResponse	getConnectionByGUID(String userId, String guid) Returns the connection object corresponding to the supplied connection GUID.
ConnectionResponse	getConnectionByName(String userId, String name) Returns the connection object corresponding to the supplied connection name.
VoidResponse	removeComment(String userId, String guid, NullRequestBody requestBody) Removes a comment added to the asset by this user.
VoidResponse	removeLike(String userId, String guid, NullRequestBody requestBody) Removes a "Like" added to the asset by this user.
VoidResponse	removePrivateTag(String userId, String guid, NullRequestBody requestBody) Removes a tag from the asset that was added by this user.
VoidResponse	removeRating(String userId, String guid, NullRequestBody requestBody) Removes a star rating that was added to the asset by this user.
VoidResponse	removeTag(String userId, String guid, NullRequestBody requestBody) Removes a tag from the asset that was added by this user.
static void	setRepositoryConnector(String accessServiceName, OMRSRepositoryConnector repositoryConnector) Provide a connector to the REST Services.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetConsumerRESTServices

public AssetConsumerRESTServices()

Default constructor

Method Detail

setRepositoryConnector

public static void setRepositoryConnector(String accessServiceName,
                                          OMRSRepositoryConnector repositoryConnector)

Provide a connector to the REST Services.

Parameters:

accessServiceName - name of this access service

repositoryConnector - OMRS Repository Connector to the property server.

getConnectionByName

public ConnectionResponse getConnectionByName(String userId,
                                              String name)

Returns the connection object corresponding to the supplied connection name.

Parameters:

userId - userId of user making request.

name - this may be the qualifiedName or displayName of the connection.

Returns:

ConnectionResponse or InvalidParameterException - one of the parameters is null or invalid or UnrecognizedConnectionNameException - there is no connection defined for this name or AmbiguousConnectionNameException - there is more than one connection defined for this name or PropertyServerException - there is a problem retrieving information from the property (metadata) server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getConnectionByGUID

public ConnectionResponse getConnectionByGUID(String userId,
                                              String guid)

Returns the connection object corresponding to the supplied connection GUID.

Parameters:

userId - userId of user making request.

guid - the unique id for the connection within the property server.

Returns:

ConnectionResponse or InvalidParameterException - one of the parameters is null or invalid or UnrecognizedConnectionGUIDException - the supplied GUID is not recognized by the metadata repository or PropertyServerException - there is a problem retrieving information from the property (metadata) server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addLogMessageToAsset

public VoidResponse addLogMessageToAsset(String userId,
                                         String guid,
                                         LogRecordRequestBody requestBody)

Creates an Audit log record for the asset. This log record is stored in the Asset's Audit Log.

Parameters:

userId - String - userId of user making request.

guid - String - unique id for the asset.

requestBody - containing: connectorInstanceId (String - (optional) id of connector in use (if any)), connectionName (String - (optional) name of the connection (extracted from the connector)), connectorType (String - (optional) type of connector in use (if any)), contextId (String - (optional) function name, or processId of the activity that the caller is performing), message (log record content).

Returns:

VoidResponse or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the log message to the audit log for this asset or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addTagToAsset

public GUIDResponse addTagToAsset(String userId,
                                  String guid,
                                  TagRequestBody requestBody)

Adds a new public tag to the asset's properties.

Parameters:

userId - String - userId of user making request.

guid - String - unique id for the asset.

requestBody - contains the name of the tag and (optional) description of the tag.

Returns:

GUIDResponse or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addPrivateTagToAsset

public GUIDResponse addPrivateTagToAsset(String userId,
                                         String guid,
                                         TagRequestBody requestBody)

Adds a new private tag to the asset's properties.

Parameters:

userId - String - userId of user making request.

guid - String - unique id for the asset.

requestBody - contains the name of the tag and (optional) description of the tag.

Returns:

GUIDResponse or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addRatingToAsset

public GUIDResponse addRatingToAsset(String userId,
                                     String guid,
                                     RatingRequestBody requestBody)

Adds a rating to the asset.

Parameters:

userId - String - userId of user making request.

guid - String - unique id for the asset.

requestBody - containing the StarRating and user review of asset.

Returns:

GUIDResponse or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addLikeToAsset

public GUIDResponse addLikeToAsset(String userId,
                                   String guid,
                                   NullRequestBody requestBody)

Adds a "Like" to the asset.

Parameters:

userId - String - userId of user making request.

guid - String - unique id for the asset.

requestBody - null request body to satisfy HTTP protocol.

Returns:

GUIDResponse or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addCommentToAsset

public GUIDResponse addCommentToAsset(String userId,
                                      String guid,
                                      CommentRequestBody requestBody)

Adds a comment to the asset.

Parameters:

userId - String - userId of user making request.

guid - String - unique id for the asset.

requestBody - containing type of comment enum and the text of the comment.

Returns:

GUIDResponse or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addCommentReply

public GUIDResponse addCommentReply(String userId,
                                    String commentGUID,
                                    CommentRequestBody requestBody)

Adds a reply to a comment.

Parameters:

userId - String - userId of user making request.

commentGUID - String - unique id for an existing comment. Used to add a reply to a comment.

requestBody - containing type of comment enum and the text of the comment.

Returns:

GUIDResponse or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeTag

public VoidResponse removeTag(String userId,
                              String guid,
                              NullRequestBody requestBody)

Removes a tag from the asset that was added by this user.

Parameters:

userId - String - userId of user making request.

guid - String - unique id for the tag.

requestBody - containing type of comment enum and the text of the comment.

Returns:

VoidResponse or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the asset properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removePrivateTag

public VoidResponse removePrivateTag(String userId,
                                     String guid,
                                     NullRequestBody requestBody)

Removes a tag from the asset that was added by this user.

Parameters:

userId - String - userId of user making request.

guid - String - unique id for the tag.

requestBody - null request body needed to satisfy the HTTP Post request

Returns:

VoidResponse or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the asset properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeRating

public VoidResponse removeRating(String userId,
                                 String guid,
                                 NullRequestBody requestBody)

Removes a star rating that was added to the asset by this user.

Parameters:

userId - String - userId of user making request.

guid - String - unique id for the rating object

requestBody - null request body needed to satisfy the HTTP Post request

Returns:

VoidResponse or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the asset properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeLike

public VoidResponse removeLike(String userId,
                               String guid,
                               NullRequestBody requestBody)

Removes a "Like" added to the asset by this user.

Parameters:

userId - String - userId of user making request.

guid - String - unique id for the like object

requestBody - null request body needed to satisfy the HTTP Post request

Returns:

VoidResponse or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the asset properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeComment

public VoidResponse removeComment(String userId,
                                  String guid,
                                  NullRequestBody requestBody)

Removes a comment added to the asset by this user.

Parameters:

userId - String - userId of user making request.

guid - String - unique id for the comment object

requestBody - null request body needed to satisfy the HTTP Post request

Returns:

VoidResponse or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the asset properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.