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 url
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".
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.
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)
boolean	deleteRPEndPointsCardsRelations(String cuid)
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)
byte[]	exportICards(String formatID, String[] cards, UITokenServiceCredentialTO credential)
CardUsageTO[]	getCardHistory(String cuid, int startFrom, int capacity, String orderBy, String orderDirection)
CardInformationTO	getCardInformation(String cuid, int size)
CategoryTO[]	getCategory()
MapTO[]	getClaimValuesMRU()
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) Gets a card by CUID and Credential.
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)
ICardTemplateTO[]	getICardCreationTemplate() Return templates for creating cards
org.eclipse.higgins.icard.ICardTemplate[]	getICardCreationTemplateByProvider(String extID)
ICardsAndCategoryTO	getICardsAndCategoriesByUser() Gets the card and category lists of the specified user.
ICardTO[]	getICardsByCUIDs(String[] cuids) Gets cards by CUIDs array.
ICardTO[]	getICardsByFormat(String formatID)
ICardResponseTO	getICardsByUser() Gets the card list of the specified user.
FormatDescriptorTO[]	getOutputFormats()
TokenResponseTO	getTokenByClaims(String sslCert, String[] claimName, String[] claimValue) Web service operation.
TokenResponseTO	getTokenByRPEndPoint(String policy, String policytype, String sslCert, RPEndPointTO rpEndPointTO) Web service operation.
TokenResponseTO	getTokenByUrl(String policy, String policytype, String sslCert, String url) Deprecated.
ExtraTokenResponseTO	getTokenExtraByRPEndPoint(String policy, String policytype, String sslCert, RPEndPointTO rpEndPointTO) Web service operation.
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) Web service operation.
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()
ICardResponseTO	importICards(byte[] crd) Imports card from a file.
ICardResponseTO	importICards(byte[] crd, String formatID, UITokenServiceCredentialTO credential)
ResponseMessage	modifyCategories(CategoryTO[] categoriesTO)
CategoryTO	modifyCategory(CategoryTO categoryTO)
UserProfileTO	modifyUserProfile(UserProfileTO userProfile) Update user profile
void	removeClaimValuesMRU(String claimType, String claimValue)
ICardTO	resetPinCode(String cuid, String oldPinCode)
boolean	setCardCredential(String cuid, UITokenServiceCredentialTO tokenCredential)
void	setNewPrivateUserPassword(String newPassword)
ICardTO	setPinCode(String cuid, String pinCode)
ICardUpdateResponseTO[]	updateClaimsAcrossCards(String[] claimTypes, String[] claimValues, ICardUpdateTO[] cardUpdate)
ICardTO	updateICard(ICardTO icardTO) Update card.
ICardUpdateResponseTO[]	updateICards(ICardTO[] icardTOList)
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

Returns:

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

Throws:

RemoteException

RppsException

addRPEndPointCardRelation

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

Create relation between card and url

Parameters:

cuid - the icard's CUID

Returns:

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

Returns:

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

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

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:

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.

Parameters:

cuid -

url -

Returns:

Throws:

RppsException

deleteRPEndPointCardRelation

public boolean deleteRPEndPointCardRelation(String cuid,
                                            RPEndPointTO rpEndPointTO)
                                     throws RppsException

Throws:

RppsException

deleteUrlsCardsRelations

public boolean deleteUrlsCardsRelations(String cuid)
                                 throws RppsException

Deprecated.

Parameters:

cuid -

Returns:

Throws:

RppsException

deleteRPEndPointsCardsRelations

public boolean deleteRPEndPointsCardsRelations(String cuid)
                                        throws RppsException

Throws:

RppsException

deleteUserProfile

public ResponseMessage deleteUserProfile()
                                  throws RppsException

Deletes user profile

Throws:

RppsException

editPinCode

public ICardTO editPinCode(String cuid,
                           String oldPinCode,
                           String newPinCode)
                    throws RppsException

Throws:

RppsException

exportICards

public byte[] exportICards(String formatID,
                           String[] cards,
                           UITokenServiceCredentialTO credential)
                    throws RppsException

Throws:

RppsException

getCardHistory

public CardUsageTO[] getCardHistory(String cuid,
                                    int startFrom,
                                    int capacity,
                                    String orderBy,
                                    String orderDirection)

getCardInformation

public CardInformationTO getCardInformation(String cuid,
                                            int size)
                                     throws RppsException

Parameters:

cuid -

Returns:

Throws:

RppsException

getCategory

public CategoryTO[] getCategory()
                         throws RppsException

Throws:

RppsException

getClaimValuesMRU

public MapTO[] getClaimValuesMRU()
                          throws RppsException

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

Gets a card by CUID and Credential.

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(String cuid,
                                       String policy,
                                       String typeofCredential,
                                       String[] credentialKey,
                                       String[] credentialValue)
                                throws RppsException

Deprecated.

Parameters:

cuid -

policy -

typeofCredential -

credentialKey -

credentialValue -

Returns:

Throws:

RppsException

getICardClaims

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

