org.eclipse.higgins.rpps.core
Interface IRppsService

All Known Implementing Classes:

RppsService

public interface IRppsService

The object used for executing Higgins API and returning the results it produces.

Author:

Sergei Yakovlev, Artem Verkhovets

Field Summary

static String	IPasswordCredential
static String	IPinCodeCredential
static String	ITSKerberosV5Credential
static String	ITSSelfIssuedCredential
static String	ITSSelfIssuedNonPinCredential
static String	ITSUsernamePasswordCredential
static String	ITSX509V3Credential
static String	IUsernamePasswordCredential

Method Summary

CategoryTO	addCategory(org.eclipse.higgins.user.login.UserAccount userAccount, CategoryTO categoryTO) Creates a new card's category.
void	addClaimValuesMRU(org.eclipse.higgins.user.login.UserAccount userAccount, String claimType, String claimValue) Adds most recently used record.
boolean	addRPEndPointCardRelation(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, RPEndPointTO rpEndPointTO) Create relation between card and relying party.
SelectorClientTO	addSelectorClient(org.eclipse.higgins.user.login.UserAccount userAccount, SelectorClientTO selectorClientTO) Register new selector client.
SelectorClientTO	addSelectorClient(org.eclipse.higgins.user.login.UserAccount userAccount, SelectorClientTO selectorClientTO, String otp) Check OTP and register new selector client.
boolean	addUrlCardRelation(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, String url) Deprecated.
ResponseMessage	addUserProfile(UserProfileTO userProfile, String password) Creates a new user profile.
org.eclipse.higgins.user.profile.entity.UserProfile	addUserProfileBase(UserProfileTO userProfile, String password) Creates a new user profile.
org.eclipse.higgins.user.login.UserAccount	authenticate(AuthCredentialTO authCredentialTO) Authenticate user by AuthCredentialTO.
org.eclipse.higgins.user.login.UserAccount	authenticate(String accessTokenId) Authenticate user by Access Token Id.
org.eclipse.higgins.user.login.UserAccount	authenticate(String userId, String password) Authenticate user with username password.
FormatDescriptorTO	checkImportStream(org.eclipse.higgins.user.login.UserAccount userAccount, byte[] crd) Checks whether RppsService can recognize data format of the provided input stream.
ICardTO	clearCardCredential(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid) Deletes saved authentication card information of the specified card.
boolean	clearCardHistory(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid) Deletes card history of the specified card on all URLs unless it is checked as "Use Always".
org.eclipse.higgins.user.profile.entity.Captcha	createCaptcha() Create new Captcha entity and store it via UserProfileService.
ICardTO	createDuplicateICard(org.eclipse.higgins.user.login.UserAccount userAccount, String cardName, String cuid, String pinCode) Creates duplicate of personal card only with new card's name.
ICardTO	createICard(org.eclipse.higgins.user.login.UserAccount userAccount, ICardTemplateTO template) Creates a new card by template.
String	createICardFromHBX(org.eclipse.higgins.user.login.UserAccount userAccount, String cardname) Deprecated.
void	deleteAllICard(org.eclipse.higgins.user.login.UserAccount userAccount) Deletes all user's card.
void	deleteCaptcha(String id) Delete Captcha entity via UserProfileService.
boolean	deleteCardHistoryRecord(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, RPEndPointTO rpEndPointTO) Delete specified record of card history.
boolean	deleteCardHistoryRecord(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, String url) Deprecated.
void	deleteCategory(org.eclipse.higgins.user.login.UserAccount userAccount, String categoryId) Delete the card's category.
ICardUpdateResponseTO	deleteICard(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid) Deletes specified card.
boolean	deleteRPEndPointCardRelation(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, RPEndPointTO rpEndPointTO) Delete relation between card and relying party.
boolean	deleteRPEndPointsCardsRelations(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid) Delete all relations between card and relying party.
void	deleteSelectorClient(org.eclipse.higgins.user.login.UserAccount userAccount, SelectorClientTO selectorClientTO) Delete SelectorClient.
boolean	deleteUrlCardRelation(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, String url) Deprecated.
boolean	deleteUrlsCardsRelations(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid) Deprecated.
ResponseMessage	deleteUserProfile(org.eclipse.higgins.user.login.UserAccount userAccount) Deletes user profile.
ICardTO	editPinCode(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, String oldPinCode, String newPinCode) Changes pin code for personal card.
byte[]	exportICards(org.eclipse.higgins.user.login.UserAccount userAccount, String formatID, String[] cards, UITokenServiceCredentialTO credential) Returns file as byte array with special which contains select cards.
void	generatePasswordResetCode(String userIdentifier) Generate and send user email with new password reset code.
org.eclipse.higgins.user.profile.entity.Captcha	getCaptcha(String id) Retrieve Captcha entity via UserProfileService.
CardUsageTO[]	getCardHistory(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, int startFrom, int capacity, String orderBy, String orderDirection) Return list of card history records, beginning at the specified position in selection.
CardInformationTO	getCardInformation(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, int size) Gets card information object.
CategoryTO[]	getCategory(org.eclipse.higgins.user.login.UserAccount userAccount) Gets list of card categories.
MapTO[]	getClaimValuesMRU(org.eclipse.higgins.user.login.UserAccount userAccount) Gets most recently used records.
ICardTO	getDefaultPCard(org.eclipse.higgins.user.login.UserAccount userAccount) Return default personal card.
ICardTO	getICardByCUID(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid) Gets a card by CUID.
ICardTO	getICardByCUIDAndTokenServiceCredential(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, UITokenServiceCredentialTO tokenCredential) This method gets the card with retrieved claims.
UIResponseCardTO	getICardClaims(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, String policy, String typeofCredential, String[] credentialKey, String[] credentialValue) Deprecated.
UIResponseCardTO	getICardClaims(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, String policy, String typeofCredential, String[] credentialKey, String[] credentialValue, RPEndPointTO rpEndPointTO) Created for some demo.
ICardTemplateTO[]	getICardCreationTemplate(org.eclipse.higgins.user.login.UserAccount userAccount) This method return list of card creation template as array of ICardTemplateTO.
org.eclipse.higgins.icard.ICardTemplate[]	getICardCreationTemplateByProvider(org.eclipse.higgins.user.login.UserAccount userAccount, String extID) This method return list of card creation template by provider id.
ICardsAndCategoryTO	getICardsAndCategoriesByUser(org.eclipse.higgins.user.login.UserAccount userAccount) This method gets the card list and category list of the specified user.
ICardTO[]	getICardsByCUIDs(org.eclipse.higgins.user.login.UserAccount userAccount, String[] cuids) This method gets cards as array of ICardTO by CUIDs array.
ICardTO[]	getICardsByFormat(org.eclipse.higgins.user.login.UserAccount userAccount, String formatID) Gets cards which may be export to special file format.
ICardResponseTO	getICardsByUser(org.eclipse.higgins.user.login.UserAccount userAccount) This method gets ICardResponseTO which contains the card list and card relation list of the specified user.
ImportCardInformationTO[]	getImportingCardsInformation(org.eclipse.higgins.user.login.UserAccount userAccount, byte[] crd, String formatID, UITokenServiceCredentialTO credential) Get information about cards which can be imported from passed data
void	getOTP(AuthCredentialTO authCredentialTO, String captchaId, String captchaResponse, String channel) Generate new one time password(OTP) and send it to user.
FormatDescriptorTO[]	getOutputFormats(org.eclipse.higgins.user.login.UserAccount userAccount) Gets available file format for cards export.
SelectorClientTO[]	getSelectorClients(org.eclipse.higgins.user.login.UserAccount userAccount) Return arrays of selector clients.
TokenResponseTO	getTokenByRPEndPoint(org.eclipse.higgins.user.login.UserAccount userAccount, String policy, String policytype, String sslCert, RPEndPointTO rpEndPointTO) Makes security token usage saved users information.
TokenResponseTO	getTokenByUrl(org.eclipse.higgins.user.login.UserAccount userAccount, String policy, String policytype, String sslCert, String url) Deprecated.
ExtraTokenResponseTO	getTokenExtraByRPEndPoint(org.eclipse.higgins.user.login.UserAccount userAccount, String policy, String policytype, String sslCert, RPEndPointTO rpEndPointTO) Makes security token with extra card's information usage saved users information.
ExtraTokenResponseTO	getTokenExtraByUrl(org.eclipse.higgins.user.login.UserAccount userAccount, String policy, String policytype, String sslCert, String url) Deprecated.
TokenResponseTO	getTokenObject(org.eclipse.higgins.user.login.UserAccount userAccount, String policy, String policytype, String sslCert, String[] cuids, String typeofCredential, String[] credentialKey, String[] credentialValue) Deprecated.
TokenResponseTO	getTokenObject(org.eclipse.higgins.user.login.UserAccount userAccount, String policy, String policytype, String sslCert, String[] cuids, String typeofCredential, String[] credentialKey, String[] credentialValue, RPEndPointTO rpEndPointTO) Given the Relying Party Agent (aka 'Requester')'s policy, identity information about the requester, and the set of one or more selections that the user has just made in the ISS Web UI (see userInterfaceRequest), AND presuming that the protocol involved in interacting with the RPA requires a security token, request the token that corresponds to the user's selection(s).
UIResponseTO	getUserInterface(org.eclipse.higgins.user.login.UserAccount userAccount, RPEndPointTO rpEndPointTO, String target, String sslCert, String policytype, String policy) This method takes as input a policy---for example, one that has been retrieved from the Relying Party Agent (called here the 'Requester')---as well as a description of the Requester.
UIResponseTO	getUserInterface(org.eclipse.higgins.user.login.UserAccount userAccount, String url, String target, String sslCert, String policytype, String policy) Deprecated.
UserProfileTO	getUserProfile(org.eclipse.higgins.user.login.UserAccount userAccount) Gets user profile as a UserProfileTO.
ICardResponseTO	importICards(org.eclipse.higgins.user.login.UserAccount userAccount, byte[] crd) Imports card from a file.
ICardResponseTO	importICards(org.eclipse.higgins.user.login.UserAccount userAccount, byte[] crd, String formatID, UITokenServiceCredentialTO credential) Import cards from special format file.
ICardResponseTO	importICards(org.eclipse.higgins.user.login.UserAccount userAccount, byte[] crd, String formatID, UITokenServiceCredentialTO credential, Boolean[] importFlag) Import cards from special format file.
ResponseMessage	modifyCategories(org.eclipse.higgins.user.login.UserAccount userAccount, CategoryTO[] categoriesTO) Modifies list of card's category.
CategoryTO	modifyCategory(org.eclipse.higgins.user.login.UserAccount userAccount, CategoryTO categoryTO) Modifies the card's category.
void	modifyPasswordWithOldPassword(String userIdentifier, String oldPassword, String newPassword) Update user password, requires oldPassword for identify.
void	modifyPasswordWithPasswordResetCode(String userIdentifier, String passwordResetCode, String newPassword) Update user password, requires password reset code for identify.
UserProfileTO	modifyUserProfile(org.eclipse.higgins.user.login.UserAccount userAccount, UserProfileTO userProfile) Update user profile.
void	removeClaimValuesMRU(org.eclipse.higgins.user.login.UserAccount userAccount, String claimType, String claimValue) Deletes most recently used record.
ICardTO	resetPinCode(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, String oldPinCode) Remove pin code protection from personal card.
boolean	setCardCredential(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, UITokenServiceCredentialTO tokenCredential) Saves authentication card information of the specified card.
void	setDefaultPCard(org.eclipse.higgins.user.login.UserAccount userAccount, String pcardId) Set default personal card.
ICardTO	setPinCode(org.eclipse.higgins.user.login.UserAccount userAccount, String cuid, String pinCode) Sets pin code protection on personal card.
AccessTokenTO	signIn(AuthCredentialTO authCredentialTO) Authenticate user by AuthCredentialTO and start session with AccessTokenId.
AccessTokenTO	signIn(org.eclipse.higgins.user.login.UserAccount account) Start session with AccessTokenId.
void	signOut(String accessTokenId) Close session by AccessTokenId.
ICardUpdateResponseTO[]	updateClaimsAcrossCards(org.eclipse.higgins.user.login.UserAccount userAccount, String[] claimTypes, String[] claimValues, ICardUpdateTO[] cardUpdate) This method updates some claim values in list of cards.
ICardTO	updateICard(org.eclipse.higgins.user.login.UserAccount userAccount, ICardTO icardTO) This method update card.
ICardUpdateResponseTO[]	updateICards(org.eclipse.higgins.user.login.UserAccount userAccount, ICardTO[] icardTOList) This method update list of cards.
SelectorClientTO	updateSelectorClient(org.eclipse.higgins.user.login.UserAccount userAccount, SelectorClientTO selectorClientTO) Update state and name of selector client.
boolean	userIdentifierExists(String userIdentifier) Checks availability of user profile by userIdentifier.

