org.eclipse.higgins.user.profile
Interface IUserProfileService

public interface IUserProfileService

Method Summary

Captcha	addCaptcha(Captcha captcha)
CardUsage	addCardHistory(Serializable userId, org.eclipse.higgins.icard.CUID cuid, URI uri) Deprecated.
CardUsage	addCardHistory(Serializable userId, org.eclipse.higgins.icard.CUID cuid, WebForm form) Adds info about card usage event
Category	addCategory(Serializable userId, Category category)
SelectorClient	addSelectorClient(Serializable userId, SelectorClient selectorClient)
UserProfile	addUserProfile(Serializable userId, UserProfile userProfile)
CardInformation	clearCardCredential(Serializable userId, org.eclipse.higgins.icard.CUID cuid) Clears credential information for the given card.
void	clearCardHistory(Serializable userId, org.eclipse.higgins.icard.CUID cuid) Deletes all the usage events of the given card on all URIs unless it is checked as "Use Always".
void	clearCardHistory(Serializable userId, org.eclipse.higgins.icard.CUID cuid, URI site) Deletes one usage event of the given card on the given site unless it is checked as "Use Always".
void	clearCardHistory(Serializable userId, org.eclipse.higgins.icard.CUID cuid, WebForm form) Deletes one usage event of the given card on the given site unless it is checked as "Use Always".
void	clearUsedAlwaysURLs(Serializable userId, org.eclipse.higgins.icard.CUID cuid) Deletes state "Use Always" on all web forms for the given card
void	deleteCaptcha(Captcha captcha)
void	deleteCaptcha(String captchaID)
void	deleteCategory(Serializable userId, String categoryId)
void	deleteSelectorClient(Serializable userId, String selectorClientId)
CardUsage	deleteUsedAlways(Serializable userId, org.eclipse.higgins.icard.CUID cuid, URI uri) Deprecated.
CardUsage	deleteUsedAlways(Serializable userId, org.eclipse.higgins.icard.CUID cuid, WebForm form) Deletes the "Use Always" relation between this card and this site and form
void	deleteUserProfile(Serializable userId)
Captcha	getCaptcha(String captchaID)
List	getCardHistory(Serializable userId, org.eclipse.higgins.icard.CUID cuid) Returns the card usage history
List	getCardHistory(Serializable userId, org.eclipse.higgins.icard.CUID cuid, int startFrom, int size, String orderBy, boolean desc) Returns the card usage history in a paging manner
CardInformation	getCardInformation(Serializable userId, org.eclipse.higgins.icard.CUID cuid) Returns the whole information about the given card
List	getCardUsageSummary(Serializable userId, org.eclipse.higgins.icard.CUID cuid) Returns card relations to web site forms with last used dates and state remembered it on this site and form or not
List	getCardUsageSummary(Serializable userId, org.eclipse.higgins.icard.CUID cuid, int startFrom, int size, String orderBy, boolean desc) Returns card relations to URI with last used dates and state remembered it on this site or not
List	getCategories(Serializable userId)
Map	getClaimValuesMRU(Serializable userId) Return all the remembered claim values by types in a map where key is claim type and value is Set of claim values
Set	getClaimValuesMRU(Serializable userId, String claimType) Return remembered claim values for the specified claim type
int	getHistoryTotalSize(Serializable userId, org.eclipse.higgins.icard.CUID cuid) Returns the total size of history for paging output
Set	getOptionalClaims(Serializable userId, org.eclipse.higgins.icard.CUID cuid, URI site) Deprecated.
Set	getOptionalClaims(Serializable userId, org.eclipse.higgins.icard.CUID cuid, WebForm form) Returns list of the remembered optional claim types of the given card which will be used on the given site when zero-click login occurs
PolicyVersion	getRPPolicyVersion(Serializable userId, WebForm form) Returns class that manages all Card usage and URI relations information
List	getSelectorClients(Serializable userId)
int	getSummaryTotalSize(Serializable userId, org.eclipse.higgins.icard.CUID cuid)
org.eclipse.higgins.icard.CUID	getUsedAlwaysCard(Serializable userId, URI uri) Deprecated.
org.eclipse.higgins.icard.CUID	getUsedAlwaysCard(Serializable userId, WebForm form) Returns the card remembered for the given web form on the site
List	getUsedAlwaysURLs(Serializable userId, org.eclipse.higgins.icard.CUID cuid) Returns the List of CardUsage objects with web form info for which the given card is remembered
List	getUsedCards(Serializable userId, URI uri) Deprecated.
List	getUsedCards(Serializable userId, WebForm form) Returns the List of CardUsage objects of all the cards, which ever been logged into site with the given form
UserProfile	getUserProfile(Serializable userId)
Captcha	modifyCaptcha(Captcha captcha)
Category	modifyCategory(Serializable userId, Category category)
SelectorClient	modifySelectorClient(Serializable userId, SelectorClient selectorClient)
UserProfile	modifyUserProfile(Serializable userId, UserProfile userProfile)
CardInformation	setCardCredential(Serializable userId, org.eclipse.higgins.icard.CUID cuid, CardCredential cardCredential) Sets credential information for the given card.
void	setClaimValuesMRU(Serializable userId, String claimType, Set claimValues) Set the values for the specified claim type
void	setOptionalClaims(Serializable userId, org.eclipse.higgins.icard.CUID cuid, URI site, Set optionalClaims) Deprecated.
void	setOptionalClaims(Serializable userId, org.eclipse.higgins.icard.CUID cuid, WebForm from, Set optionalClaims) Remembers the list of optional claim types of the card that are need to be used during subsequent zero-click logins with the given form on the site
void	setRPPolicyVersion(Serializable userId, PolicyVersion policyVersion)
CardUsage	setUsedAlways(Serializable userId, org.eclipse.higgins.icard.CUID cuid, URI uri) Deprecated.
CardUsage	setUsedAlways(Serializable userId, org.eclipse.higgins.icard.CUID cuid, WebForm form) Remembers this card for this site and form for subsequent zero-click logins

