org.eclipse.higgins.rpps.core.impl
Class RppsService

java.lang.Object
  org.eclipse.higgins.rpps.core.impl.RppsService

All Implemented Interfaces:

IRppsService

public class RppsService
extends Object
implements IRppsService

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

Author:

Sergei Yakovlev, Artem Verkhovets

Nested Class Summary

static class

RppsService.DummyTrustManagerFactory

Field Summary

static ThreadLocal	authenticateService
static ThreadLocal	loginService Instance of LoginService..
static ThreadLocal	metaDataService
static ThreadLocal	userAccountService Instance of IUserAccountService.
static ThreadLocal	userProfileService Instance of IUserProfileService .

Fields inherited from interface org.eclipse.higgins.rpps.core.IRppsService

IPasswordCredential, IPinCodeCredential, ITSKerberosV5Credential, ITSSelfIssuedCredential, ITSSelfIssuedNonPinCredential, ITSUsernamePasswordCredential, ITSX509V3Credential, IUsernamePasswordCredential

Constructor Summary

RppsService()

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.
static void	AllowSelfSignedSSL()
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 by 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 for 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".
static void	ConfigureCache(String configurationBase, String configurationFile)
UIResponseCardTO	convertICard_To_UIResponseCardTO(org.eclipse.higgins.user.login.UserAccount userAccount, org.eclipse.higgins.icard.ICard icard, org.eclipse.higgins.user.profile.entity.WebForm webForm, org.eclipse.higgins.icard.IPolicy policy, org.eclipse.higgins.user.profile.entity.CardInformation cardInformation, X509Certificate[] sslCerts) Converts the card to the transfer object for the CARD element of UserInterfaceResponse.
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 relation 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 size, 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.
static Context	getContext() Return JNDI environment.
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) Gets a card by CUID and Credential.
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) Return templates for creating cards
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.
ICardTemplateTO	getICardCreationTemplateByTUID(org.eclipse.higgins.user.login.UserAccount userAccount, String tuid) Return templates for creating cards.
org.eclipse.higgins.icard.ICardTemplate	getICardCreationTemplateByTUID(org.eclipse.higgins.user.login.UserAccount userAccount, org.eclipse.higgins.icard.TUID tuid) Return templates for creating cards.
ICardsAndCategoryTO	getICardsAndCategoriesByUser(org.eclipse.higgins.user.login.UserAccount userAccount) Gets the card and category lists of the specified user.
ICardTO[]	getICardsByCUIDs(org.eclipse.higgins.user.login.UserAccount userAccount, String[] cuids) Gets cards 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) Gets the card 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) Web service operation.
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) Web service operation.
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, org.eclipse.higgins.icard.IPolicy policy, String policytype, String sslCert, String[] cuids, org.eclipse.higgins.icard.auth.ICredential credential, org.eclipse.higgins.user.profile.entity.WebForm webForm) 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).
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) Web service operation.
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) Imports card from a file.
ICardResponseTO	importICards(org.eclipse.higgins.user.login.UserAccount userAccount, byte[] crd, String formatID, UITokenServiceCredentialTO credential, Boolean[] importFlag) Imports card from a 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 userProfileTO) 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) Update claim across cards.
ICardTO	updateICard(org.eclipse.higgins.user.login.UserAccount userAccount, ICardTO icardTO) Update card.
ICardUpdateResponseTO[]	updateICards(org.eclipse.higgins.user.login.UserAccount userAccount, ICardTO[] icardTOList) Update card.
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
void	validateCaptcha(String captchaId, String captchaResponse)

Methods inherited from class java.lang.Object

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

Field Detail

loginService

public static final ThreadLocal loginService

Instance of LoginService..

metaDataService

public static final ThreadLocal metaDataService

authenticateService

public static final ThreadLocal authenticateService

userAccountService

public static final ThreadLocal userAccountService

Instance of IUserAccountService.

userProfileService

public static final ThreadLocal userProfileService

Instance of IUserProfileService .

Constructor Detail

RppsService

public RppsService()

Method Detail

AllowSelfSignedSSL

public static void AllowSelfSignedSSL()

ConfigureCache

public static void ConfigureCache(String configurationBase,
                                  String configurationFile)

getContext

public static Context getContext()
                          throws NamingException

Return JNDI environment.

Returns:

Throws:

NamingException

addCategory

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

Creates a new card's category.

Specified by:

addCategory in interface IRppsService

Parameters:

categoryTO - the card category information

Returns:

Returns saved card category object

Throws:

RppsException - some situation

addClaimValuesMRU

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

