org.eclipse.higgins.rpps.webservices
Interface RPPSServiceSEI

All Superinterfaces:

Remote

All Known Implementing Classes:

RPPSServiceImpl

public interface RPPSServiceSEI

extends Remote

This is the service endpoint interface for the RPPSServiceweb service. Created 18.01.2007 10:34:54

Author:

Sergei Yakovlev, Artem Verkhovets

Method Summary

org.eclipse.higgins.rpps.core.tobj.CategoryTO	addCategory(String userId, String password, org.eclipse.higgins.rpps.core.tobj.CategoryTO category) Web service operation.
void	addClaimValuesMRU(String userId, String password, String claimType, String claimValue) Web service operation.
boolean	addUrlCardRelation(String userId, String password, String cuid, String url) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ResponseMessage	addUserProfile(String userId, String password, org.eclipse.higgins.rpps.core.tobj.UserProfileTO userProfile) Web service operation.
void	addUserProfileFromHBX(String userId, String password) Web service operation.
org.eclipse.higgins.rpps.core.tobj.FormatDescriptorTO	checkImportStream(String userId, String password, byte[] crd) Checks whether RppsService can recognize data format of the provided input stream.
org.eclipse.higgins.rpps.core.tobj.ICardTO	clearCardCredential(String userId, String password, String cuid) Web service operation.
boolean	clearCardHistory(String userId, String password, String cuid) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTO	createDuplicateICard(String userId, String password, String cardName, String cuid, String pinCode) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTO	createICardByTemplate(String userId, String password, org.eclipse.higgins.rpps.core.tobj.ICardTemplateTO template) Web service operation.
String	createICardFromHBX(String userId, String password, String cardname) Deprecated.
void	deleteAllICard(String userId, String password) Web service operation.
boolean	deleteCardHistoryRecord(String userId, String password, String cuid, String url) Web service operation.
void	deleteCategory(String userId, String password, String categoryId) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardUpdateResponseTO	deleteICard(String userId, String password, String cuid) Web service operation.
boolean	deleteUrlCardRelation(String userId, String password, String cuid, String url) Web service operation.
boolean	deleteUrlsCardsRelations(String userId, String password, String cuid) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ResponseMessage	deleteUserProfile(String userId, String password) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTO	editPinCode(String userId, String password, String cuid, String oldPinCode, String newPinCode) Web service operation.
byte[]	exportICards(String userId, String password, String formatID, String[] cards, org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO credential) Web service operation.
void	generatePasswordResetCode(String userIdentifier) Web service operation.
void	generatePasswordResetCodeWithCaptcha(String userIdentifier, String captchaId, String captchaResponse) Web service operation.
org.eclipse.higgins.rpps.core.tobj.CaptchaTO	getCaptcha() Generate CaptchaTO.
org.eclipse.higgins.rpps.core.tobj.CardUsageTO[]	getCardHistory(String userId, String password, String cuid, int startFrom, int capacity, String orderBy, String orderDirection) Web service operation.
org.eclipse.higgins.rpps.core.tobj.CardInformationTO	getCardInformation(String userId, String password, String cuid, int size) Web service operation.
org.eclipse.higgins.rpps.core.tobj.CategoryTO[]	getCategory(String userId, String password) Web service operation.
org.eclipse.higgins.rpps.core.tobj.MapTO[]	getClaimValuesMRU(String userId, String password) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTO	getDefaultPCard(String userId, String password) Web service operation.
String[]	getHBXUIList(String version, String windowsName) Deprecated.
String	getHigginsServiceGlobalIName() Deprecated.
org.eclipse.higgins.rpps.core.tobj.ICardTO	getICardById(String userId, String password, String cuid) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTO	getICardByIdAndTokenServiceCredential(String userId, String password, String cuid, org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO userCredential) Web service operation.
org.eclipse.higgins.rpps.core.tobj.UIResponseCardTO	getICardClaims(String userId, String password, String cuid, String policy, String typeofCredential, String[] credentialKey, String[] credentialValue) Deprecated.
org.eclipse.higgins.rpps.core.tobj.ICardTemplateTO[]	getICardCreationTemplate(String userId, String password) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardResponseTO	getICards(String userId, String password) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardsAndCategoryTO	getICardsAndCategoriesByUser(String userId, String password) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTO[]	getICardsByCUIDs(String userId, String password, String[] cuids) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTO[]	getICardsByFormat(String userId, String password, String formatID) Web service operation.
org.eclipse.higgins.rpps.core.tobj.FormatDescriptorTO[]	getOutputFormats(String userId, String password) Web service operation.
org.eclipse.higgins.rpps.core.tobj.TokenResponseTO	getTokenByClaims(String sslCert, String claimNameArray, String claimValueArray) Web service operation.
org.eclipse.higgins.rpps.core.tobj.TokenResponseTO	getTokenByUrl(String userId, String password, String policy, String policytype, String sslCert, String url) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ExtraTokenResponseTO	getTokenExtraByUrl(String userId, String password, String policy, String policytype, String sslCert, String url) Web service operation.
org.eclipse.higgins.rpps.core.tobj.TokenResponseTO	getTokenObject(String userId, String password, String policy, String policytype, String sslCert, String[] cuids, String typeofCredential, String[] credentialKey, String[] credentialValue) Web service operation.
org.eclipse.higgins.rpps.core.tobj.UIResponseTO	getUI(String userId, String password, String url, String target, String sslCert, String policytype, String policy) Web service operation.
org.eclipse.higgins.rpps.core.tobj.UserProfileTO	getUserProfile(String userId, String password) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardResponseTO	importICardAsByteArray(String userId, String password, byte[] crd) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardResponseTO	importICards(String userId, String password, byte[] crd, String formatID, org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO credential) Web service operation.
void	importICardsAsString(String userId, String password, String crd) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ResponseMessage	modifyCategories(String userId, String password, org.eclipse.higgins.rpps.core.tobj.CategoryTO[] categories) Web service operation.
org.eclipse.higgins.rpps.core.tobj.CategoryTO	modifyCategory(String userId, String password, org.eclipse.higgins.rpps.core.tobj.CategoryTO category) Web service operation.
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.
void	modifyPasswordWithPasswordResetCodeAndCaptcha(String userIdentifier, String passwordResetCode, String newPassword, String captchaId, String captchaResponse) Update user password, requires password reset code for identify.
org.eclipse.higgins.rpps.core.tobj.UserProfileTO	modifyUserProfile(String userId, String password, org.eclipse.higgins.rpps.core.tobj.UserProfileTO userProfile) Web service operation.
void	removeClaimValuesMRU(String userId, String password, String claimType, String claimValue) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTO	resetPinCode(String userId, String password, String cuid, String oldPinCode) Web service operation.
boolean	setCardCredential(String userId, String password, String cuid, org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO tokenCredential) Web service operation.
void	setDefaultPCard(String userId, String password, String pcardId) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTO	setPinCode(String userId, String password, String cuid, String pinCode) Web service operation.
String[]	testStringArray(String[] strArray) Deprecated.
org.eclipse.higgins.rpps.core.tobj.ICardUpdateResponseTO[]	updateClaimsAcrossCards(String userId, String password, String[] claimTypes, String[] claimValues, org.eclipse.higgins.rpps.core.tobj.ICardUpdateTO[] cardUpdate) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTO	updateICard(String userId, String password, org.eclipse.higgins.rpps.core.tobj.ICardTO icardTO) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardUpdateResponseTO[]	updateICards(String userId, String password, org.eclipse.higgins.rpps.core.tobj.ICardTO[] icardTOs) Web service operation.
boolean	userIdentifierExists(String userId) Web service operation.

