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

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

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

Constructor Summary

RppsService()
Sets an HTML scraping script for the specified site

RppsService(String userId, String password)

Method Summary

void	addCardHistory(org.eclipse.higgins.icard.CUID cuid, URI site)
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
static void	AllowSelfSignedSSL()
void	authenticate(String userId, String password)
FormatDescriptorTO	checkImportStream(byte[] crd)
ICardTO	clearCardCredential(String cuid)
boolean	clearCardHistory(String cuid)
static void	ConfigureCache(String configurationBase, String configurationFile)
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 size, String orderBy, String orderDirection)
CardUsageTO[]	getCardHistoryLog(String cuid, int startFrom, int size, String orderBy, String orderDirection)
CardInformationTO	getCardInformation(String cuid, int size)
CategoryTO[]	getCategory()
MapTO[]	getClaimValuesMRU()
CallbackHandler	getHandler()
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)
ICardTemplateTO	getICardCreationTemplateByTUID(String tuid) Return templates for creating cards
org.eclipse.higgins.icard.ICardTemplate	getICardCreationTemplateByTUID(org.eclipse.higgins.icard.TUID tuid) Return templates for creating cards
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.
static IRppsService	getInstance() Creates an RppsService object.
static IRppsService	getInstance(String userId, String password) Creates an RppsService object.
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) Imports card from a file.
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)
static String	resolveUserIdentifier(String privateSelectorINumber)
boolean	setCardCredential(String cuid, UITokenServiceCredentialTO tokenCredential)
void	setHandler(CallbackHandler handler) Gets list of random word
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) Update claim across cards.
ICardTO	updateICard(ICardTO icardTO) Update card.
ICardUpdateResponseTO[]	updateICards(ICardTO[] icardTOList) Update card.
boolean	userIdentifierExists(String userIdentifier) Checks availability of user profile by userIdentifier

Methods inherited from class java.lang.Object

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

Constructor Detail

RppsService

public RppsService()

Sets an HTML scraping script for the specified site

RppsService

public RppsService(String userId,
                   String password)
            throws AccessException

Method Detail

AllowSelfSignedSSL

public static void AllowSelfSignedSSL()

ConfigureCache

public static void ConfigureCache(String configurationBase,
                                  String configurationFile)

getInstance

public static IRppsService getInstance()

Creates an RppsService object.

Returns:

the RppsService object

getInstance

public static IRppsService getInstance(String userId,
                                       String password)
                                throws AccessException

Creates an RppsService object.

Returns:

the RppsService object

Throws:

AccessException

resolveUserIdentifier

public static String resolveUserIdentifier(String privateSelectorINumber)

Parameters:

privateSelectorINumber -

Returns:

userIdentifer

addCardHistory

public void addCardHistory(org.eclipse.higgins.icard.CUID cuid,
                           URI site)
                    throws org.eclipse.higgins.icard.userprofile.UserProfileException

Throws:

org.eclipse.higgins.icard.userprofile.UserProfileException

addCategory

public CategoryTO addCategory(CategoryTO categoryTO)
                       throws RppsException

Specified by:

addCategory in interface IRppsService

Throws:

RppsException

addClaimValuesMRU

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

Specified by:

addClaimValuesMRU in interface IRppsService

Throws:

RppsException

addUserProfile

public ResponseMessage addUserProfile(UserProfileTO userProfile)
                               throws RppsException

Creates new user profile

Specified by:

addUserProfile in interface IRppsService

Parameters:

userProfile - user profile trasfer object

Throws:

RppsException

addUserProfileFromHBX

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

Creates new user profile

Specified by:

addUserProfileFromHBX in interface IRppsService

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

Throws:

RppsException

authenticate

public void authenticate(String userId,
                         String password)
                  throws AccessException

Throws:

AccessException

checkImportStream

public FormatDescriptorTO checkImportStream(byte[] crd)
                                     throws RppsException

Specified by:

checkImportStream in interface IRppsService

Throws:

RppsException

clearCardCredential

public ICardTO clearCardCredential(String cuid)
                            throws RppsException

Specified by:

clearCardCredential in interface IRppsService

Throws:

RppsException

clearCardHistory

public boolean clearCardHistory(String cuid)
                         throws RppsException

Specified by:

clearCardHistory in interface IRppsService

Throws:

RppsException

createDuplicateICard

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

Creates the duplicate card with new card's name