Adds most recently used record.

Specified by:

addClaimValuesMRU in interface IRppsService

Parameters:

claimType - claim's type

claimValue - claim's value

Throws:

RppsException - some situation

addRPEndPointCardRelation

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

Create relation between card and relying party.

Specified by:

addRPEndPointCardRelation in interface IRppsService

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 - some situation

addSelectorClient

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

Description copied from interface: IRppsService

Register new selector client.

Specified by:

addSelectorClient in interface IRppsService

Returns:

Throws:

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

getSelectorClients

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

Description copied from interface: IRppsService

Return arrays of selector clients.

Specified by:

getSelectorClients in interface IRppsService

Returns:

Throws:

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

addSelectorClient

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

Description copied from interface: IRppsService

Check OTP and register new selector client.

Specified by:

addSelectorClient in interface IRppsService

Returns:

Throws:

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

updateSelectorClient

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

Description copied from interface: IRppsService

Update state and name of selector client.

Specified by:

updateSelectorClient in interface IRppsService

Returns:

Throws:

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

deleteSelectorClient

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

Description copied from interface: IRppsService

Delete SelectorClient.

Specified by:

deleteSelectorClient in interface IRppsService

Throws:

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

addUrlCardRelation

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

Deprecated.

Create relation between card and url.

Specified by:

addUrlCardRelation in interface IRppsService

Parameters:

cuid - the icard's CUID

url - the url of site

Returns:

Returns true if relation was added. Otherwise false

Throws:

RppsException - some situation

addUserProfile

public ResponseMessage addUserProfile(UserProfileTO userProfile,
                                      String password)
                               throws RppsException

Creates a new user profile.

Specified by:

addUserProfile in interface IRppsService

Parameters:

userProfile - the user profile information.

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 RemoteException

Throws:

RppsException - some situation

addUserProfileBase

public 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

Description copied from interface: IRppsService

Creates a new user profile.

Specified by:

addUserProfileBase in interface IRppsService

Parameters:

userProfile -

password -

Returns:

Throws:

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

NoSuchAlgorithmException

UnsupportedEncodingException

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

authenticate

public 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.

Specified by:

authenticate in interface IRppsService

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

public 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.

Specified by:

authenticate in interface IRppsService

Parameters:

accessTokenId -

Returns:

Throws:

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

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

authenticate

public 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 by username password.

Specified by:

authenticate in interface IRppsService

Parameters:

userId -

password -

Returns:

Throws:

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

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

checkImportStream

public 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.

Specified by:

checkImportStream in interface IRppsService

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 - some situation

clearCardCredential

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

Deletes saved authentication card information for specified card.

Specified by:

clearCardCredential in interface IRppsService

Parameters:

cuid - the icard's CUID

Returns:

Returns updated card object

Throws:

RppsException - some situation

clearCardHistory

public 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".

Specified by:

clearCardHistory in interface IRppsService

Parameters:

cuid - the icard's CUID

Returns:

Returns true if card history was cleared. Otherwise false

Throws:

RppsException - some situation

convertICard_To_UIResponseCardTO

public UIResponseCardTO convertICard_To_UIResponseCardTO(org.eclipse.higgins.user.login.UserAccount userAccount,
                                                         org.eclipse.higgins.icard.ICard icard,
                                                         org.eclipse.higgins.user.profile.entity.WebForm webForm,
                                                         org.eclipse.higgins.icard.IPolicy policy,
                                                         org.eclipse.higgins.user.profile.entity.CardInformation cardInformation,
                                                         X509Certificate[] sslCerts)

Converts the card to the transfer object for the CARD element of UserInterfaceResponse.

Parameters:

card - the Higgins card.

isCatchAuthentication - equals "true" if needs to generete AuthenticationRequiredException or AuthenticationException

Returns:

the card transfer object.

createCaptcha

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

Description copied from interface: IRppsService

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

Specified by:

createCaptcha in interface IRppsService

Returns:

Captcha

Throws:

RppsException

See Also:

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

createDuplicateICard

public 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.

Specified by:

createDuplicateICard in interface IRppsService

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 - some situation

createICard

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

Creates a new card by template.

Specified by:

createICard in interface IRppsService

Parameters:

template - the icard's template

Returns:

a new card object

Throws:

RemoteException

RppsException

createICardFromHBX

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

Deprecated.

Creates a new card for HBX.

Specified by:

createICardFromHBX in interface IRppsService

Parameters:

cardname - the card's name

Returns:

a new card's cuid

Throws:

RppsException - some situation

deleteAllICard

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

