com.oracle.sites.visitors.api.providers

Interface ProfileProvider

All Known Implementing Classes:

BaseProfileProvider

public interface ProfileProvider

The interface to be implemented for interfacing with profile data present in external storage systems. (for example, CRM,LDAP and custom repositories). 'Interfacing' means querying for visitor data from these systems.

Method Summary

Modifier and Type	Method and Description
RawProfile	getProfile(String dn)
String	getProviderName()
List<RawProfile>	search(String attribute, String value)
void	setProviderConfig(Properties config) This is called by Visitor Service framework to populate configuration from optional field 'Configuration' in profile provider asset in Sites.

Method Detail

getProviderName

String getProviderName()

Returns:

Name of Profile Provider (an instance of asset type WCS_ProfileProviders in Sites).

getProfile

RawProfile getProfile(String dn)

Parameters:

dn - - value of an attribute that identifies a visitor in a profile storage. The attribute name for which value belong is known to profile provider through its configuration generally.

Returns:

a RawProfile of the user.

search

List<RawProfile> search(String attribute,
                        String value)

Parameters:

attribute - - Name of attribute

value - - value of attribute to be matched against

Returns:

list of profiles in external storage having same value 'value' for attribute 'attribute'

setProviderConfig

void setProviderConfig(Properties config)

This is called by Visitor Service framework to populate configuration from optional field 'Configuration' in profile provider asset in Sites.

Parameters:

config - - value from field 'Configuration' in profile provider asset in Sites.