Field Detail

ITSUsernamePasswordCredential

static final String ITSUsernamePasswordCredential

See Also:

Constant Field Values

ITSSelfIssuedCredential

static final String ITSSelfIssuedCredential

See Also:

Constant Field Values

ITSKerberosV5Credential

static final String ITSKerberosV5Credential

See Also:

Constant Field Values

ITSX509V3Credential

static final String ITSX509V3Credential

See Also:

Constant Field Values

IPinCodeCredential

static final String IPinCodeCredential

See Also:

Constant Field Values

ITSSelfIssuedNonPinCredential

static final String ITSSelfIssuedNonPinCredential

See Also:

Constant Field Values

IUsernamePasswordCredential

static final String IUsernamePasswordCredential

See Also:

Constant Field Values

IPasswordCredential

static final String IPasswordCredential

See Also:

Constant Field Values

Method Detail

addCategory

CategoryTO addCategory(org.eclipse.higgins.user.login.UserAccount userAccount,
                       CategoryTO categoryTO)
                       throws RppsException

Creates a new card's category.

Parameters:

categoryTO - the card category information

Returns:

Returns saved card category object

Throws:

RppsException

addClaimValuesMRU

void addClaimValuesMRU(org.eclipse.higgins.user.login.UserAccount userAccount,
                       String claimType,
                       String claimValue)
                       throws RppsException