Deletes all user's card.

Specified by:

deleteAllICard in interface IRppsService

Throws:

RppsException - some situation

deleteCaptcha

public void deleteCaptcha(String id)
                   throws RppsException

Description copied from interface: IRppsService

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

Specified by:

deleteCaptcha in interface IRppsService

Throws:

RppsException

See Also:

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

deleteCardHistoryRecord

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

Delete specified record of card history.

Specified by:

deleteCardHistoryRecord in interface IRppsService

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 - some situation

deleteCardHistoryRecord

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

Deprecated.

Delete specified record of card history.

Specified by:

deleteCardHistoryRecord in interface IRppsService

Parameters:

cuid - the icard's CUID

url - url of site which will be deleted from card history

Returns:

Returns true if card history record was deleted. Otherwise false

Throws:

RppsException - some situation

deleteCategory

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

Delete the card's category.

Specified by:

deleteCategory in interface IRppsService

Parameters:

categoryId - category identifier

Throws:

RppsException - some situation

deleteICard

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

Deletes specified card.

Specified by:

deleteICard in interface IRppsService

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 - some situation

deleteRPEndPointCardRelation

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

Delete relation between card and relying party.

Specified by:

deleteRPEndPointCardRelation in interface IRppsService

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 - some situation

deleteRPEndPointsCardsRelations

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

Delete relation between card and relying party.

Specified by:

deleteRPEndPointsCardsRelations in interface IRppsService

Parameters:

cuid - the icard's CUID

Returns:

Returns true if relation was deleted. Otherwise false

Throws:

RppsException - some situation

deleteUrlCardRelation

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

Deprecated.

Delete relation between card and site's url.

Specified by:

deleteUrlCardRelation in interface IRppsService

Parameters:

cuid - the icard's CUID

url - the url of site

Returns:

Returns true if relation was deleted. Otherwise false

Throws:

RppsException - some situation

deleteUrlsCardsRelations

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

Deprecated.

Delete all relations between card and site's urls.

Specified by:

deleteUrlsCardsRelations in interface IRppsService

Parameters:

cuid - the icard's CUID

Returns:

Returns true if relations were deleted. Otherwise false

Throws:

RppsException - some situation

deleteUserProfile

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

Deletes user profile.

Specified by:

deleteUserProfile in interface IRppsService

Returns:

ResponseMessage

Throws:

RppsException - some situation

editPinCode

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

Changes pin code for personal card.

Specified by:

editPinCode in interface IRppsService

Parameters:

cuid - the icard's CUID

oldPinCode - Old pin code

newPinCode - New pin code

Returns:

Returns updated card object

Throws:

RppsException - some situation

exportICards

public 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.

Specified by:

exportICards in interface IRppsService

Parameters:

formatID - file's format identifier

cards - the icard's CUIDs

credential - authentication information

Returns:

array of byte

Throws:

RppsException - some situation

generatePasswordResetCode

public void generatePasswordResetCode(String userIdentifier)
                               throws RppsException

Description copied from interface: IRppsService

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

Specified by:

generatePasswordResetCode in interface IRppsService

Parameters:

userIdentifier - user login name

Throws:

RppsException

See Also:

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

getCaptcha

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

Description copied from interface: IRppsService

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

Specified by:

getCaptcha in interface IRppsService

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

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

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

Specified by:

getCardHistory in interface IRppsService

Parameters:

cuid - the icard's CUID

startFrom - starting position in the selection

size - 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 - some situation

getCardInformation

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

Gets card information object.

Specified by:

getCardInformation in interface IRppsService

Parameters:

cuid - the icard's CUID

size - count of card history element which will be returned

Returns:

Return card information object

Throws:

RppsException - some situation

getCategory

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

Description copied from interface: IRppsService

Gets list of card categories.

Specified by:

getCategory in interface IRppsService

Parameters:

userId -

password -

Returns:

Throws:

RppsException - some situation

getClaimValuesMRU

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

Description copied from interface: IRppsService

Gets most recently used records.

Specified by:

getClaimValuesMRU in interface IRppsService

Returns:

Returns array of MapTO

Throws:

RppsException

getDefaultPCard

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

Description copied from interface: IRppsService

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

Specified by:

getDefaultPCard in interface IRppsService

Returns:

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

Throws:

RppsException

getICardByCUID

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

Gets a card by CUID.

Specified by:

getICardByCUID in interface IRppsService

Parameters:

cuid - the card CUID.

Returns:

the card transfer object.

Throws:

RppsException

getICardByCUIDAndTokenServiceCredential

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