Method Detail

getUserProfile

UserProfile getUserProfile(Serializable userId)
                           throws UserProfileException

Parameters:

userId -

Returns:

Throws:

UserProfileException

addUserProfile

UserProfile addUserProfile(Serializable userId,
                           UserProfile userProfile)
                           throws UserProfileException

Parameters:

userId -

userProfile -

Returns:

Throws:

UserProfileException

modifyUserProfile

UserProfile modifyUserProfile(Serializable userId,
                              UserProfile userProfile)
                              throws UserProfileException

Parameters:

userId -

userProfile -

Returns:

Throws:

UserProfileException

deleteUserProfile

void deleteUserProfile(Serializable userId)
                       throws UserProfileException

Parameters:

userID -

Throws:

UserProfileException

getCategories

List getCategories(Serializable userId)
                   throws UserProfileException

Parameters:

userId -

Returns:

List object with all user categories.

Throws:

UserProfileException

addCategory

Category addCategory(Serializable userId,
                     Category category)
                     throws UserProfileException

Parameters:

userId -

category -

Returns:

Throws:

UserProfileException

modifyCategory

Category modifyCategory(Serializable userId,
                        Category category)
                        throws UserProfileException

Parameters:

userId -

category -

Returns:

Throws:

UserProfileException

deleteCategory

void deleteCategory(Serializable userId,
                    String categoryId)
                    throws UserProfileException

Parameters:

userId -

categoryId -

Throws:

UserProfileException

setCardCredential

CardInformation setCardCredential(Serializable userId,
                                  org.eclipse.higgins.icard.CUID cuid,
                                  CardCredential cardCredential)
                                  throws UserProfileException

Sets credential information for the given card.

Parameters:

userId -

cuid -

cardCredential -

Returns:

CardInformation object with all related card information, or null if card info not found

Throws:

UserProfileException

clearCardCredential

CardInformation clearCardCredential(Serializable userId,
                                    org.eclipse.higgins.icard.CUID cuid)
                                    throws UserProfileException

Clears credential information for the given card.

Parameters:

userId -

