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(CategoryTO categoryTO) Creates a new card's category.
void	addClaimValuesMRU(String claimType, String claimValue) Adds most recently used record.
boolean	addRPEndPointCardRelation(String cuid, RPEndPointTO rpEndPointTO) Create relation between card and relying party.
boolean	addUrlCardRelation(String cuid, String url) Deprecated.
ResponseMessage	addUserProfile(UserProfileTO userProfile, String password) Creates a new user profile.
FormatDescriptorTO	checkImportStream(byte[] crd) Checks whether RppsService can recognize data format of the provided input stream.
ICardTO	clearCardCredential(String cuid) Deletes saved authentication card information of the specified card.
boolean	clearCardHistory(String cuid) Deletes card history of the specified card on all URLs unless it is checked as "Use Always".
org.eclipse.higgins.userprofile.entity.Captcha	createCaptcha() Create new Captcha entity and store it via UserProfileService.
ICardTO	createDuplicateICard(String cardName, String cuid, String pinCode) Creates duplicate of personal card only with new card's name.
ICardTO	createICard(ICardTemplateTO template) Creates a new card by template.
String	createICardFromHBX(String cardname) Deprecated.
void	deleteAllICard() Deletes all user's card.
void	deleteCaptcha(String id) Delete Captcha entity via UserProfileService.
boolean	deleteCardHistoryRecord(String cuid, RPEndPointTO rpEndPointTO) Delete specified record of card history.
boolean	deleteCardHistoryRecord(String cuid, String url) Deprecated.
void	deleteCategory(String categoryId) Delete the card's category.
ICardUpdateResponseTO	deleteICard(String cuid) Deletes specified card.
void	deleteOldPassword()
boolean	deleteRPEndPointCardRelation(String cuid, RPEndPointTO rpEndPointTO) Delete relation between card and relying party.
boolean	deleteRPEndPointsCardsRelations(String cuid) Delete all relations between card and relying party.
boolean	deleteUrlCardRelation(String cuid, String url) Deprecated.
boolean	deleteUrlsCardsRelations(String cuid) Deprecated.
ResponseMessage	deleteUserProfile() Deletes user profile.
ICardTO	editPinCode(String cuid, String oldPinCode, String newPinCode) Changes pin code for personal card.
byte[]	exportICards(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.userprofile.entity.Captcha	getCaptcha(String id) Retrieve Captcha entity via UserProfileService.
CardUsageTO[]	getCardHistory(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(String cuid, int size) Gets card information object.
CategoryTO[]	getCategory() Gets list of card categories.
MapTO[]	getClaimValuesMRU() Gets most recently used records.
ICardTO	getDefaultPCard() Return default personal card.
String	getHigginsServiceGlobalIName() Gets the global i-name registered to the Higgins service (e.g.
ICardTO	getICardByCUID(String cuid) Gets a card by CUID.
ICardTO	getICardByCUIDAndTokenServiceCredential(String cuid, UITokenServiceCredentialTO tokenCredential) This method gets the card with retrieved claims.
UIResponseCardTO	getICardClaims(String cuid, String policy, String typeofCredential, String[] credentialKey, String[] credentialValue) Deprecated.
UIResponseCardTO	getICardClaims(String cuid, String policy, String typeofCredential, String[] credentialKey, String[] credentialValue, RPEndPointTO rpEndPointTO) Created for some demo.
ICardTemplateTO[]	getICardCreationTemplate() This method return list of card creation template as array of ICardTemplateTO.
org.eclipse.higgins.icard.ICardTemplate[]	getICardCreationTemplateByProvider(String extID) This method return list of card creation template by provider id.
ICardsAndCategoryTO	getICardsAndCategoriesByUser() This method gets the card list and category list of the specified user.
ICardTO[]	getICardsByCUIDs(String[] cuids) This method gets cards as array of ICardTO by CUIDs array.
ICardTO[]	getICardsByFormat(String formatID) Gets cards which may be export to special file format.
ICardResponseTO	getICardsByUser() This method gets ICardResponseTO which contains the card list and card relation list of the specified user.
FormatDescriptorTO[]	getOutputFormats() Gets available file format for cards export.
TokenResponseTO	getTokenByClaims(String sslCert, String[] claimName, String[] claimValue) Makes xmlToken usage claim list.
TokenResponseTO	getTokenByRPEndPoint(String policy, String policytype, String sslCert, RPEndPointTO rpEndPointTO) Makes security token usage saved users information.
TokenResponseTO	getTokenByUrl(String policy, String policytype, String sslCert, String url) Deprecated.
ExtraTokenResponseTO	getTokenExtraByRPEndPoint(String policy, String policytype, String sslCert, RPEndPointTO rpEndPointTO) Makes security token with extra card's information usage saved users information.
ExtraTokenResponseTO	getTokenExtraByUrl(String policy, String policytype, String sslCert, String url) Deprecated.
TokenResponseTO	getTokenObject(String policy, String policytype, String sslCert, String[] cuids, String typeofCredential, String[] credentialKey, String[] credentialValue) Deprecated.
TokenResponseTO	getTokenObject(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(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(String url, String target, String sslCert, String policytype, String policy) Deprecated.
UserProfileTO	getUserProfile() Gets user profile as a UserProfileTO.
ICardResponseTO	importICards(byte[] crd) Imports card from a file.
ICardResponseTO	importICards(byte[] crd, String formatID, UITokenServiceCredentialTO credential) Import cards from special format file.
ResponseMessage	modifyCategories(CategoryTO[] categoriesTO) Modifies list of card's category.
CategoryTO	modifyCategory(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(UserProfileTO userProfile) Update user profile.
void	removeClaimValuesMRU(String claimType, String claimValue) Deletes most recently used record.
ICardTO	resetPinCode(String cuid, String oldPinCode) Remove pin code protection from personal card.
boolean	setCardCredential(String cuid, UITokenServiceCredentialTO tokenCredential) Saves authentication card information of the specified card.
void	setDefaultPCard(String pcardId) Set default personal card.
void	setNewPrivateUserPassword(String newPassword)
ICardTO	setPinCode(String cuid, String pinCode) Sets pin code protection on personal card.
ICardUpdateResponseTO[]	updateClaimsAcrossCards(String[] claimTypes, String[] claimValues, ICardUpdateTO[] cardUpdate) This method updates some claim values in list of cards.
ICardTO	updateICard(ICardTO icardTO) This method update card.
ICardUpdateResponseTO[]	updateICards(ICardTO[] icardTOList) This method update list of cards.
boolean	userIdentifierExists(String userIdentifier) Checks availability of user profile by userIdentifier.

Field Detail

ITSUsernamePasswordCredential

public static final String ITSUsernamePasswordCredential

See Also:

Constant Field Values

ITSSelfIssuedCredential

public static final String ITSSelfIssuedCredential

See Also:

Constant Field Values

ITSKerberosV5Credential

public static final String ITSKerberosV5Credential

See Also:

Constant Field Values

ITSX509V3Credential

public static final String ITSX509V3Credential

See Also:

Constant Field Values

IPinCodeCredential

public static final String IPinCodeCredential

See Also:

Constant Field Values

ITSSelfIssuedNonPinCredential

public static final String ITSSelfIssuedNonPinCredential

See Also:

Constant Field Values

IUsernamePasswordCredential

public static final String IUsernamePasswordCredential

See Also:

Constant Field Values

IPasswordCredential

public static final String IPasswordCredential

See Also:

Constant Field Values

Method Detail

addCategory

public CategoryTO addCategory(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

public void addClaimValuesMRU(String claimType,
                              String claimValue)
                       throws RppsException

Adds most recently used record.

Parameters:

claimType - claim's type

claimValue - claim's value

Throws:

RppsException

addUserProfile

public 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

addRPEndPointCardRelation

public boolean addRPEndPointCardRelation(String cuid,
                                         RPEndPointTO rpEndPointTO)
                                  throws RppsException,
                                         org.eclipse.higgins.userprofile.UserProfileException

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

org.eclipse.higgins.userprofile.UserProfileException

addUrlCardRelation

public boolean addUrlCardRelation(String cuid,
                                  String url)
                           throws RppsException,
                                  org.eclipse.higgins.userprofile.UserProfileException

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

org.eclipse.higgins.userprofile.UserProfileException

checkImportStream

public FormatDescriptorTO checkImportStream(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

public ICardTO clearCardCredential(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

public boolean clearCardHistory(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

createDuplicateICard

public ICardTO createDuplicateICard(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

public ICardTO createICard(ICardTemplateTO template)
                    throws RppsException

Creates a new card by template.

Parameters:

template - the icard's template

Returns:

a new card object

Throws:

RppsException

createICardFromHBX

public String createICardFromHBX(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

public void deleteAllICard()
                    throws RppsException

Deletes all user's card.

Throws:

RppsException

deleteCardHistoryRecord

public boolean deleteCardHistoryRecord(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

public boolean deleteCardHistoryRecord(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

public void deleteCategory(String categoryId)
                    throws RppsException

Delete the card's category.

Parameters:

categoryId - category identifier

Throws:

RppsException

deleteICard

public ICardUpdateResponseTO deleteICard(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

deleteOldPassword

public void deleteOldPassword()
                       throws org.eclipse.higgins.userprofile.UserProfileException

Throws:

org.eclipse.higgins.userprofile.UserProfileException

deleteUrlCardRelation

public boolean deleteUrlCardRelation(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

deleteRPEndPointCardRelation

public boolean deleteRPEndPointCardRelation(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

deleteUrlsCardsRelations

public boolean deleteUrlsCardsRelations(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

deleteRPEndPointsCardsRelations

public boolean deleteRPEndPointsCardsRelations(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

deleteUserProfile

public ResponseMessage deleteUserProfile()
                                  throws RppsException

Deletes user profile.

Returns:

ResponseMessage

Throws:

RppsException

editPinCode

public ICardTO editPinCode(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

public byte[] exportICards(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

getCardHistory

public CardUsageTO[] getCardHistory(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

public CardInformationTO getCardInformation(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

public CategoryTO[] getCategory()
                         throws RppsException

Gets list of card categories.

Returns:

Returns array of category transfer object

Throws:

RppsException

getClaimValuesMRU

public MapTO[] getClaimValuesMRU()
                          throws RppsException

Gets most recently used records.

Returns:

Returns array of MapTO

Throws:

RppsException

getHigginsServiceGlobalIName

public String getHigginsServiceGlobalIName()

Gets the global i-name registered to the Higgins service (e.g. "=parity").

Returns:

the global i-name.

getICardByCUID

public ICardTO getICardByCUID(String cuid)
                       throws RppsException

Gets a card by CUID.

Parameters:

cuid - the card CUID.

Returns:

the card transfer object.

Throws:

RppsException

getICardByCUIDAndTokenServiceCredential

public ICardTO getICardByCUIDAndTokenServiceCredential(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

public UIResponseCardTO getICardClaims(String cuid,
                                       String policy,
                                       String typeofCredential,
                                       String[] credentialKey,
                                       String[] credentialValue)
                                throws RppsException

Deprecated.

Created for some demo.

Parameters:

cuid - the card's cuid.

policy -

typeofCredential -

credentialKey -

credentialValue -

Returns:

UIResponseCardTO

Throws:

RppsException

getICardClaims

public UIResponseCardTO getICardClaims(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

public ICardTemplateTO[] getICardCreationTemplate()
                                           throws RppsException

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

Returns:

a template list as array of ICardTemplateTO

Throws:

RppsException

getICardCreationTemplateByProvider

public org.eclipse.higgins.icard.ICardTemplate[] getICardCreationTemplateByProvider(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

public ICardsAndCategoryTO getICardsAndCategoriesByUser()
                                                 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

public ICardTO[] getICardsByCUIDs(String[] cuids)

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

Parameters:

cuids - the card CUIDs.

Returns:

array of ICardTO.

getICardsByFormat

public ICardTO[] getICardsByFormat(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

public ICardResponseTO getICardsByUser()

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

Returns:

ICardResponseTO

getOutputFormats

public FormatDescriptorTO[] getOutputFormats()
                                      throws RppsException

Gets available file format for cards export.

Returns:

array of FormatDescriptorTO

Throws:

RppsException

getTokenByClaims

public TokenResponseTO getTokenByClaims(String sslCert,
                                        String[] claimName,
                                        String[] claimValue)
                                 throws RppsException

Makes xmlToken usage claim list.

Parameters:

sslCert - the SSL certificate

claimName - the array which contains claim names

claimValue - the array which contains claim values

Returns:

the security token as a String

Throws:

RppsException

getTokenByRPEndPoint

public TokenResponseTO getTokenByRPEndPoint(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

public TokenResponseTO getTokenByUrl(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

getTokenExtraByUrl

public ExtraTokenResponseTO getTokenExtraByUrl(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

getTokenExtraByRPEndPoint

public ExtraTokenResponseTO getTokenExtraByRPEndPoint(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

getTokenObject

public TokenResponseTO getTokenObject(String policy,
                                      String policytype,
                                      String sslCert,
                                      String[] cuids,
                                      String typeofCredential,
                                      String[] credentialKey,
                                      String[] credentialValue)
                               throws RppsException

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

getTokenObject

public TokenResponseTO getTokenObject(String policy,
                                      String policytype,
                                      String sslCert,
                                      String[] cuids,
                                      String typeofCredential,
                                      String[] credentialKey,
                                      String[] credentialValue,
                                      RPEndPointTO rpEndPointTO)
                               throws RppsException

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

getUserInterface

public UIResponseTO getUserInterface(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

getUserInterface

public UIResponseTO getUserInterface(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

getUserProfile

public UserProfileTO getUserProfile()
                             throws RppsException,
                                    AccessException

Gets user profile as a UserProfileTO.

Returns:

user profile information

Throws:

RppsException

AccessException

importICards

public ICardResponseTO importICards(byte[] crd)
                             throws RppsException

Imports card from a file.

Parameters:

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

Returns:

ICardResponseTO

Throws:

RppsException

importICards

public ICardResponseTO importICards(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

modifyCategories

public ResponseMessage modifyCategories(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

public CategoryTO modifyCategory(CategoryTO categoryTO)
                          throws RppsException

Modifies the card's category.

Parameters:

categoryTO - category transfer object

Returns:

Returns modified category

Throws:

RppsException

modifyUserProfile

public UserProfileTO modifyUserProfile(UserProfileTO userProfile)
                                throws RppsException

Update user profile.

Parameters:

userProfile - user profile transfer object

Returns:

user profile transfer object

Throws:

RppsException

removeClaimValuesMRU

public void removeClaimValuesMRU(String claimType,
                                 String claimValue)
                          throws RppsException

Deletes most recently used record.

Parameters:

claimType - claim's type

claimValue - claim's value

Throws:

RppsException

resetPinCode

public ICardTO resetPinCode(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

public boolean setCardCredential(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

setNewPrivateUserPassword

public void setNewPrivateUserPassword(String newPassword)
                               throws org.eclipse.higgins.userprofile.UserProfileException

Throws:

org.eclipse.higgins.userprofile.UserProfileException

setPinCode

public ICardTO setPinCode(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

updateClaimsAcrossCards

public ICardUpdateResponseTO[] updateClaimsAcrossCards(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

public ICardTO updateICard(ICardTO icardTO)
                    throws RppsException

This method update card.

Parameters:

icardTO - the card transfer object.

Returns:

the card transfer object.

Throws:

RppsException

updateICards

public ICardUpdateResponseTO[] updateICards(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

public boolean userIdentifierExists(String userIdentifier)

Checks availability of user profile by userIdentifier.

Parameters:

userIdentifier -

Returns:

Returns true if user identifier exists. Otherwise false

Throws:

RppsException

setDefaultPCard

public void setDefaultPCard(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

getDefaultPCard

public ICardTO getDefaultPCard()
                        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

generatePasswordResetCode

public 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

Returns:

UserProfile with new generated password reset code

Throws:

RppsException

See Also:

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

modifyPasswordWithPasswordResetCode

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

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

modifyPasswordWithOldPassword

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

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

createCaptcha

public org.eclipse.higgins.userprofile.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:

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

getCaptcha

public org.eclipse.higgins.userprofile.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:

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

deleteCaptcha

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

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