com.oracle.sites.visitors.api.providers

Interface IdentityProvider

All Known Implementing Classes:

BaseIdentityProvider

public interface IdentityProvider

The interface to be implemented for providing visitor identification logic. This is the first component in Visitor Service which receives the request object and returns an 'Identity' object containing name of profile provider and some user id of the visitor in that profile storage. It may use the entities present in HttpRequest object, e.g. request header, cookie, or query parameter to do its job.

Method Summary

Modifier and Type	Method and Description
String	getProviderName()
Identity	getVisitorIdentity(javax.servlet.http.HttpServletRequest request)
void	setProviderConfig(Properties config) This is called by Visitor Service framework to populate configuration from optional field 'Configuration' in identity provider asset in Sites.

Method Detail

getProviderName

String getProviderName()

Returns:

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

setProviderConfig

void setProviderConfig(Properties config)

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

Parameters:

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

getVisitorIdentity

Identity getVisitorIdentity(javax.servlet.http.HttpServletRequest request)

Parameters:

request - - HttpRequest object

Returns:

If the user can be identified, an Identity object containing profile provider name and user id of the visitor in that profile storage. The 'user id' is mapped to some particular field in that profile storage, which is known to profile provider through some configuration. For example, in case of LDAP profile provider, its configuration field contains an attribute 'loginattributename'. If its value is 'dn', the value of user id should be a 'dn' attribute of some valid user in LDAP. If user could not be identified, it can either return NULL or an Identity object with provider name as internal and userdn NULL.