Adds most recently used record.

Parameters:

claimType - claim's type

claimValue - claim's value

Throws:

RppsException

addRPEndPointCardRelation

boolean addRPEndPointCardRelation(org.eclipse.higgins.user.login.UserAccount userAccount,
                                  String cuid,
                                  RPEndPointTO rpEndPointTO)
                                  throws RppsException

Create relation between card and relying party.

Parameters:

cuid - the icard's CUID

rpEndPointTO - the object which represents logging form on relying party

Returns:

Returns true if relation was added. Otherwise false

Throws:

RppsException

addSelectorClient

SelectorClientTO addSelectorClient(org.eclipse.higgins.user.login.UserAccount userAccount,
                                   SelectorClientTO selectorClientTO)
                                   throws org.eclipse.higgins.user.profile.exception.UserProfileException

Register new selector client.

Parameters:

userAccount -

selectorClientTO -

Returns:

Throws:

org.eclipse.higgins.user.profile.exception.UserProfileException

addSelectorClient

SelectorClientTO addSelectorClient(org.eclipse.higgins.user.login.UserAccount userAccount,
                                   SelectorClientTO selectorClientTO,
                                   String otp)
                                   throws org.eclipse.higgins.user.profile.exception.UserProfileException

Check OTP and register new selector client.

Parameters:

userAccount -

selectorClientTO -

otp -

Returns:

Throws:

org.eclipse.higgins.user.profile.exception.UserProfileException

getSelectorClients

SelectorClientTO[] getSelectorClients(org.eclipse.higgins.user.login.UserAccount userAccount)
                                      throws org.eclipse.higgins.user.profile.exception.UserProfileException

Return arrays of selector clients.

Parameters:

userAccount -

Returns:

Throws:

org.eclipse.higgins.user.profile.exception.UserProfileException

deleteSelectorClient

void deleteSelectorClient(org.eclipse.higgins.user.login.UserAccount userAccount,
                          SelectorClientTO selectorClientTO)
                          throws org.eclipse.higgins.user.profile.exception.UserProfileException

Delete SelectorClient.

Parameters:

userAccount -

selectorClientTO -

Throws:

org.eclipse.higgins.user.profile.exception.UserProfileException

updateSelectorClient

SelectorClientTO updateSelectorClient(org.eclipse.higgins.user.login.UserAccount userAccount,
                                      SelectorClientTO selectorClientTO)
                                      throws org.eclipse.higgins.user.profile.exception.UserProfileException

Update state and name of selector client.

Parameters:

userAccount -

selectorClientTO -

Returns:

Throws:

org.eclipse.higgins.user.profile.exception.UserProfileException

addUrlCardRelation

boolean addUrlCardRelation(org.eclipse.higgins.user.login.UserAccount userAccount,
                           String cuid,
                           String url)
                           throws RppsException

Deprecated.

Create relation between card and url.

Parameters:

cuid - the icard's CUID

url - the url of site

Returns:

Returns true if relation was added. Otherwise false

Throws:

RppsException

addUserProfile

ResponseMessage addUserProfile(UserProfileTO userProfile,
                               String password)
                               throws RppsException

Creates a new user profile.

Parameters:

userProfile - the userProfile profile information as UserProfileTO

password - the password to identify the user.

Returns:

Returns ResponseMessage with code field equals 0 if profile was added. Otherwise returns ResponseMessage with error code or throws an RppsException

Throws:

RppsException

addUserProfileBase

org.eclipse.higgins.user.profile.entity.UserProfile addUserProfileBase(UserProfileTO userProfile,
                                                                       String password)
                                                                       throws org.eclipse.higgins.user.account.exception.UserAccountException,
                                                                              NoSuchAlgorithmException,
                                                                              UnsupportedEncodingException,
                                                                              org.eclipse.higgins.user.profile.exception.UserProfileException

Creates a new user profile.

Parameters:

userProfile -

password -

Returns:

Throws:

org.eclipse.higgins.user.account.exception.UserAccountException

NoSuchAlgorithmException

UnsupportedEncodingException

org.eclipse.higgins.user.profile.exception.UserProfileException

authenticate

org.eclipse.higgins.user.login.UserAccount authenticate(AuthCredentialTO authCredentialTO)
                                                        throws org.eclipse.higgins.user.login.exception.ConfigurationException,
                                                               org.eclipse.higgins.user.login.exception.LoginException,
                                                               org.eclipse.higgins.sync.auth.exceptions.AuthenticationException,
                                                               org.eclipse.higgins.user.profile.exception.UserProfileException

Authenticate user by AuthCredentialTO.

Parameters:

authCredentialTO - TODO

Returns:

Throws:

org.eclipse.higgins.user.login.exception.ConfigurationException

org.eclipse.higgins.user.login.exception.LoginException

org.eclipse.higgins.sync.auth.exceptions.AuthenticationException

org.eclipse.higgins.user.profile.exception.UserProfileException

authenticate

