org.eclipse.higgins.userprofile
Interface ICardUsageManager

All Known Implementing Classes:

MemCardUsageManager

public interface ICardUsageManager

Author:

PilipenkoYN

Method Summary

CardUsage	addCardHistory(org.eclipse.higgins.icard.CUID cuid, URI uri) Deprecated.
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 site) Deprecated.
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) Deprecated.
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 site) Deprecated.
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) Deprecated.
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) Deprecated.
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) Deprecated.
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) Deprecated.
CardUsage	setUsedAlways(org.eclipse.higgins.icard.CUID cuid, WebForm form) Remembers this card for this site and form for subsequent zero-click logins

Method Detail

addCardHistory

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

Deprecated.

Adds info about card usage event

Returns:

newly added CardUsage object

Throws:

UserProfileException

addCardHistory

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

Adds info about card usage event

Returns:

newly added CardUsage object

Throws:

UserProfileException

getCardHistory

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

Returns the card usage history

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

Returns the card usage history in a paging manner

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

Returns the total size of history for paging output

Returns:

Throws:

UserProfileException

clearCardHistory

public void clearCardHistory(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:

cuid -

Throws:

UserProfileException

clearCardHistory

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

Deprecated.

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:

cuid -

Throws:

UserProfileException

clearCardHistory

public void clearCardHistory(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:

cuid -

form -

Throws:

UserProfileException

setUsedAlways

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

Deprecated.

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

Parameters:

cuid -

Returns:

CardUsage object with just added card-URI relation

Throws:

UserProfileException

setUsedAlways

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

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

Parameters:

cuid -

form -

Returns:

CardUsage object with just added card-URI relation

Throws:

UserProfileException

deleteUsedAlways

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

Deprecated.

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

Parameters:

cuid -

Returns:

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

Throws:

UserProfileException

deleteUsedAlways

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

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

Parameters:

cuid -

form -

Returns:

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

Throws:

UserProfileException

setOptionalClaims

public void setOptionalClaims(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:

cuid -

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

Throws:

UserProfileException

setOptionalClaims

public void setOptionalClaims(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:

cuid -

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

Throws:

UserProfileException

getOptionalClaims

public Set getOptionalClaims(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:

cuid -

Returns:

Set of URIs of remebered claim types

Throws:

UserProfileException

getOptionalClaims

public Set getOptionalClaims(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:

cuid -

form -

Returns:

Set of URIs of remebered claim types

Throws:

UserProfileException

getUsedCards

public List getUsedCards(URI uri)
                  throws UserProfileException

Deprecated.

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

Returns:

Throws:

UserProfileException

getUsedCards

public List getUsedCards(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:

form - - web form on the site

Returns:

the List of CardUsage objects

Throws:

UserProfileException

getUsedAlwaysURLs

public List getUsedAlwaysURLs(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:

cuid -

Returns:

List

Throws:

UserProfileException

getUsedAlwaysCard

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

Deprecated.

Returns the card remembered for the given site

Returns:

Throws:

UserProfileException

getUsedAlwaysCard

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

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

Returns:

Throws:

UserProfileException

clearUsedAlwaysURLs

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

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

Parameters:

cuid -

Throws:

UserProfileException

getCardUsageSummary

public List getCardUsageSummary(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:

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

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

Parameters:

cuid -

startFrom -

size -

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

desc -

Returns:

Throws:

UserProfileException

getSummaryTotalSize

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

Parameters:

cuid -

Returns:

Throws:

UserProfileException

getClaimValuesMRU

public Map getClaimValuesMRU()
                      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

Returns:

Throws:

UserProfileException

getClaimValuesMRU

public Set getClaimValuesMRU(String claimType)
                      throws UserProfileException

Return remembered claim values for the specified claim type

Parameters:

claimType -

Returns:

Throws:

UserProfileException

setClaimValuesMRU

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

Set the values for the specified claim type

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

save

public void save()
          throws UserProfileException

Commits changes

Throws:

UserProfileException

close

public void close()
           throws UserProfileException

Closes session

Throws:

UserProfileException