cuid -

Returns:

CardInformation object with all related card information, or null if card info not found

Throws:

UserProfileException

getCardInformation

CardInformation getCardInformation(Serializable userId,
                                   org.eclipse.higgins.icard.CUID cuid)
                                   throws UserProfileException

Returns the whole information about the given card

Parameters:

userId -

cuid -

Returns:

Throws:

UserProfileException

getRPPolicyVersion

PolicyVersion getRPPolicyVersion(Serializable userId,
                                 WebForm form)
                                 throws UserProfileException

Returns class that manages all Card usage and URI relations information

Parameters:

userId -

Returns:

Throws:

UserProfileException

setRPPolicyVersion

void setRPPolicyVersion(Serializable userId,
                        PolicyVersion policyVersion)
                        throws UserProfileException

Throws:

UserProfileException

getCaptcha

Captcha getCaptcha(String captchaID)
                   throws UserProfileException

Parameters:

captchaID -

Returns:

Throws:

UserProfileException

addCaptcha

Captcha addCaptcha(Captcha captcha)
                   throws UserProfileException

Parameters:

captcha -

Returns:

Throws:

UserProfileException

deleteCaptcha

void deleteCaptcha(Captcha captcha)
                   throws UserProfileException

Parameters:

captcha -

Throws:

UserProfileException

deleteCaptcha

void deleteCaptcha(String captchaID)
                   throws UserProfileException

Parameters:

captchaID -

Throws:

UserProfileException

modifyCaptcha

Captcha modifyCaptcha(Captcha captcha)
                      throws UserProfileException

Parameters:

captcha -

Returns:

Throws:

UserProfileException

addCardHistory

CardUsage addCardHistory(Serializable userId,
                         org.eclipse.higgins.icard.CUID cuid,
                         URI uri)
                         throws UserProfileException

Deprecated.

Adds info about card usage event

Parameters:

userId -

cuid -

uri -

Returns:

newly added CardUsage object

Throws:

UserProfileException

addCardHistory

CardUsage addCardHistory(Serializable userId,
                         org.eclipse.higgins.icard.CUID cuid,
                         WebForm form)
                         throws UserProfileException

Adds info about card usage event

Parameters:

userId -

cuid -

form -

Returns:

newly added CardUsage object

Throws:

UserProfileException

getCardHistory

List getCardHistory(Serializable userId,
                    org.eclipse.higgins.icard.CUID cuid)
                    throws UserProfileException

Returns the card usage history

Parameters:

userId -

cuid -

Returns:

List of CardUsage objects

Throws:

UserProfileException

getCardHistory

List getCardHistory(Serializable userId,
                    org.eclipse.higgins.icard.CUID cuid,
                    int startFrom,
                    int size,
                    String orderBy,
                    boolean desc)
                    throws UserProfileException

Returns the card usage history in a paging manner

Parameters:

userId -

cuid -

startFrom -

size -

orderBy - - string constants from CardUsage class, by what field to order output

desc -

Returns:

Throws:

UserProfileException

getHistoryTotalSize

int getHistoryTotalSize(Serializable userId,
                        org.eclipse.higgins.icard.CUID cuid)
                        throws UserProfileException

Returns the total size of history for paging output

Parameters:

userId -

cuid -

Returns:

Throws:

UserProfileException

clearCardHistory

void clearCardHistory(Serializable userId,
                      org.eclipse.higgins.icard.CUID cuid)
                      throws UserProfileException

Deletes all the usage events of the given card on all URIs unless it is checked as "Use Always".

Parameters:

userId -

cuid -

Throws:

UserProfileException

clearCardHistory

void clearCardHistory(Serializable userId,
                      org.eclipse.higgins.icard.CUID cuid,
                      URI site)
                      throws UserProfileException

Deletes one usage event of the given card on the given site unless it is checked as "Use Always". If it is checked clears only Last Used Date.

Parameters:

userId -

cuid -

site -

Throws:

UserProfileException

clearCardHistory

void clearCardHistory(Serializable userId,
                      org.eclipse.higgins.icard.CUID cuid,
                      WebForm form)
                      throws UserProfileException