org.eclipse.higgins.user.login.UserAccount authenticate(String accessTokenId)
                                                        throws org.eclipse.higgins.user.login.exception.ConfigurationException,
                                                               org.eclipse.higgins.sync.auth.exceptions.AuthenticationException

Authenticate user by Access Token Id.

Parameters:

accessTokenId -

Returns:

Throws:

org.eclipse.higgins.user.login.exception.ConfigurationException

org.eclipse.higgins.sync.auth.exceptions.AuthenticationException

authenticate

org.eclipse.higgins.user.login.UserAccount authenticate(String userId,
                                                        String password)
                                                        throws org.eclipse.higgins.user.login.exception.ConfigurationException,
                                                               org.eclipse.higgins.user.login.exception.LoginException

Authenticate user with username password.

Parameters:

userId -

password -

Returns:

Throws:

org.eclipse.higgins.user.login.exception.ConfigurationException

org.eclipse.higgins.user.login.exception.LoginException

checkImportStream

FormatDescriptorTO checkImportStream(org.eclipse.higgins.user.login.UserAccount userAccount,
                                     byte[] crd)
                                     throws RppsException

Checks whether RppsService can recognize data format of the provided input stream. Some formats require authentication information in order to process input data. This method should be used prior to actual attempt to import data from the input stream in order to retrieve an information about data format and required authentication data to process the data successfully.

Parameters:

crd - context of file as byte array

Returns:

the information about input stream data format if it was recognized successfully and null otherwise.

Throws:

RppsException

clearCardCredential

ICardTO clearCardCredential(org.eclipse.higgins.user.login.UserAccount userAccount,
                            String cuid)
                            throws RppsException

Deletes saved authentication card information of the specified card.

Parameters:

cuid - the icard's CUID

Returns:

Returns updated card object

Throws:

RppsException

clearCardHistory

boolean clearCardHistory(org.eclipse.higgins.user.login.UserAccount userAccount,
                         String cuid)
                         throws RppsException

Deletes card history of the specified card on all URLs unless it is checked as "Use Always".

Parameters:

cuid - the icard's CUID

Returns:

Returns true if card history was cleared. Otherwise false

Throws:

RppsException

createCaptcha

org.eclipse.higgins.user.profile.entity.Captcha createCaptcha()
                                                              throws RppsException

Create new Captcha entity and store it via UserProfileService. This method is part of reset user password work-flow.

Returns:

Captcha

Throws:

RppsException

See Also:

RPPS Changes for password reset http://graceland.parityinc.net:8090/browse/WWM-1264

createDuplicateICard

ICardTO createDuplicateICard(org.eclipse.higgins.user.login.UserAccount userAccount,
                             String cardName,
                             String cuid,
                             String pinCode)
                             throws RppsException

Creates duplicate of personal card only with new card's name.

Parameters:

cardName - new card's name

cuid - the old icard's cuid

pinCode - pinCode for retrieve claims of personal card if that is pin protected. Otherwise null

Returns:

Returns updated card object

Throws:

RppsException

createICard

ICardTO createICard(org.eclipse.higgins.user.login.UserAccount userAccount,
                    ICardTemplateTO template)
                    throws RppsException

Creates a new card by template.

Parameters:

template - the icard's template

Returns:

a new card object

Throws:

RppsException

createICardFromHBX

String createICardFromHBX(org.eclipse.higgins.user.login.UserAccount userAccount,
                          String cardname)
                          throws RppsException

Deprecated.

Creates a new card for HBX.

Parameters:

cardname - the card's name

Returns:

a new card's cuid

Throws:

RppsException

deleteAllICard

void deleteAllICard(org.eclipse.higgins.user.login.UserAccount userAccount)
                    throws RppsException

Deletes all user's card.

Throws:

RppsException

deleteCaptcha

void deleteCaptcha(String id)
                   throws RppsException

Delete Captcha entity via UserProfileService. This method is part of reset user password work-flow.

Parameters:

id -

Throws:

RppsException

See Also:

RPPS Changes for password reset http://graceland.parityinc.net:8090/browse/WWM-1264

deleteCardHistoryRecord

boolean deleteCardHistoryRecord(org.eclipse.higgins.user.login.UserAccount userAccount,
                                String cuid,
                                RPEndPointTO rpEndPointTO)
                                throws RppsException

Delete specified record of card history.

Parameters:

cuid - the icard's CUID

rpEndPointTO - the object which represents logging form on relying party

Returns:

Returns true if card history record was deleted. Otherwise false

Throws:

RppsException

deleteCardHistoryRecord

boolean deleteCardHistoryRecord(org.eclipse.higgins.user.login.UserAccount userAccount,
                                String cuid,
                                String url)
                                throws RppsException

Deprecated.

Delete specified record of card history.

Parameters:

cuid - the icard's CUID

url - the url of site

Returns:

Returns true if card history record was deleted. Otherwise false

Throws:

RppsException

deleteCategory

void deleteCategory(org.eclipse.higgins.user.login.UserAccount userAccount,
                    String categoryId)
                    throws RppsException

Delete the card's category.

Parameters:

categoryId - category identifier

Throws:

RppsException

deleteICard

ICardUpdateResponseTO deleteICard(org.eclipse.higgins.user.login.UserAccount userAccount,
                                  String cuid)
                                  throws RppsException

Deletes specified card.

Parameters:

cuid - the icard's CUID

Returns:

Returns ICardUpdateResponseTO which contains delete status for card. If code field equals 0 then card was updated correctly. Otherwise code field contains error code. If deleted card had self signed type then cuid field contains cuid of personal card which had been used to signed managed card.

Throws:

RppsException

deleteRPEndPointCardRelation

boolean deleteRPEndPointCardRelation(org.eclipse.higgins.user.login.UserAccount userAccount,
                                     String cuid,
                                     RPEndPointTO rpEndPointTO)
                                     throws RppsException

Delete relation between card and relying party.

Parameters:

cuid - the icard's CUID

rpEndPointTO - the object which represents logging form on relying party

Returns:

Returns true if relation was deleted. Otherwise false

Throws:

RppsException

deleteRPEndPointsCardsRelations

boolean deleteRPEndPointsCardsRelations(org.eclipse.higgins.user.login.UserAccount userAccount,
                                        String cuid)
                                        throws RppsException

Delete all relations between card and relying party.

Parameters:

cuid - the icard's CUID

Returns:

Returns true if relations were deleted. Otherwise false

Throws:

RppsException

deleteUrlCardRelation

boolean deleteUrlCardRelation(org.eclipse.higgins.user.login.UserAccount userAccount,
                              String cuid,
                              String url)
                              throws RppsException