Specified by:

createDuplicateICard in interface IRppsService

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

Specified by:

createICard in interface IRppsService

Returns:

a new card id

Throws:

RppsException

createICard

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

Creates a new card

Specified by:

createICard in interface IRppsService

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

Specified by:

createICardFromHBX in interface IRppsService

Parameters:

cardname - name of card

Returns:

cuid of new card

Throws:

RppsException

deleteAllICard

public void deleteAllICard()
                    throws RppsException

Deletes all user's card.

Specified by:

deleteAllICard in interface IRppsService

Throws:

RppsException

deleteCardHistoryRecord

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

Specified by:

deleteCardHistoryRecord in interface IRppsService

Throws:

RppsException

deleteCategory

public void deleteCategory(String categoryId)
                    throws RppsException

Specified by:

deleteCategory in interface IRppsService

Throws:

RppsException

deleteICard

public ICardUpdateResponseTO deleteICard(String cuid)
                                  throws RppsException

Deletes specified card.

Specified by:

deleteICard in interface IRppsService

Parameters:

cuid - the i-card CUID

Throws:

RppsException

deleteOldPassword

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

Specified by:

deleteOldPassword in interface IRppsService

Throws:

org.eclipse.higgins.icard.userprofile.UserProfileException

deleteUrlCardRelation

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

Specified by:

deleteUrlCardRelation in interface IRppsService

Throws:

RppsException

deleteUserProfile

public ResponseMessage deleteUserProfile()
                                  throws RppsException

Deletes user profile

Specified by:

deleteUserProfile in interface IRppsService

Throws:

RppsException

editPinCode

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

Specified by:

editPinCode in interface IRppsService

Throws:

RppsException

exportICards

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

Specified by:

exportICards in interface IRppsService

Throws:

RppsException

getCardHistory

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

Specified by:

getCardHistory in interface IRppsService

getCardHistoryLog

public CardUsageTO[] getCardHistoryLog(String cuid,
                                       int startFrom,
                                       int size,
                                       String orderBy,
                                       String orderDirection)

getCardInformation

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

Specified by:

getCardInformation in interface IRppsService

Parameters:

cuid -

Returns:

Throws:

RppsException

getCategory

public CategoryTO[] getCategory()
                         throws RppsException

Specified by:

getCategory in interface IRppsService

Returns:

Throws:

RppsException

getClaimValuesMRU

public MapTO[] getClaimValuesMRU()
                          throws RppsException

Specified by:

getClaimValuesMRU in interface IRppsService

Throws:

RppsException

getHandler

public CallbackHandler getHandler()

getHigginsServiceGlobalIName

public String getHigginsServiceGlobalIName()

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

Specified by:

getHigginsServiceGlobalIName in interface IRppsService

Returns:

the global i-name.

getICardByCUID

public ICardTO getICardByCUID(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(String cuid,
                                                       UITokenServiceCredentialTO tokenCredential)
                                                throws RppsException

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

getICardClaims

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

Specified by:

getICardClaims in interface IRppsService

Throws:

RppsException

getICardCreationTemplate

public ICardTemplateTO[] getICardCreationTemplate()

Return templates for creating cards

Specified by:

getICardCreationTemplate in interface IRppsService

Returns:

a template list

getICardCreationTemplateByProvider

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

Specified by:

getICardCreationTemplateByProvider in interface IRppsService

Throws:

RppsException

getICardCreationTemplateByTUID

public ICardTemplateTO getICardCreationTemplateByTUID(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.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()
                                                 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(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(String formatID)
                            throws RppsException

Specified by:

getICardsByFormat in interface IRppsService

Throws:

RppsException

getICardsByUser

public ICardResponseTO getICardsByUser()

Gets the card list of the specified user.

Specified by:

getICardsByUser in interface IRppsService

Returns:

the card list

getOutputFormats

public FormatDescriptorTO[] getOutputFormats()
                                      throws RppsException

Specified by:

getOutputFormats in interface IRppsService

Throws:

RppsException

getTokenByClaims

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

Web service operation. Makes xmlToken usage claim list.

Specified by:

getTokenByClaims in interface IRppsService

Parameters:

sslCert - the SSL certificate

Returns:

the security token transfer object

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

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

getTokenExtraByUrl

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

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

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:

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

Specified by:

getUserInterface in interface IRppsService

Parameters:

url - the URL to the html page with