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)
void	addClaimValuesMRU(String claimType, String claimValue)
ResponseMessage	addUserProfile(UserProfileTO userProfile) Creates new user profile
void	addUserProfileFromHBX(String userId, String password) Creates new user profile
FormatDescriptorTO	checkImportStream(byte[] crd)
ICardTO	clearCardCredential(String cuid)
boolean	clearCardHistory(String cuid)
ICardTO	createDuplicateICard(String cardName, String cuid, String pinCode) Creates the duplicate card with new card's name
ICardTO	createICard(ICardTemplateTO template) Creates a new card by template
ICardTO	createICard(String id, String[] properties) Creates a new card
String	createICardFromHBX(String cardname) Creates new card
void	deleteAllICard() Deletes all user's card.
boolean	deleteCardHistoryRecord(String cuid, String url)
void	deleteCategory(String categoryId)
ICardUpdateResponseTO	deleteICard(String cuid) Deletes specified card.
void	deleteOldPassword()
boolean	deleteUrlCardRelation(String cuid, String url)
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)
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	getTokenByUrl(String policy, String policytype, String sslCert, String url) Web service operation.
ExtraTokenResponseTO	getTokenExtraByUrl(String policy, String policytype, String sslCert, String url) Web service operation.
TokenResponseTO	getTokenObject(String policy, String policytype, String sslCert, String[] cuids, String typeofCredential, String[] credentialKey, String[] credentialValue) Web service operation.
UIResponseTO	getUserInterface(String url, 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.
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) Get a icard template for creating personal card
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

Throws:

RppsException

addClaimValuesMRU

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

Throws:

RppsException

addUserProfile

public ResponseMessage addUserProfile(UserProfileTO userProfile)
                               throws RppsException

Creates new user profile

Parameters:

userProfile - user profile trasfer object

Throws:

RppsException

addUserProfileFromHBX

public void addUserProfileFromHBX(String userId,
                                  String password)
                           throws RppsException

Creates new user profile

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

Throws:

RppsException

checkImportStream

public FormatDescriptorTO checkImportStream(byte[] crd)
                                     throws RppsException

Throws:

RppsException

clearCardCredential

public ICardTO clearCardCredential(String cuid)
                            throws RppsException

Throws:

RppsException

clearCardHistory

public boolean clearCardHistory(String cuid)
                         throws RppsException

Throws:

RppsException

createDuplicateICard

public ICardTO createDuplicateICard(String cardName,
                                    String cuid,
                                    String pinCode)
                             throws RppsException

Creates the duplicate card with new card's name

Parameters:

cardName - new card's name

cuid - cuid of old card

pinCode - pincode if it needs

Returns:

card trasfer object

Throws:

RppsException

createICard

public ICardTO createICard(ICardTemplateTO template)
                    throws RppsException

Creates a new card by template

Returns:

a new card id

Throws:

RppsException

createICard

public ICardTO createICard(String id,
                           String[] properties)
                    throws RppsException

Creates a new card

Parameters:

id - the i-card id

properties - the i-card properties

Returns:

a new card id

Throws:

RppsException

createICardFromHBX

public String createICardFromHBX(String cardname)
                          throws RppsException

Creates new card

Parameters:

cardname - name of card

Returns:

cuid of new card

Throws:

RppsException

deleteAllICard

public void deleteAllICard()
                    throws RppsException

Deletes all user's card.

Throws:

RppsException

deleteCardHistoryRecord

public boolean deleteCardHistoryRecord(String cuid,
                                       String url)
                                throws RppsException

Throws:

RppsException

deleteCategory

public void deleteCategory(String categoryId)
                    throws RppsException

Throws:

RppsException

deleteICard

public ICardUpdateResponseTO deleteICard(String cuid)
                                  throws RppsException

Deletes specified card.

Parameters:

cuid - the i-card CUID

Throws:

RppsException

deleteOldPassword

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

Throws:

org.eclipse.higgins.icard.userprofile.UserProfileException

deleteUrlCardRelation

public boolean deleteUrlCardRelation(String cuid,
                                     String url)
                              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

Gets a card by CUID and Credential.

Parameters:

cuid - the card CUID.

tokenCredential - the tokenCredential transfer object

Returns:

the card transfer object.

Throws:

RppsException

getICardClaims

public UIResponseCardTO getICardClaims(String cuid,
                                       String policy,
                                       String typeofCredential,
                                       String[] credentialKey,
                                       String[] credentialValue)
                                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

getTokenByUrl

public TokenResponseTO getTokenByUrl(String policy,
                                     String policytype,
                                     String sslCert,
                                     String url)
                              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

url - the url of site which needs token

Returns:

the security token as a String

Throws:

RemoteException

RppsException

getTokenExtraByUrl

public ExtraTokenResponseTO getTokenExtraByUrl(String policy,
                                               String policytype,
                                               String sslCert,
                                               String url)
                                        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

url - the url of site which needs token

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

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

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