Deprecated.

Delete relation between card and site's url.

Parameters:

cuid - the icard's CUID

url - the url of site

Returns:

Returns true if relation was deleted. Otherwise false

Throws:

RppsException

deleteUrlsCardsRelations

boolean deleteUrlsCardsRelations(org.eclipse.higgins.user.login.UserAccount userAccount,
                                 String cuid)
                                 throws RppsException

Deprecated.

Delete all relations between card and site's urls.

Parameters:

cuid - the icard's CUID

Returns:

Returns true if relations were deleted. Otherwise false

Throws:

RppsException

deleteUserProfile

ResponseMessage deleteUserProfile(org.eclipse.higgins.user.login.UserAccount userAccount)
                                  throws RppsException

Deletes user profile.

Returns:

ResponseMessage

Throws:

RppsException

editPinCode

ICardTO editPinCode(org.eclipse.higgins.user.login.UserAccount userAccount,
                    String cuid,
                    String oldPinCode,
                    String newPinCode)
                    throws RppsException

Changes pin code for personal card.

Parameters:

cuid - the icard's CUID

oldPinCode - Old pin code

newPinCode - New pin code

Returns:

Returns updated card object

Throws:

RppsException

exportICards

byte[] exportICards(org.eclipse.higgins.user.login.UserAccount userAccount,
                    String formatID,
                    String[] cards,
                    UITokenServiceCredentialTO credential)
                    throws RppsException

Returns file as byte array with special which contains select cards.

Parameters:

formatID - file's format identifier

cards - the icard's CUIDs

credential - authentication information

Returns:

array of byte

Throws:

RppsException

generatePasswordResetCode

void generatePasswordResetCode(String userIdentifier)
                               throws RppsException

Generate and send user email with new password reset code. This method is part of reset user password work-flow.

Parameters:

userIdentifier - user login name

Throws:

RppsException

See Also:

RPPS Changes for password reset http://graceland.parityinc.net:8090/browse/WWM-1264

getCaptcha

org.eclipse.higgins.user.profile.entity.Captcha getCaptcha(String id)
                                                           throws RppsException

Retrieve Captcha entity via UserProfileService. This method is part of reset user password work-flow.

Parameters:

id - entity Id

Returns:

Captcha entity

Throws:

RppsException

See Also:

RPPS Changes for password reset http://graceland.parityinc.net:8090/browse/WWM-1264

getCardHistory

CardUsageTO[] getCardHistory(org.eclipse.higgins.user.login.UserAccount userAccount,
                             String cuid,
                             int startFrom,
                             int capacity,
                             String orderBy,
                             String orderDirection)

Return list of card history records, beginning at the specified position in selection.

Parameters:

cuid - the icard's CUID

startFrom - starting position in the selection

capacity - count of record which will be returned

orderBy - name of field which be used for sorting. Can take one of these values: "date"," site"," useAlways"

orderDirection - If value of this parameter is "desc" then result will be sorted in descending order. Otherwise in ascending order.

Returns:

array of CardUsageTO

Throws:

RppsException

getCardInformation

CardInformationTO getCardInformation(org.eclipse.higgins.user.login.UserAccount userAccount,
                                     String cuid,
                                     int size)
                                     throws RppsException

Gets card information object.

Parameters:

cuid - the icard's CUID

size - count of card history element which will be returned

Returns:

Return card information object

Throws:

RppsException

getCategory

CategoryTO[] getCategory(org.eclipse.higgins.user.login.UserAccount userAccount)
                         throws RppsException

Gets list of card categories.

Returns:

Returns array of category transfer object

Throws:

RppsException

getClaimValuesMRU

MapTO[] getClaimValuesMRU(org.eclipse.higgins.user.login.UserAccount userAccount)
                          throws RppsException

Gets most recently used records.

Returns:

Returns array of MapTO

Throws:

RppsException

getDefaultPCard

ICardTO getDefaultPCard(org.eclipse.higgins.user.login.UserAccount userAccount)
                        throws RppsException

Return default personal card. This method is part of workflow ' Instant credential m-Cards' http://graceland.parityinc.net:8090/browse/WWM-1150

Returns:

default pcard or null if user doesn't have default pcard

Throws:

RppsException

getICardByCUID

ICardTO getICardByCUID(org.eclipse.higgins.user.login.UserAccount userAccount,
                       String cuid)
                       throws RppsException

Gets a card by CUID.

Parameters:

cuid - the card CUID.

Returns:

the card transfer object.

Throws:

RppsException

getICardByCUIDAndTokenServiceCredential

ICardTO getICardByCUIDAndTokenServiceCredential(org.eclipse.higgins.user.login.UserAccount userAccount,
                                                String cuid,
                                                UITokenServiceCredentialTO tokenCredential)
                                                throws RppsException,
                                                       org.eclipse.higgins.icard.provider.cardspace.common.STSFaultException

This method gets the card with retrieved claims.

Parameters:

cuid - the card's cuid

tokenCredential - filled card credential for retrieve claims

Returns:

the card as a ICardTO

Throws:

RppsException

org.eclipse.higgins.icard.provider.cardspace.common.STSFaultException

getICardClaims

UIResponseCardTO getICardClaims(org.eclipse.higgins.user.login.UserAccount userAccount,
                                String cuid,
                                String policy,
                                String typeofCredential,
                                String[] credentialKey,
                                String[] credentialValue)
                                throws RppsException,
                                       org.eclipse.higgins.icard.provider.cardspace.common.STSFaultException

Deprecated.

Created for some demo.

Parameters:

cuid - the card's cuid.

policy -

typeofCredential -

credentialKey -

credentialValue -

Returns:

UIResponseCardTO

Throws:

RppsException

org.eclipse.higgins.icard.provider.cardspace.common.STSFaultException

getICardClaims

UIResponseCardTO getICardClaims(org.eclipse.higgins.user.login.UserAccount userAccount,
                                String cuid,
                                String policy,
                                String typeofCredential,
                                String[] credentialKey,
                                String[] credentialValue,
                                RPEndPointTO rpEndPointTO)
                                throws RppsException

Created for some demo.

Parameters:

cuid - the card's cuid.

policy -

typeofCredential -

credentialKey -

credentialValue -

rpEndPointTO - the object which represents logging form on relying party

Returns:

UIResponseCardTO

Throws:

RppsException

getICardCreationTemplate