Throws:

RppsException

getICardCreationTemplate

public ICardTemplateTO[] getICardCreationTemplate()
                                           throws RppsException

Return templates for creating cards

Returns:

a template list

Throws:

RppsException

getICardCreationTemplateByProvider

public org.eclipse.higgins.icard.ICardTemplate[] getICardCreationTemplateByProvider(String extID)
                                                                             throws RppsException

Throws:

RppsException

getICardsAndCategoriesByUser

public ICardsAndCategoryTO getICardsAndCategoriesByUser()
                                                 throws RppsException

Gets the card and category lists of the specified user.

Returns:

the card list

Throws:

RppsException

getICardsByCUIDs

public ICardTO[] getICardsByCUIDs(String[] cuids)

Gets cards by CUIDs array.

Parameters:

cuids - the card CUIDs.

Returns:

list of cards transfer object.

getICardsByFormat

public ICardTO[] getICardsByFormat(String formatID)
                            throws RppsException

Throws:

RppsException

getICardsByUser

public ICardResponseTO getICardsByUser()

Gets the card list of the specified user.

Returns:

the card list

getOutputFormats

public FormatDescriptorTO[] getOutputFormats()
                                      throws RppsException

Throws:

RppsException

getTokenByClaims

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

Web service operation. Makes xmlToken usage claim list.

Parameters:

sslCert - the SSL certificate

Returns:

the security token as a String

Throws:

RppsException

getTokenByRPEndPoint

public TokenResponseTO getTokenByRPEndPoint(String policy,
                                            String policytype,
                                            String sslCert,
                                            RPEndPointTO rpEndPointTO)
                                     throws RppsException

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

Returns:

the security token as a String

Throws:

RemoteException

RppsException

getTokenByUrl

public TokenResponseTO getTokenByUrl(String policy,
                                     String policytype,
                                     String sslCert,
                                     String url)
                              throws RppsException

Deprecated.

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

Returns:

the security token as a String

Throws:

RemoteException

RppsException

getTokenExtraByUrl

public ExtraTokenResponseTO getTokenExtraByUrl(String policy,
                                               String policytype,
                                               String sslCert,
                                               String url)
                                        throws RppsException

Deprecated.

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

Returns:

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

Throws:

RemoteException

RppsException

getTokenExtraByRPEndPoint

public ExtraTokenResponseTO getTokenExtraByRPEndPoint(String policy,
                                                      String policytype,
                                                      String sslCert,
                                                      RPEndPointTO rpEndPointTO)
                                               throws RppsException

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

Returns:

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

Throws:

RemoteException

RppsException

getTokenObject

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

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

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:

RemoteException

RppsException

getTokenObject

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

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

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:

RemoteException

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:

target -

sslCert - the SSL certificate

policy - the RP Agent's Relying Party Security Policy

Returns:

the UIResponseTO transfer object.

Throws:

RemoteException

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:

target -

sslCert - the SSL certificate

policy - the RP Agent's Relying Party Security Policy

Returns:

the UIResponseTO transfer object.

Throws:

RemoteException

RppsException

getUserProfile

public UserProfileTO getUserProfile()
                             throws RppsException,
                                    AccessException

Throws:

RppsException

AccessException

importICards

public ICardResponseTO importICards(byte[] crd)
                             throws RppsException

Imports card from a file.

Parameters:

crd - the card as a byte array.

Throws:

RppsException

importICards

public ICardResponseTO importICards(byte[] crd,
                                    String formatID,
                                    UITokenServiceCredentialTO credential)
                             throws RppsException

Throws:

RppsException

modifyCategories

public ResponseMessage modifyCategories(CategoryTO[] categoriesTO)
                                 throws RppsException

Throws:

RppsException

modifyCategory

public CategoryTO modifyCategory(CategoryTO categoryTO)
                          throws RppsException

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

Throws:

RppsException

resetPinCode

public ICardTO resetPinCode(String cuid,
                            String oldPinCode)
                     throws RppsException

Throws:

RppsException

setCardCredential

public boolean setCardCredential(String cuid,
                                 UITokenServiceCredentialTO tokenCredential)
                          throws RppsException

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

Throws:

RppsException

updateClaimsAcrossCards

public ICardUpdateResponseTO[] updateClaimsAcrossCards(String[] claimTypes,
                                                       String[] claimValues,
                                                       ICardUpdateTO[] cardUpdate)
                                                throws RppsException

Throws:

RppsException

updateICard

public ICardTO updateICard(ICardTO icardTO)
                    throws RppsException

Update card.

Parameters:

icardTO - the card transfer object.

Returns:

the card transfer object.

Throws:

RppsException

updateICards

public ICardUpdateResponseTO[] updateICards(ICardTO[] icardTOList)
                                     throws RppsException

Throws:

RppsException

userIdentifierExists

public boolean userIdentifierExists(String userIdentifier)

Checks availability of user profile by userIdentifier

Parameters:

userIdentifier -

Returns:

true if user profile exists otherwise false

Throws:

RppsException