org.eclipse.higgins.userprofile.inmem
Class MemCardUsageManager

java.lang.Object
  org.eclipse.higgins.userprofile.inmem.MemCardUsageManager

All Implemented Interfaces:

ICardUsageManager

public class MemCardUsageManager

extends Object

implements ICardUsageManager

Author:

PilipenkoYN

Constructor Summary

MemCardUsageManager()

Method Summary

CardUsage	addCardHistory(org.eclipse.higgins.icard.CUID cuid, URI uri) Adds info about card usage event
CardUsage	addCardHistory(org.eclipse.higgins.icard.CUID cuid, WebForm form) Adds info about card usage event
void	clearCardHistory(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(org.eclipse.higgins.icard.CUID cuid, URI uri) Deletes one usage event of the given card on the given site unless it is checked as "Use Always".
void	clearCardHistory(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(org.eclipse.higgins.icard.CUID cuid) Deletes state "Use Always" on all web forms for the given card
void	close() Closes session
CardUsage	deleteUsedAlways(org.eclipse.higgins.icard.CUID cuid, URI uri) Deletes the "Use Always" relation between this card and this site
CardUsage	deleteUsedAlways(org.eclipse.higgins.icard.CUID cuid, WebForm form) Deletes the "Use Always" relation between this card and this site and form
List	getCardHistory(org.eclipse.higgins.icard.CUID cuid) Returns the card usage history
List	getCardHistory(org.eclipse.higgins.icard.CUID cuid, int startFrom, int size, String orderBy, boolean desc) Returns the card usage history in a paging manner
List	getCardUsageSummary(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(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
Map	getClaimValuesMRU() 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(String claimType) Return remembered claim values for the specified claim type
int	getHistoryTotalSize(org.eclipse.higgins.icard.CUID cuid) Returns the total size of history for paging output
Set	getOptionalClaims(org.eclipse.higgins.icard.CUID cuid, URI uri) 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
Set	getOptionalClaims(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
int	getSummaryTotalSize(org.eclipse.higgins.icard.CUID cuid)
org.eclipse.higgins.icard.CUID	getUsedAlwaysCard(URI uri) Returns the card remembered for the given site
org.eclipse.higgins.icard.CUID	getUsedAlwaysCard(WebForm form) Returns the card remembered for the given web form on the site
List	getUsedAlwaysURLs(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(URI uri) Returns the List of CardUsage objects of all the cards, which ever been logged in to this site
List	getUsedCards(WebForm form) Returns the List of CardUsage objects of all the cards, which ever been logged into site with the given form
void	save() Commits changes
void	setClaimValuesMRU(String claimType, Set claimValues) Set the values for the specified claim type
void	setOptionalClaims(org.eclipse.higgins.icard.CUID cuid, URI site, Set optionalClaims) 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
void	setOptionalClaims(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
CardUsage	setUsedAlways(org.eclipse.higgins.icard.CUID cuid, URI uri) Remembers this card for this site for subsequent zero-click logins
CardUsage	setUsedAlways(org.eclipse.higgins.icard.CUID cuid, URI uri, Set optionalClaims)
CardUsage	setUsedAlways(org.eclipse.higgins.icard.CUID cuid, WebForm form) Remembers this card for this site and form for subsequent zero-click logins

Methods inherited from class java.lang.Object

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

Constructor Detail

MemCardUsageManager

public MemCardUsageManager()

Method Detail

addCardHistory

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

Description copied from interface: ICardUsageManager

Adds info about card usage event

Specified by:

addCardHistory in interface ICardUsageManager

Returns:

newly added CardUsage object

Throws:

UserProfileException

clearCardHistory

public void clearCardHistory(org.eclipse.higgins.icard.CUID cuid)
                      throws UserProfileException

Description copied from interface: ICardUsageManager

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

Specified by:

clearCardHistory in interface ICardUsageManager

Parameters:

cuid -

Throws:

UserProfileException

clearUsedAlwaysURLs

public void clearUsedAlwaysURLs(org.eclipse.higgins.icard.CUID cuid)
                         throws UserProfileException

Description copied from interface: ICardUsageManager

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

Specified by:

clearUsedAlwaysURLs in interface ICardUsageManager

Parameters:

cuid -

Throws:

UserProfileException

close

public void close()
           throws UserProfileException

Description copied from interface: ICardUsageManager

Closes session

Specified by:

close in interface ICardUsageManager

Throws:

UserProfileException

deleteUsedAlways

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

Description copied from interface: ICardUsageManager

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

Specified by:

deleteUsedAlways in interface ICardUsageManager

Parameters:

cuid -

Returns:

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

Throws:

UserProfileException

getCardHistory

public List getCardHistory(org.eclipse.higgins.icard.CUID cuid)
                    throws UserProfileException

Description copied from interface: ICardUsageManager

Returns the card usage history

Specified by:

getCardHistory in interface ICardUsageManager

Parameters:

cuid -

Returns:

Array List of CardUsage objects

Throws:

UserProfileException

getCardHistory

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

Description copied from interface: ICardUsageManager

Returns the card usage history in a paging manner

Specified by:

getCardHistory in interface ICardUsageManager

Parameters:

cuid -

startFrom -

size -

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

desc -

Returns:

Throws:

UserProfileException

getCardUsageSummary

public List getCardUsageSummary(org.eclipse.higgins.icard.CUID cuid)
                         throws UserProfileException

Description copied from interface: ICardUsageManager

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

Specified by:

getCardUsageSummary in interface ICardUsageManager

Parameters:

cuid -

Returns:

List of CardUsage objects

Throws:

UserProfileException

getCardUsageSummary

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

Description copied from interface: ICardUsageManager

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

Specified by:

getCardUsageSummary in interface ICardUsageManager

Parameters:

cuid -

startFrom -

size -

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

desc -

Returns:

Throws:

UserProfileException

getHistoryTotalSize

public int getHistoryTotalSize(org.eclipse.higgins.icard.CUID cuid)
                        throws UserProfileException

Description copied from interface: ICardUsageManager

Returns the total size of history for paging output

Specified by:

getHistoryTotalSize in interface ICardUsageManager

Returns:

Throws:

UserProfileException

getSummaryTotalSize

public int getSummaryTotalSize(org.eclipse.higgins.icard.CUID cuid)
                        throws UserProfileException

Specified by:

getSummaryTotalSize in interface ICardUsageManager

Parameters:

cuid -

Returns:

Throws:

UserProfileException

getUsedAlwaysCard

public org.eclipse.higgins.icard.CUID getUsedAlwaysCard(URI uri)
                                                 throws UserProfileException

Description copied from interface: ICardUsageManager

Returns the card remembered for the given site

Specified by:

getUsedAlwaysCard in interface ICardUsageManager

Returns:

Throws:

UserProfileException

getUsedAlwaysURLs

public List getUsedAlwaysURLs(org.eclipse.higgins.icard.CUID cuid)
                       throws UserProfileException

Description copied from interface: ICardUsageManager

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

Specified by:

getUsedAlwaysURLs in interface ICardUsageManager

Parameters:

cuid -

Returns:

List

Throws:

UserProfileException

getUsedCards

public List getUsedCards(URI uri)
                  throws UserProfileException

Description copied from interface: ICardUsageManager

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

Specified by:

getUsedCards in interface ICardUsageManager

Returns:

Throws:

UserProfileException

setUsedAlways

public CardUsage setUsedAlways(org.eclipse.higgins.icard.CUID cuid,
                               URI uri,
                               Set optionalClaims)
                        throws UserProfileException

Throws:

UserProfileException

getOptionalClaims

public Set getOptionalClaims(org.eclipse.higgins.icard.CUID cuid,
                             URI uri)
                      throws UserProfileException

Description copied from interface: ICardUsageManager

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

Specified by:

getOptionalClaims in interface ICardUsageManager

Parameters:

cuid -

Returns:

Set of URIs of remebered claim types

Throws:

UserProfileException

getClaimValuesMRU

public Map getClaimValuesMRU()
                      throws UserProfileException

Description copied from interface: ICardUsageManager

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

Specified by:

getClaimValuesMRU in interface ICardUsageManager

Returns:

Throws:

UserProfileException

getClaimValuesMRU

public Set getClaimValuesMRU(String claimType)
                      throws UserProfileException

Description copied from interface: ICardUsageManager

Return remembered claim values for the specified claim type

Specified by:

getClaimValuesMRU in interface ICardUsageManager

Parameters:

claimType -

Returns:

Throws:

UserProfileException

setClaimValuesMRU

public void setClaimValuesMRU(String claimType,
                              Set claimValues)
                       throws UserProfileException

Description copied from interface: ICardUsageManager

Set the values for the specified claim type

Specified by:

setClaimValuesMRU in interface ICardUsageManager

Parameters:

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

setOptionalClaims

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

Description copied from interface: ICardUsageManager

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

Specified by:

setOptionalClaims in interface ICardUsageManager

Parameters:

cuid -

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

Throws:

UserProfileException

setUsedAlways

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

Description copied from interface: ICardUsageManager

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

Specified by:

setUsedAlways in interface ICardUsageManager

Parameters:

cuid -

Returns:

CardUsage object with just added card-URI relation

Throws:

UserProfileException

clearCardHistory

public void clearCardHistory(org.eclipse.higgins.icard.CUID cuid,
                             URI uri)
                      throws UserProfileException

Description copied from interface: ICardUsageManager

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.

Specified by:

clearCardHistory in interface ICardUsageManager

Parameters:

cuid -

Throws:

UserProfileException

deleteUsedAlways

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

Description copied from interface: ICardUsageManager

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

Specified by:

deleteUsedAlways in interface ICardUsageManager

Parameters:

cuid -

form -

Returns:

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

Throws:

UserProfileException

getOptionalClaims

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

Description copied from interface: ICardUsageManager

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

Specified by:

getOptionalClaims in interface ICardUsageManager

Parameters:

cuid -

form -

Returns:

Set of URIs of remebered claim types

Throws:

UserProfileException

getUsedAlwaysCard

public org.eclipse.higgins.icard.CUID getUsedAlwaysCard(WebForm form)
                                                 throws UserProfileException

Description copied from interface: ICardUsageManager

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

Specified by:

getUsedAlwaysCard in interface ICardUsageManager

Returns:

Throws:

UserProfileException

getUsedCards

public List getUsedCards(WebForm form)
                  throws UserProfileException

Description copied from interface: ICardUsageManager

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

Specified by:

getUsedCards in interface ICardUsageManager

Parameters:

form - - web form on the site

Returns:

the List of CardUsage objects

Throws:

UserProfileException

setOptionalClaims

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

Description copied from interface: ICardUsageManager

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

Specified by:

setOptionalClaims in interface ICardUsageManager

Parameters:

cuid -

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

Throws:

UserProfileException

setUsedAlways

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

Description copied from interface: ICardUsageManager

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

Specified by:

setUsedAlways in interface ICardUsageManager

Parameters:

cuid -

form -

Returns:

CardUsage object with just added card-URI relation

Throws:

UserProfileException

addCardHistory

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

Description copied from interface: ICardUsageManager

Adds info about card usage event

Specified by:

addCardHistory in interface ICardUsageManager

Returns:

newly added CardUsage object

Throws:

UserProfileException

clearCardHistory

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

Description copied from interface: ICardUsageManager

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.

Specified by:

clearCardHistory in interface ICardUsageManager

Parameters:

cuid -

form -

Throws:

UserProfileException

save

public void save()
          throws UserProfileException

Description copied from interface: ICardUsageManager

Commits changes

Specified by:

save in interface ICardUsageManager

Throws:

UserProfileException