ICardTemplateTO[] getICardCreationTemplate(org.eclipse.higgins.user.login.UserAccount userAccount)

This method return list of card creation template as array of ICardTemplateTO.

Returns:

a template list as array of ICardTemplateTO

Throws:

RppsException

getICardCreationTemplateByProvider

org.eclipse.higgins.icard.ICardTemplate[] getICardCreationTemplateByProvider(org.eclipse.higgins.user.login.UserAccount userAccount,
                                                                             String extID)
                                                                             throws RppsException

This method return list of card creation template by provider id.

Parameters:

extID - the id to identify the card provider.

Returns:

a template list as array of ICardTemplateTO

Throws:

RppsException

getICardsAndCategoriesByUser

ICardsAndCategoryTO getICardsAndCategoriesByUser(org.eclipse.higgins.user.login.UserAccount userAccount)
                                                 throws RppsException

This method gets the card list and category list of the specified user.

Returns:

ICardsAndCategoryTO which contain the cards and the categorys lists

Throws:

RppsException

getICardsByCUIDs

ICardTO[] getICardsByCUIDs(org.eclipse.higgins.user.login.UserAccount userAccount,
                           String[] cuids)

This method gets cards as array of ICardTO by CUIDs array.

Parameters:

cuids - the card CUIDs.

Returns:

array of ICardTO.

getICardsByFormat

ICardTO[] getICardsByFormat(org.eclipse.higgins.user.login.UserAccount userAccount,
                            String formatID)
                            throws RppsException

Gets cards which may be export to special file format.

Parameters:

formatID - the id of format file

Returns:

list of cards as a array of CardTO

Throws:

RppsException

getICardsByUser

ICardResponseTO getICardsByUser(org.eclipse.higgins.user.login.UserAccount userAccount)

This method gets ICardResponseTO which contains the card list and card relation list of the specified user.

Returns:

ICardResponseTO

getOutputFormats

FormatDescriptorTO[] getOutputFormats(org.eclipse.higgins.user.login.UserAccount userAccount)
                                      throws RppsException

Gets available file format for cards export.

Returns:

array of FormatDescriptorTO

Throws:

RppsException

getTokenByRPEndPoint

TokenResponseTO getTokenByRPEndPoint(org.eclipse.higgins.user.login.UserAccount userAccount,
                                     String policy,
                                     String policytype,
                                     String sslCert,
                                     RPEndPointTO rpEndPointTO)
                                     throws RppsException

Makes security token usage saved users information.

Parameters:

policy - the RP Agent's Relying Party Security Policy

policytype - the RP Security Policy type

sslCert - the SSL certificate

rpEndPointTO - the object which represents logging form on relying party

Returns:

the security token as a String

Throws:

RppsException

getTokenByUrl

TokenResponseTO getTokenByUrl(org.eclipse.higgins.user.login.UserAccount userAccount,
                              String policy,
                              String policytype,
                              String sslCert,
                              String url)
                              throws RppsException

Deprecated.

Makes security token usage saved users information.

Parameters:

policy - the RP Agent's Relying Party Security Policy

policytype - the RP Security Policy type

sslCert - the SSL certificate

url - the url of site which needs token

Returns:

the security token as a String

Throws:

RppsException

getTokenExtraByRPEndPoint

ExtraTokenResponseTO getTokenExtraByRPEndPoint(org.eclipse.higgins.user.login.UserAccount userAccount,
                                               String policy,
                                               String policytype,
                                               String sslCert,
                                               RPEndPointTO rpEndPointTO)
                                               throws RppsException

Makes security token with extra card's information usage saved users information.

Parameters:

policy - the RP Agent's Relying Party Security Policy

policytype - the RP Security Policy type

sslCert - the SSL certificate

rpEndPointTO - the object which represents logging form on relying party

Returns:

the security token as a String with extra card's information

Throws:

RppsException

getTokenExtraByUrl

ExtraTokenResponseTO getTokenExtraByUrl(org.eclipse.higgins.user.login.UserAccount userAccount,
                                        String policy,
                                        String policytype,
                                        String sslCert,
                                        String url)
                                        throws RppsException

Deprecated.

Makes security token with extra card's information usage saved users information.

Parameters:

policy - the RP Agent's Relying Party Security Policy

policytype - the RP Security Policy type

sslCert - the SSL certificate

url - the url of site which needs token

Returns:

the security token as a String with extra card's information

Throws:

RppsException

getTokenObject

TokenResponseTO getTokenObject(org.eclipse.higgins.user.login.UserAccount userAccount,
                               String policy,
                               String policytype,
                               String sslCert,
                               String[] cuids,
                               String typeofCredential,
                               String[] credentialKey,
                               String[] credentialValue)
                               throws RppsException,
                                      org.eclipse.higgins.icard.provider.cardspace.common.STSFaultException

Deprecated.

Given the Relying Party Agent (aka 'Requester')'s policy, identity information about the requester, and the set of one or more selections that the user has just made in the ISS Web UI (see userInterfaceRequest), AND presuming that the protocol involved in interacting with the RPA requires a security token, request the token that corresponds to the user's selection(s).

Parameters:

policy - the RP Agent's Relying Party Security Policy

policytype - the RP Security Policy type

sslCert - the SSL certificate

cuids - the user-selected subset of the UIDs (handles) contained in the UserInterfaceResponse object returned from an earlier invocation of 'userInterfaceRequest'

typeofCredential - the type of selected credential

credentialKey - the names of fields of selected credential

credentialValue - the value of fields of selected credential

Returns:

the security token as a String

Throws:

RppsException

org.eclipse.higgins.icard.provider.cardspace.common.STSFaultException

getTokenObject

TokenResponseTO getTokenObject(org.eclipse.higgins.user.login.UserAccount userAccount,
                               String policy,
                               String policytype,
                               String sslCert,
                               String[] cuids,
                               String typeofCredential,
                               String[] credentialKey,
                               String[] credentialValue,
                               RPEndPointTO rpEndPointTO)
                               throws RppsException,
                                      org.eclipse.higgins.icard.provider.cardspace.common.STSFaultException

Given the Relying Party Agent (aka 'Requester')'s policy, identity information about the requester, and the set of one or more selections that the user has just made in the ISS Web UI (see userInterfaceRequest), AND presuming that the protocol involved in interacting with the RPA requires a security token, request the token that corresponds to the user's selection(s).

Parameters:

policy - the RP Agent's Relying Party Security Policy

policytype - the RP Security Policy type

sslCert - the SSL certificate