Deletes one usage event of the given card on the given site unless it is checked as "Use Always". If it is checked clears only Last Used Date.

Parameters:

userId -

cuid -

form -

Throws:

UserProfileException

setUsedAlways

CardUsage setUsedAlways(Serializable userId,
                        org.eclipse.higgins.icard.CUID cuid,
                        URI uri)
                        throws UserProfileException

Deprecated.

Remembers this card for this site for subsequent zero-click logins

Parameters:

userId -

cuid -

uri -

Returns:

CardUsage object with just added card-URI relation

Throws:

UserProfileException

setUsedAlways

CardUsage setUsedAlways(Serializable userId,
                        org.eclipse.higgins.icard.CUID cuid,
                        WebForm form)
                        throws UserProfileException

Remembers this card for this site and form for subsequent zero-click logins

Parameters:

userId -

cuid -

form -

Returns:

CardUsage object with just added card-URI relation

Throws:

UserProfileException

deleteUsedAlways

CardUsage deleteUsedAlways(Serializable userId,
                           org.eclipse.higgins.icard.CUID cuid,
                           URI uri)
                           throws UserProfileException

Deprecated.

Deletes the "Use Always" relation between this card and this site

Parameters:

userId -

cuid -

uri -

Returns:

CardInformation object with all related card information, or null if card info not found

Throws:

UserProfileException

deleteUsedAlways

CardUsage deleteUsedAlways(Serializable userId,
                           org.eclipse.higgins.icard.CUID cuid,
                           WebForm form)
                           throws UserProfileException

Deletes the "Use Always" relation between this card and this site and form

Parameters:

userId -

cuid -

form -

Returns:

CardInformation object with all related card information, or null if card info not found

Throws:

UserProfileException

setOptionalClaims

void setOptionalClaims(Serializable userId,
                       org.eclipse.higgins.icard.CUID cuid,
                       URI site,
                       Set optionalClaims)
                       throws UserProfileException

Deprecated.

Remembers the list of optional claim types of the card that are need to be used during subsequent zero-click logins to the given site

Parameters:

userId -

cuid -

site -

optionalClaims - Set of String claim types, when null - clears all claim types

Throws:

UserProfileException

setOptionalClaims

void setOptionalClaims(Serializable userId,
                       org.eclipse.higgins.icard.CUID cuid,
                       WebForm from,
                       Set optionalClaims)
                       throws UserProfileException

Remembers the list of optional claim types of the card that are need to be used during subsequent zero-click logins with the given form on the site

Parameters:

userId -

cuid -

from -

optionalClaims - Set of String claim types, when null - clears all claim types

Throws:

UserProfileException

getOptionalClaims

Set getOptionalClaims(Serializable userId,
                      org.eclipse.higgins.icard.CUID cuid,
                      URI site)
                      throws UserProfileException

Deprecated.

Returns list of the remembered optional claim types of the given card which will be used on the given site when zero-click login occurs

Parameters:

userId -

cuid -

uri -

Returns:

Set of URIs of remebered claim types

Throws:

UserProfileException

getOptionalClaims

Set getOptionalClaims(Serializable userId,
                      org.eclipse.higgins.icard.CUID cuid,
                      WebForm form)
                      throws UserProfileException

Returns list of the remembered optional claim types of the given card which will be used on the given site when zero-click login occurs

Parameters:

userId -

cuid -

form -

Returns:

Set of URIs of remebered claim types

Throws:

UserProfileException

getUsedCards

List getUsedCards(Serializable userId,
                  URI uri)
                  throws UserProfileException

Deprecated.

Returns the List of CardUsage objects of all the cards, which ever been logged in to this site

Parameters:

userId -

uri -

Returns:

Throws:

UserProfileException

getUsedCards

List getUsedCards(Serializable userId,
                  WebForm form)
                  throws UserProfileException

Returns the List of CardUsage objects of all the cards, which ever been logged into site with the given form

Parameters:

userId -

form - - web form on the site

Returns:

the List of CardUsage objects

Throws:

