org.eclipse.higgins.rpps.webservices
Class RPPSServiceImpl

java.lang.Object
  org.eclipse.higgins.rpps.webservices.RPPSServiceImpl

All Implemented Interfaces:

Remote, RPPSServiceSEI

public class RPPSServiceImpl

extends Object

implements RPPSServiceSEI

This is the implementation bean class for the RPPSService web service. Created 18.01.2007 10:34:54

Author:

Sergei Yakovlev, Artem Verkhovets

Constructor Summary

RPPSServiceImpl()

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 creating a new card by card template
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) Web service operation.
String	getHigginsServiceGlobalIName() Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTO	getICardById(String userId, String password, String cuid) Gets the card by id
org.eclipse.higgins.rpps.core.tobj.ICardTO	getICardByIdAndTokenServiceCredential(String userId, String password, String cuid, org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO userCredintial) 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) Web service operation.
org.eclipse.higgins.rpps.core.tobj.ICardTemplateTO[]	getICardCreationTemplate(String userId, String password) Web service operation returns template list for card creating
org.eclipse.higgins.rpps.core.tobj.ICardResponseTO	getICards(String userId, String password) Gets the card list of the specified user.
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) Gets cards by CUIDs array.
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 return security token by list claims.
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) Web service operation.
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 userIdentifier) Web service operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

RPPSServiceImpl

public RPPSServiceImpl()

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 creating a new card by card template

Specified by:

createICardByTemplate in interface RPPSServiceSEI

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

template - the icard's template

Returns:

a new card id

Throws:

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 creating a new card for HBX

Specified by:

createICardFromHBX in interface RPPSServiceSEI

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

cardname - the card's name

Returns:

a new card 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

Description copied from interface: RPPSServiceSEI

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

Specified by:

createDuplicateICard in interface RPPSServiceSEI

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

deleteICard

public org.eclipse.higgins.rpps.core.tobj.ICardUpdateResponseTO deleteICard(String userId,
                                                                            String password,
                                                                            String cuid)
                                                                     throws javax.xml.rpc.soap.SOAPFaultException

Web service operation. Deletes specified card.

Specified by:

deleteICard in interface RPPSServiceSEI

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

cuid - the icard's CUID

Returns:

Returns ICardUpdateResponseTO which contains delete status for card. If code field equals 0 then card was updated correctly. Otherwise code field contains error code. If deleted card had self signed type then cuid field contains cuid of personal card which had been used to signed managed card.

Throws:

javax.xml.rpc.soap.SOAPFaultException

deleteAllICard

public void deleteAllICard(String userId,
                           String password)
                    throws javax.xml.rpc.soap.SOAPFaultException

Web service operation. Deletes all user's card.

Specified by:

deleteAllICard in interface RPPSServiceSEI

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

Throws:

java.rmi.SOAPFaultException

javax.xml.rpc.soap.SOAPFaultException

getHigginsServiceGlobalIName

public String getHigginsServiceGlobalIName()
                                    throws javax.xml.rpc.soap.SOAPFaultException

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

Specified by:

getHigginsServiceGlobalIName in interface RPPSServiceSEI

Returns:

the global i-name.

Throws:

javax.xml.rpc.soap.SOAPFaultException

importICardAsByteArray

public org.eclipse.higgins.rpps.core.tobj.ICardResponseTO importICardAsByteArray(String userId,
                                                                                 String password,
                                                                                 byte[] crd)
                                                                          throws javax.xml.rpc.soap.SOAPFaultException

Web service operation. Imports card from a file.

Specified by:

importICardAsByteArray in interface RPPSServiceSEI

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

crd - the card as a byte array.

Returns:

list of cards

Throws:

javax.xml.rpc.soap.SOAPFaultException

importICards

public org.eclipse.higgins.rpps.core.tobj.ICardResponseTO importICards(String userId,
                                                                       String password,
                                                                       byte[] crd,
                                                                       String formatID,
                                                                       org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO credential)
                                                                throws javax.xml.rpc.soap.SOAPFaultException

Description copied from interface: RPPSServiceSEI

Web service operation. Import cards from special format file.

Specified by:

importICards in interface RPPSServiceSEI

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

crd - file's context

formatID - file's format identifier

credential - authentication information

Returns:

ICardResponseTO

Throws:

javax.xml.rpc.soap.SOAPFaultException

checkImportStream

public org.eclipse.higgins.rpps.core.tobj.FormatDescriptorTO checkImportStream(String userId,
                                                                               String password,
                                                                               byte[] crd)
                                                                        throws javax.xml.rpc.soap.SOAPFaultException

Description copied from interface: RPPSServiceSEI

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.

Specified by:

checkImportStream in interface RPPSServiceSEI

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

crd - context of file as byte array

Returns:

the information about input stream data format if it was recognized successfully and null otherwise.

Throws:

javax.xml.rpc.soap.SOAPFaultException

exportICards

public byte[] exportICards(String userId,
                           String password,
                           String formatID,
                           String[] cards,
                           org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO credential)
                    throws javax.xml.rpc.soap.SOAPFaultException

Description copied from interface: RPPSServiceSEI

Web service operation. Returns file as byte array with special which contains select cards.

Specified by:

exportICards in interface RPPSServiceSEI

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

formatID - file's format identifier

cards - the icard's CUIDs

credential - authentication information

Returns:

array of byte

Throws:

javax.xml.rpc.soap.SOAPFaultException

getICardsByFormat

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

Description copied from interface: RPPSServiceSEI

Web service operation. Gets cards which may be export to special file format

Specified by:

getICardsByFormat in interface RPPSServiceSEI

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

formatID -

Returns:

list of cards as a array of CardTO

Throws:

javax.xml.rpc.soap.SOAPFaultException

getOutputFormats

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

Description copied from interface: RPPSServiceSEI

Web service operation. Gets available file format for cards export

Specified by:

getOutputFormats in interface RPPSServiceSEI

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

Returns:

array of FormatDescriptorTO

Throws:

javax.xml.rpc.soap.SOAPFaultException

See Also:

FormatDescriptorTO

importICardsAsString

public void importICardsAsString(String userId,
                                 String password,
                                 String crd)
                          throws javax.xml.rpc.soap.SOAPFaultException

Web service operation. Imports card from a file.

Specified by:

importICardsAsString in interface RPPSServiceSEI

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

crd - the card as a string.

Returns:

list of cards

Throws:

javax.xml.rpc.soap.SOAPFaultException

testStringArray

public String[] testStringArray(String[] strArray)
                         throws javax.xml.rpc.soap.SOAPFaultException

Web service operation. The test method that returns inputed string array.

Specified by:

testStringArray in interface RPPSServiceSEI

Parameters:

strArray - the string array to be returned.

Returns:

the string array inputed as a parameter.

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

Specified by:

getUI in interface RPPSServiceSEI

Parameters:

userId - the id to identify the user.

password - the password to identify the user.

url - the URL to the html page with