cuids - the user-selected subset of the UIDs (handles) contained in the UserInterfaceResponse object returned from an earlier invocation of 'userInterfaceRequest'

typeofCredential - the type of selected credential

credentialKey - the names of fields of selected credential

credentialValue - the value of fields of selected credential

rpEndPointTO - the object which represents logging form on relying party

Returns:

the security token as a String

Throws:

RppsException

org.eclipse.higgins.icard.provider.cardspace.common.STSFaultException

getUserInterface

UIResponseTO getUserInterface(org.eclipse.higgins.user.login.UserAccount userAccount,
                              RPEndPointTO rpEndPointTO,
                              String target,
                              String sslCert,
                              String policytype,
                              String policy)
                              throws RppsException

This method takes as input a policy---for example, one that has been retrieved from the Relying Party Agent (called here the 'Requester')---as well as a description of the Requester. The UserInterfaceResponse object should contain all information necessary to display both (a) a user interface which shares the same card metaphor, sequences of experiences and decision points (the ceremony) of CardSpace and (b) other interface paradigms to be developed in the future.

Parameters:

rpEndPointTO - the object which represents logging form on relying party

target - some information

sslCert - the SSL certificate

policytype - the RP Security Policy type

policy - the RP Agent's Relying Party Security Policy

Returns:

the UIResponseTO transfer object.

Throws:

RppsException

getUserInterface

UIResponseTO getUserInterface(org.eclipse.higgins.user.login.UserAccount userAccount,
                              String url,
                              String target,
                              String sslCert,
                              String policytype,
                              String policy)
                              throws RppsException

Deprecated.

This method takes as input a policy---for example, one that has been retrieved from the Relying Party Agent (called here the 'Requester')---as well as a description of the Requester. The UserInterfaceResponse object should contain all information necessary to display both (a) a user interface which shares the same card metaphor, sequences of experiences and decision points (the ceremony) of CardSpace and (b) other interface paradigms to be developed in the future.

Parameters:

url - the URL to the html page with special tag

target - some information

sslCert - the SSL certificate

policytype - the RP Security Policy type

policy - the RP Agent's Relying Party Security Policy

Returns:

the UIResponseTO transfer object.

Throws:

RppsException

getUserProfile

UserProfileTO getUserProfile(org.eclipse.higgins.user.login.UserAccount userAccount)
                             throws RppsException,
                                    org.eclipse.higgins.user.profile.exception.UserProfileException,
                                    org.eclipse.higgins.user.account.exception.UserAccountException

Gets user profile as a UserProfileTO.

Returns:

user profile information

Throws:

RppsException

org.eclipse.higgins.user.profile.exception.UserProfileException

org.eclipse.higgins.user.account.exception.UserAccountException

importICards

ICardResponseTO importICards(org.eclipse.higgins.user.login.UserAccount userAccount,
                             byte[] crd)
                             throws RppsException

Imports card from a file.

Parameters:

crd - the file's context as a byte array.

Returns:

ICardResponseTO

Throws:

RppsException

importICards

ICardResponseTO importICards(org.eclipse.higgins.user.login.UserAccount userAccount,
                             byte[] crd,
                             String formatID,
                             UITokenServiceCredentialTO credential)
                             throws RppsException

Import cards from special format file.

Parameters:

crd - file's context

formatID - file's format identifier

credential - authentication information

Returns:

ICardResponseTO

Throws:

RppsException

importICards

ICardResponseTO importICards(org.eclipse.higgins.user.login.UserAccount userAccount,
                             byte[] crd,
                             String formatID,
                             UITokenServiceCredentialTO credential,
                             Boolean[] importFlag)
                             throws RppsException

Import cards from special format file.

Parameters:

userAccount -

crd -

formatID -

credential -

importFlag -

Returns:

Throws:

RppsException

getImportingCardsInformation

ImportCardInformationTO[] getImportingCardsInformation(org.eclipse.higgins.user.login.UserAccount userAccount,
                                                       byte[] crd,
                                                       String formatID,
                                                       UITokenServiceCredentialTO credential)
                                                       throws RppsException

Get information about cards which can be imported from passed data

Parameters:

crd - the card source (.crd, .crds, etc.) as a byte array.

formatID - the data format of the input stream if available. If null is used all available data formats will be checked in order to import.

credential - the authentication data to process the input stream if required

importFlag - Indicates which cards should be imported. Size of this array should be equal to the number of cards. If null than all cards will be imported.

Throws:

RppsException

modifyCategories

ResponseMessage modifyCategories(org.eclipse.higgins.user.login.UserAccount userAccount,
                                 CategoryTO[] categoriesTO)
                                 throws RppsException

Modifies list of card's category.

Parameters:

categoriesTO - list of card's category

Returns:

Returns ResponseMessage with code field equals 0 if categories were updated. Otherwise returns ResponseMessage with error code or throws an RppsException

Throws:

RppsException

modifyCategory

CategoryTO modifyCategory(org.eclipse.higgins.user.login.UserAccount userAccount,
                          CategoryTO categoryTO)
                          throws RppsException

Modifies the card's category.

Parameters:

categoryTO - category transfer object

Returns:

Returns modified category

Throws:

RppsException

modifyPasswordWithOldPassword

void modifyPasswordWithOldPassword(String userIdentifier,
                                   String oldPassword,
                                   String newPassword)
                                   throws RppsException

Update user password, requires oldPassword for identify. This method is part of reset user password work-flow.

Parameters:

userIdentifier -

oldPassword -

newPassword -

Throws:

RppsException

See Also:

RPPS Changes for password reset http://graceland.parityinc.net:8090/browse/WWM-1264

modifyPasswordWithPasswordResetCode

void modifyPasswordWithPasswordResetCode(String userIdentifier,
                                         String passwordResetCode,
                                         String newPassword)
                                         throws RppsException

Update user password, requires password reset code for identify. This method is part of reset user password work-flow.

Parameters:

userIdentifier -

newPassword -

passwordResetCode -

Throws:

RppsException

See Also:

RPPS Changes for password reset http://graceland.parityinc.net:8090/browse/WWM-1264

modifyUserProfile

UserProfileTO modifyUserProfile(org.eclipse.higgins.user.login.UserAccount userAccount,
                                UserProfileTO userProfile)
                                throws RppsException

Update user profile.

Parameters:

userProfile - user profile transfer object

Returns:

user profile transfer object

Throws:

RppsException

removeClaimValuesMRU