UserProfileException

getUsedAlwaysURLs

List getUsedAlwaysURLs(Serializable userId,
                       org.eclipse.higgins.icard.CUID cuid)
                       throws UserProfileException

Returns the List of CardUsage objects with web form info for which the given card is remembered

Parameters:

userId -

cuid -

Returns:

List

Throws:

UserProfileException

getUsedAlwaysCard

org.eclipse.higgins.icard.CUID getUsedAlwaysCard(Serializable userId,
                                                 URI uri)
                                                 throws UserProfileException

Deprecated.

Returns the card remembered for the given site

Parameters:

userId -

uri -

Returns:

Throws:

UserProfileException

getUsedAlwaysCard

org.eclipse.higgins.icard.CUID getUsedAlwaysCard(Serializable userId,
                                                 WebForm form)
                                                 throws UserProfileException

Returns the card remembered for the given web form on the site

Parameters:

userId -

form -

Returns:

Throws:

UserProfileException

clearUsedAlwaysURLs

void clearUsedAlwaysURLs(Serializable userId,
                         org.eclipse.higgins.icard.CUID cuid)
                         throws UserProfileException

Deletes state "Use Always" on all web forms for the given card

Parameters:

userId -

cuid -

Throws:

UserProfileException

getCardUsageSummary

List getCardUsageSummary(Serializable userId,
                         org.eclipse.higgins.icard.CUID cuid)
                         throws UserProfileException

Returns card relations to web site forms with last used dates and state remembered it on this site and form or not

Parameters:

userId -

cuid -

Returns:

List of CardUsage objects

Throws:

UserProfileException

getCardUsageSummary

List getCardUsageSummary(Serializable userId,
                         org.eclipse.higgins.icard.CUID cuid,
                         int startFrom,
                         int size,
                         String orderBy,
                         boolean desc)
                         throws UserProfileException

Returns card relations to URI with last used dates and state remembered it on this site or not

Parameters:

userId -

cuid -

startFrom -

size -

orderBy - - string constants from CardUsage class, by what field to order output

desc -

Returns:

Throws:

UserProfileException

getSummaryTotalSize

int getSummaryTotalSize(Serializable userId,
                        org.eclipse.higgins.icard.CUID cuid)
                        throws UserProfileException

Parameters:

userId -

cuid -

Returns:

Throws:

UserProfileException

getClaimValuesMRU

Map getClaimValuesMRU(Serializable userId)
                      throws UserProfileException

Return all the remembered claim values by types in a map where key is claim type and value is Set of claim values

Parameters:

userId -

Returns:

Throws:

UserProfileException

getClaimValuesMRU

Set getClaimValuesMRU(Serializable userId,
                      String claimType)
                      throws UserProfileException

Return remembered claim values for the specified claim type

Parameters:

userId -

claimType -

Returns:

Throws:

UserProfileException

setClaimValuesMRU

void setClaimValuesMRU(Serializable userId,
                       String claimType,
                       Set claimValues)
                       throws UserProfileException

Set the values for the specified claim type

Parameters:

userId -

claimType - claimType for which to remember MRU claim values.

claimValues - - remembered MRU values for the claim type. If null or empty clears all the MRU claim values for the claim type.

Throws:

UserProfileException

addSelectorClient

SelectorClient addSelectorClient(Serializable userId,
                                 SelectorClient selectorClient)
                                 throws UserProfileException

Parameters:

userId -

selectorClient -

Returns:

Throws:

UserProfileException

modifySelectorClient

SelectorClient modifySelectorClient(Serializable userId,
                                    SelectorClient selectorClient)
                                    throws UserProfileException

Parameters:

userId -

selectorClient -

Returns:

Throws:

UserProfileException

deleteSelectorClient

void deleteSelectorClient(Serializable userId,
                          String selectorClientId)
                          throws UserProfileException

Parameters:

userId -

selectorClientId -

Throws:

UserProfileException

getSelectorClients

List getSelectorClients(Serializable userId)
                        throws UserProfileException

Parameters:

userId -

Returns:

Throws:

UserProfileException