org.symphonyoss.symphony.messageml.util

Interface IDataProvider

public interface IDataProvider

Used during message parsing to provide external data.

Since:

6/7/16

Author:

bruce.skingle, lukasz

Method Summary

Modifier and Type	Method and Description
IUserPresentation	getUserPresentation(Long uid) Retrieve user information object based on UID
IUserPresentation	getUserPresentation(String emailAddress) Retrieve user information object based on user email
void	validateURI(URI uri) Check an URI against a whitelist of supported protocols.

Method Detail

getUserPresentation

IUserPresentation getUserPresentation(String emailAddress)
                               throws InvalidInputException

Retrieve user information object based on user email

Parameters:

emailAddress - Email of the user whose information to retrieve

Returns:

User presentation object

Throws:

InvalidInputException

getUserPresentation

IUserPresentation getUserPresentation(Long uid)
                               throws InvalidInputException

Retrieve user information object based on UID

Parameters:

uid - UID of the user whose information to retrieve

Returns:

User presentation object

Throws:

InvalidInputException

validateURI

void validateURI(URI uri)
          throws InvalidInputException,
                 ProcessingException

Check an URI against a whitelist of supported protocols.

Parameters:

uri - the URI to check

Throws:

InvalidInputException - thrown if the URI protocol is not supported

ProcessingException - thrown on a malformed URI or a backend error