void removeClaimValuesMRU(org.eclipse.higgins.user.login.UserAccount userAccount,
                          String claimType,
                          String claimValue)
                          throws RppsException

Deletes most recently used record.

Parameters:

claimType - claim's type

claimValue - claim's value

Throws:

RppsException

resetPinCode

ICardTO resetPinCode(org.eclipse.higgins.user.login.UserAccount userAccount,
                     String cuid,
                     String oldPinCode)
                     throws RppsException

Remove pin code protection from personal card.

Parameters:

cuid - the icard's CUID

oldPinCode - pin code

Returns:

Returns updated card object

Throws:

RppsException

setCardCredential

boolean setCardCredential(org.eclipse.higgins.user.login.UserAccount userAccount,
                          String cuid,
                          UITokenServiceCredentialTO tokenCredential)
                          throws RppsException

Saves authentication card information of the specified card.

Parameters:

cuid - the icard's CUID

tokenCredential - authentication card information

Returns:

Returns true if card credential was set. Otherwise false

Throws:

RppsException

setDefaultPCard

void setDefaultPCard(org.eclipse.higgins.user.login.UserAccount userAccount,
                     String pcardId)
                     throws RppsException

Set default personal card. This method is part of workflow ' Instant credential m-Cards' http://graceland.parityinc.net:8090/browse/WWM-1150 if pcardId is null or empty string it just removes old default pcard.

Parameters:

pcardId - personal card id (cuid)

Throws:

RppsException - if coudn't find pcardId throw RppsException

setPinCode

ICardTO setPinCode(org.eclipse.higgins.user.login.UserAccount userAccount,
                   String cuid,
                   String pinCode)
                   throws RppsException

Sets pin code protection on personal card.

Parameters:

cuid - the icard's CUID

pinCode - pin code

Returns:

Returns updated card object

Throws:

RppsException

signIn

AccessTokenTO signIn(AuthCredentialTO authCredentialTO)
                     throws org.eclipse.higgins.user.login.exception.ConfigurationException,
                            org.eclipse.higgins.user.login.exception.LoginException,
                            org.eclipse.higgins.sync.auth.exceptions.AuthenticationException,
                            org.eclipse.higgins.user.profile.exception.UserProfileException

Authenticate user by AuthCredentialTO and start session with AccessTokenId.

Parameters:

authCredentialTO -

Returns:

Throws:

org.eclipse.higgins.user.login.exception.ConfigurationException

org.eclipse.higgins.user.login.exception.LoginException

org.eclipse.higgins.sync.auth.exceptions.AuthenticationException

org.eclipse.higgins.user.profile.exception.UserProfileException

signIn

AccessTokenTO signIn(org.eclipse.higgins.user.login.UserAccount account)
                     throws org.eclipse.higgins.user.login.exception.ConfigurationException,
                            org.eclipse.higgins.user.login.exception.LoginException,
                            org.eclipse.higgins.sync.auth.exceptions.AuthenticationException,
                            org.eclipse.higgins.user.profile.exception.UserProfileException

Start session with AccessTokenId.

Parameters:

account -

Returns:

Throws:

org.eclipse.higgins.user.login.exception.ConfigurationException

org.eclipse.higgins.user.login.exception.LoginException

org.eclipse.higgins.sync.auth.exceptions.AuthenticationException

org.eclipse.higgins.user.profile.exception.UserProfileException

getOTP

void getOTP(AuthCredentialTO authCredentialTO,
            String captchaId,
            String captchaResponse,
            String channel)
            throws org.eclipse.higgins.user.login.exception.ConfigurationException,
                   org.eclipse.higgins.user.login.exception.LoginException,
                   org.eclipse.higgins.sync.auth.exceptions.AuthenticationException,
                   org.eclipse.higgins.user.profile.exception.UserProfileException,
                   NoSuchAlgorithmException,
                   CommunicationException

Generate new one time password(OTP) and send it to user. Authenticate by using authCredentialTO.
Channel must be one of the following constant: EMAIL, SMS,CALL.

Parameters:

authCredentialTO -

captchaId -

captchaResponse -

channel -

Throws:

org.eclipse.higgins.user.login.exception.ConfigurationException

org.eclipse.higgins.user.login.exception.LoginException

org.eclipse.higgins.sync.auth.exceptions.AuthenticationException

org.eclipse.higgins.user.profile.exception.UserProfileException

NoSuchAlgorithmException

CommunicationException

See Also:

https://camelot.parityinc.net/mediawiki/index.php/Serialized_Client

signOut

void signOut(String accessTokenId)
             throws org.eclipse.higgins.user.login.exception.ConfigurationException,
                    org.eclipse.higgins.user.login.exception.LoginException

Close session by AccessTokenId.

Parameters:

accessTokenId -

Throws:

org.eclipse.higgins.user.login.exception.ConfigurationException

org.eclipse.higgins.user.login.exception.LoginException

updateClaimsAcrossCards

ICardUpdateResponseTO[] updateClaimsAcrossCards(org.eclipse.higgins.user.login.UserAccount userAccount,
                                                String[] claimTypes,
                                                String[] claimValues,
                                                ICardUpdateTO[] cardUpdate)
                                                throws RppsException

This method updates some claim values in list of cards.

Parameters:

claimTypes - array of claim's types

claimValues - array of claim's types. Must be in the same order as claimTypes

cardUpdate - array of ICardUpdateTO

Returns:

Return array of ICardUpdateResponseTO which contains update status for every card. If code field equals 0 then card was updated correctly. Otherwise code field contains error code

Throws:

RppsException

updateICard

ICardTO updateICard(org.eclipse.higgins.user.login.UserAccount userAccount,
                    ICardTO icardTO)
                    throws RppsException

This method update card.

Parameters:

icardTO - the card transfer object.

Returns:

the card transfer object.

Throws:

RppsException

updateICards

ICardUpdateResponseTO[] updateICards(org.eclipse.higgins.user.login.UserAccount userAccount,
                                     ICardTO[] icardTOList)
                                     throws RppsException

This method update list of cards.

Parameters:

icardTOList - list of cards which may be updated

Returns:

list of ICardUpdateResponseTO

Throws:

RppsException

userIdentifierExists

boolean userIdentifierExists(String userIdentifier)
                             throws org.eclipse.higgins.user.account.exception.UserAccountException

Checks availability of user profile by userIdentifier.

Parameters:

userIdentifier -

Returns:

Returns true if user identifier exists. Otherwise false

Throws:

org.eclipse.higgins.user.account.exception.UserAccountException

RppsException