Method Detail

createICardByTemplate

public org.eclipse.higgins.rpps.core.tobj.ICardTO createICardByTemplate(String userId,
                                                                        String password,
                                                                        org.eclipse.higgins.rpps.core.tobj.ICardTemplateTO template)
                                                                 throws javax.xml.rpc.soap.SOAPFaultException

Web service operation. Creates a new card by template

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

template - the icard's template

Returns:

a new card as a ICardTO

Throws:

RemoteException

javax.xml.rpc.soap.SOAPFaultException

createICardFromHBX

public String createICardFromHBX(String userId,
                                 String password,
                                 String cardname)
                          throws javax.xml.rpc.soap.SOAPFaultException

Deprecated.

Web service operation. This method creating a new card for HBX

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

cardname - the card's name

Returns:

a new card's cuid

Throws:

javax.xml.rpc.soap.SOAPFaultException

createDuplicateICard

public org.eclipse.higgins.rpps.core.tobj.ICardTO createDuplicateICard(String userId,
                                                                       String password,
                                                                       String cardName,
                                                                       String cuid,
                                                                       String pinCode)
                                                                throws javax.xml.rpc.soap.SOAPFaultException

Web service operation. This method create duplicate of personal card only

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

cardName - name of new card

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:

javax.xml.rpc.soap.SOAPFaultException

getICardCreationTemplate

public org.eclipse.higgins.rpps.core.tobj.ICardTemplateTO[] getICardCreationTemplate(String userId,
                                                                                     String password)
                                                                              throws javax.xml.rpc.soap.SOAPFaultException

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

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

Returns:

a template list as array of ICardTemplateTO

Throws:

javax.xml.rpc.soap.SOAPFaultException

getUI

public org.eclipse.higgins.rpps.core.tobj.UIResponseTO getUI(String userId,
                                                             String password,
                                                             String url,
                                                             String target,
                                                             String sslCert,
                                                             String policytype,
                                                             String policy)
                                                      throws javax.xml.rpc.soap.SOAPFaultException

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

userId - the id to identify the user.

password - the password to identify the user.

url - the URL to the page with