Gets a card by CUID and Credential.

Specified by:

getICardByCUIDAndTokenServiceCredential in interface IRppsService

Parameters:

cuid - the card CUID.

tokenCredential - the tokenCredential transfer object

Returns:

the card transfer object.

Throws:

RppsException

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

getICardClaims

public 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.

Specified by:

getICardClaims in interface IRppsService

Parameters:

cuid - the card's cuid.

policy -

typeofCredential -

credentialKey -

credentialValue -

Returns:

UIResponseCardTO

Throws:

RppsException

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

getICardClaims

public 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.

Specified by:

getICardClaims in interface IRppsService

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

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

Return templates for creating cards

Specified by:

getICardCreationTemplate in interface IRppsService

Returns:

a template list

getICardCreationTemplateByProvider

public 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.

Specified by:

getICardCreationTemplateByProvider in interface IRppsService

Parameters:

extID - the id to identify the card provider.

Returns:

a template list as array of ICardTemplateTO

Throws:

RppsException

getICardCreationTemplateByTUID

public ICardTemplateTO getICardCreationTemplateByTUID(org.eclipse.higgins.user.login.UserAccount userAccount,
                                                      String tuid)
                                               throws RppsException

Return templates for creating cards.

Returns:

a template list

Throws:

RppsException

getICardCreationTemplateByTUID

public org.eclipse.higgins.icard.ICardTemplate getICardCreationTemplateByTUID(org.eclipse.higgins.user.login.UserAccount userAccount,
                                                                              org.eclipse.higgins.icard.TUID tuid)
                                                                       throws org.eclipse.higgins.icard.CardException

Return templates for creating cards.

Returns:

a template list

Throws:

org.eclipse.higgins.icard.CardException

getICardsAndCategoriesByUser

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

Gets the card and category lists of the specified user.

Specified by:

getICardsAndCategoriesByUser in interface IRppsService

Returns:

the card list

Throws:

RppsException

getICardsByCUIDs

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

Gets cards by CUIDs array.

Specified by:

getICardsByCUIDs in interface IRppsService

Parameters:

cuids - the card CUIDs.

Returns:

list of cards transfer object.

getICardsByFormat

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

Gets cards which may be export to special file format.

Specified by:

getICardsByFormat in interface IRppsService

Parameters:

formatID - the id of format file

Returns:

list of cards as a array of CardTO

Throws:

RppsException

getICardsByUser

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

Gets the card list of the specified user.

Specified by:

getICardsByUser in interface IRppsService

Returns:

the card list

getOutputFormats

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

Gets available file format for cards export.

Specified by:

getOutputFormats in interface IRppsService

Returns:

array of FormatDescriptorTO

Throws:

RppsException

getTokenByRPEndPoint

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

Web service operation. Makes security token usage saved users information

Specified by:

getTokenByRPEndPoint in interface IRppsService

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 transfer object

Throws:

RemoteException

RppsException

getTokenByUrl

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

Deprecated.

Web service operation. Makes security token usage saved users information

Specified by:

getTokenByUrl in interface IRppsService

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 transfer object

Throws:

RemoteException

RppsException

getTokenExtraByRPEndPoint

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

Web service operation. Makes security token usage saved users information

Specified by:

getTokenExtraByRPEndPoint in interface IRppsService

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 transfer object

Throws:

RemoteException

RppsException

getTokenExtraByUrl

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

Deprecated.

Web service operation. Makes security token usage saved users information

Specified by:

getTokenExtraByUrl in interface IRppsService

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 transfer object

Throws:

RemoteException

RppsException

getTokenObject

public TokenResponseTO getTokenObject(org.eclipse.higgins.user.login.UserAccount userAccount,
                                      org.eclipse.higgins.icard.IPolicy policy,
                                      String policytype,
                                      String sslCert,
                                      String[] cuids,
                                      org.eclipse.higgins.icard.auth.ICredential credential,
                                      org.eclipse.higgins.user.profile.entity.WebForm webForm)
                               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:

handler -

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'

credential -

cardCredentialInfo -

url -

Returns:

the security token transfer object

Throws:

RppsException - some situation

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

getTokenObject

public 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.

Web service operation. 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).

Specified by:

getTokenObject in interface IRppsService

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 transfer object

Throws:

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

RemoteException

RppsException

getTokenObject

public 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

Web service operation. 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).

Specified by:

getTokenObject in interface IRppsService

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 transfer object

Throws:

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

RemoteException

RppsException

getUserInterface

public 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

Specified by:

getUserInterface in interface IRppsService

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

url - the URL to the html page with