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

Method Summary

org.eclipse.higgins.rpps.core.tobj.CategoryTO	addCategory(String userId, String password, org.eclipse.higgins.rpps.core.tobj.CategoryTO category)
org.eclipse.higgins.rpps.core.tobj.ResponseMessage	addUserProfile(String userId, String password, org.eclipse.higgins.rpps.core.tobj.UserProfileTO userProfile)
void	addUserProfileFromHBX(String userId, String password)
org.eclipse.higgins.rpps.core.tobj.FormatDescriptorTO	checkImportStream(String userId, String password, byte[] crd)
org.eclipse.higgins.rpps.core.tobj.ICardTO	clearCardCredential(String userId, String password, String cuid)
boolean	clearCardHistory(String userId, String password, String cuid)
void	connectionNotify(String userId, String password, String host, String username, boolean success) Web service operation Locate the URIICard-type I-Card whose URI matches 'cref'.
boolean	connectionVerify(String userId, String password, String host, String username) The RP site invokes this method to verify that user really has an account on the specified site.
org.eclipse.higgins.rpps.core.tobj.ICardTO	createDuplicateICard(String userId, String password, String cardName, String cuid, String pinCode)
String	createICardByArrayProperties(String userId, String password, String id, String[] properties) Web service operation creating a new card
String	createICardByProperty(String userId, String password, String id, String properties) Web service operation creating a new card
org.eclipse.higgins.rpps.core.tobj.ICardTO	createICardByTemplate(String userId, String password, org.eclipse.higgins.rpps.core.tobj.ICardTemplateTO template) Web service operation creating a new card
String	createICardFromHBX(String userId, String password, String cardname) Web service operation creating a new card for HBX
void	deleteAllICard(String userId, String password) Web service operation.
void	deleteCategory(String userId, String password, String categoryId)
void	deleteICard(String userId, String password, String cuid) Web service operation.
boolean	deleteUrlCardRelation(String userId, String password, String cuid, String url)
org.eclipse.higgins.rpps.core.tobj.ResponseMessage	deleteUserProfile(String userId, String password)
org.eclipse.higgins.rpps.core.tobj.ICardTO	editPinCode(String userId, String password, String cuid, String oldPinCode, String newPinCode)
byte[]	exportICards(String userId, String password, String formatID, String[] cards, org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO credential)
org.eclipse.higgins.rpps.core.tobj.CardUsageTO[]	getCardHistory(String userId, String password, String cuid, int startFrom, int capacity, String orderBy, String orderDirection)
org.eclipse.higgins.rpps.core.tobj.CardInformationTO	getCardInformation(String userId, String password, String cuid, int size)
org.eclipse.higgins.rpps.core.tobj.CategoryTO[]	getCategory(String userId, String password)
String	getFormFillingScript(String page, String username, String form) Gets a form filling script for the specified site&user
String[]	getHBXUIList(String version, String windowsName)
String	getHigginsServiceGlobalIName() Web service operation.
String	getHtmlScrapingScript(String page) Gets an HTML scraping script for the specified site
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)
org.eclipse.higgins.rpps.core.tobj.ICardTemplateTO[]	getICardCreationTemplate(String userId, String password) Web service operation creating a new card
org.eclipse.higgins.rpps.core.tobj.ICardTO[]	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[]	getICardsByFormat(String userId, String password, String formatID)
org.eclipse.higgins.rpps.core.tobj.FormatDescriptorTO[]	getOutputFormats(String userId, String password)
org.eclipse.higgins.rpps.core.tobj.ICardTemplateTO	getPersonalICardCreationTemplate(String userId, String password) Return templates for creating personal card
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)
org.eclipse.higgins.rpps.core.tobj.ICardTO[]	importICardAsByteArray(String userId, String password, byte[] crd) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTO[]	importICards(String userId, String password, byte[] crd, String formatID, org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO credential)
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)
org.eclipse.higgins.rpps.core.tobj.CategoryTO	modifyCategory(String userId, String password, org.eclipse.higgins.rpps.core.tobj.CategoryTO category)
org.eclipse.higgins.rpps.core.tobj.UserProfileTO	modifyUserProfile(String userId, String password, org.eclipse.higgins.rpps.core.tobj.UserProfileTO userProfile)
org.eclipse.higgins.rpps.core.tobj.ICardTO	resetPinCode(String userId, String password, String cuid, String oldPinCode)
boolean	setCardCredential(String userId, String password, String cuid, org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO tokenCredential)
void	setHtmlScrapingScript(String page, String script) Sets an HTML scraping script for the specified site
org.eclipse.higgins.rpps.core.tobj.ICardTO	setPinCode(String userId, String password, String cuid, String pinCode)
String[]	testStringArray(String[] strArray) 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
boolean	userIdentifierExists(String userId)

Method Detail

createICardByProperty

public String createICardByProperty(String userId,
                                    String password,
                                    String id,
                                    String properties)
                             throws RemoteException

Web service operation creating a new card

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

id - the i-card id

properties - the i-card properties

Returns:

a new card cuid

Throws:

RemoteException

createICardByArrayProperties

public String createICardByArrayProperties(String userId,
                                           String password,
                                           String id,
                                           String[] properties)
                                    throws RemoteException

Web service operation creating a new card

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

id - the i-card id

properties - the i-card properties

Returns:

a new card cuid

Throws:

RemoteException

createICardByTemplate

public org.eclipse.higgins.rpps.core.tobj.ICardTO createICardByTemplate(String userId,
                                                                        String password,
                                                                        org.eclipse.higgins.rpps.core.tobj.ICardTemplateTO template)
                                                                 throws RemoteException

Web service operation creating a new card

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

Returns:

a new card cuid

Throws:

RemoteException

createICardFromHBX

public String createICardFromHBX(String userId,
                                 String password,
                                 String cardname)
                          throws RemoteException

Web service operation creating a new card for HBX

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

Returns:

a new card cuid

Throws:

RemoteException

createDuplicateICard

public org.eclipse.higgins.rpps.core.tobj.ICardTO createDuplicateICard(String userId,
                                                                       String password,
                                                                       String cardName,
                                                                       String cuid,
                                                                       String pinCode)
                                                                throws RemoteException

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

cardName - name of new card

cuid - cuid of old card

Returns:

a new card

Throws:

RemoteException

getICardCreationTemplate

public org.eclipse.higgins.rpps.core.tobj.ICardTemplateTO[] getICardCreationTemplate(String userId,
                                                                                     String password)
                                                                              throws RemoteException

Web service operation creating a new card

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

Returns:

a template list

Throws:

RemoteException

connectionNotify

public void connectionNotify(String userId,
                             String password,
                             String host,
                             String username,
                             boolean success)
                      throws RemoteException

Web service operation Locate the URIICard-type I-Card whose URI matches 'cref'. If no such card exists, create it. Find the Digital Subject whose unique identifier is 'cuid'. On the uniqueIdentifier attribute value itself: (1) if 'success' is true, add/update to "now" the the lastVerifiedFromSource metadata property's timestamp and (2) add/update the lastVerifiedAttempt metadata property's timestamp to "now".

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

host - the host name of the RP site where user is verified

username - the user name to login to the RP site

success - the verifying result

Throws:

RemoteException

getFormFillingScript

public String getFormFillingScript(String page,
                                   String username,
                                   String form)
                            throws RemoteException

Gets a form filling script for the specified site&user

Parameters:

page - the page url where user lands on

username - the user name

form - the HTML form name

Returns:

a form filling script

Throws:

RemoteException

getHtmlScrapingScript

public String getHtmlScrapingScript(String page)
                             throws RemoteException

Gets an HTML scraping script for the specified site

Parameters:

page - the page url

Returns:

an HTML scraping script

Throws:

RemoteException

setHtmlScrapingScript

public void setHtmlScrapingScript(String page,
                                  String script)
                           throws RemoteException

Sets an HTML scraping script for the specified site

Parameters:

page - the page url

script - the script body

Throws:

RemoteException

connectionVerify

public boolean connectionVerify(String userId,
                                String password,
                                String host,
                                String username)
                         throws RemoteException

The RP site invokes this method to verify that user really has an account on the specified site.

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

host - The verified site url.

username - The username to login onto verified site.

Returns:

The result of verification process.

Throws:

RemoteException

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 RemoteException

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 html page with