Overview  Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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.
 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.
 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.
 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.
 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 RemoteException
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

createICardFromHBX

public String createICardFromHBX(String userId,
                                 String password,
                                 String cardname)
                          throws RemoteException
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:
RemoteException

createDuplicateICard

public org.eclipse.higgins.rpps.core.tobj.ICardTO createDuplicateICard(String userId,
                                                                       String password,
                                                                       String cardName,
                                                                       String cuid,
                                                                       String pinCode)
                                                                throws RemoteException
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:
RemoteException

getICardCreationTemplate

public org.eclipse.higgins.rpps.core.tobj.ICardTemplateTO[] getICardCreationTemplate(String userId,
                                                                                     String password)
                                                                              throws RemoteException
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:
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 page with tag
target -
sslCert - the SSL certificate
policytype - the RP Security Policy type
policy - the RP Agent's Relying Party Security Policy
Returns:
the UIResponseTO transfer object.
Throws:
RemoteException

getICardByIdAndTokenServiceCredential

public org.eclipse.higgins.rpps.core.tobj.ICardTO getICardByIdAndTokenServiceCredential(String userId,
                                                                                        String password,
                                                                                        String cuid,
                                                                                        org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO userCredential)
                                                                                 throws org.eclipse.higgins.rpps.core.tobj.StsFaultException,
                                                                                        RemoteException
Web service operation. This method gets the card with retrieved claims.

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the card's cuid
userCredential - filled card credential for retrieve claims
Returns:
the card as a ICardTO
Throws:
RemoteException
org.eclipse.higgins.rpps.core.tobj.StsFaultException

getICardClaims

public org.eclipse.higgins.rpps.core.tobj.UIResponseCardTO getICardClaims(String userId,
                                                                          String password,
                                                                          String cuid,
                                                                          String policy,
                                                                          String typeofCredential,
                                                                          String[] credentialKey,
                                                                          String[] credentialValue)
                                                                   throws RemoteException
Deprecated.  

Web service operation. Created for some demo.

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the card's cuid.
policy -
typeofCredential -
credentialKey -
credentialValue -
Returns:
UIResponseCardTO
Throws:
RemoteException

getICardById

public org.eclipse.higgins.rpps.core.tobj.ICardTO getICardById(String userId,
                                                               String password,
                                                               String cuid)
                                                        throws RemoteException
Web service operation. This method gets the card list of the specified user.

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the card's cuid.
Returns:
the card list
Throws:
RemoteException

getICards

public org.eclipse.higgins.rpps.core.tobj.ICardResponseTO getICards(String userId,
                                                                    String password)
                                                             throws RemoteException
Web service operation. This method gets ICardResponseTO which contains the card list and card relation list of the specified user.

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
Returns:
ICardResponseTO
Throws:
RemoteException

getICardsByCUIDs

public org.eclipse.higgins.rpps.core.tobj.ICardTO[] getICardsByCUIDs(String userId,
                                                                     String password,
                                                                     String[] cuids)
                                                              throws RemoteException
Web service operation. This method gets cards as array of ICardTO by CUIDs array.

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuids - the card CUIDs.
Returns:
array of ICardTO.
Throws:
RemoteException

getICardsAndCategoriesByUser

public org.eclipse.higgins.rpps.core.tobj.ICardsAndCategoryTO getICardsAndCategoriesByUser(String userId,
                                                                                           String password)
                                                                                    throws RemoteException
Web service operation. This method gets the card list and category list of the specified user.

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
Returns:
ICardsAndCategoryTO which contain the cards and the categorys lists
Throws:
RemoteException

updateICard

public org.eclipse.higgins.rpps.core.tobj.ICardTO updateICard(String userId,
                                                              String password,
                                                              org.eclipse.higgins.rpps.core.tobj.ICardTO icardTO)
                                                       throws RemoteException
Web service operation. This method update card

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
Throws:
RemoteException

updateICards

public org.eclipse.higgins.rpps.core.tobj.ICardUpdateResponseTO[] updateICards(String userId,
                                                                               String password,
                                                                               org.eclipse.higgins.rpps.core.tobj.ICardTO[] icardTOs)
                                                                        throws RemoteException
Web service operation. This method update list of cards

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
Throws:
RemoteException

importICardAsByteArray

public org.eclipse.higgins.rpps.core.tobj.ICardResponseTO importICardAsByteArray(String userId,
                                                                                 String password,
                                                                                 byte[] crd)
                                                                          throws RemoteException
Web service operation. Imports card from a file.

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:
RemoteException

importICardsAsString

public void importICardsAsString(String userId,
                                 String password,
                                 String crd)
                          throws RemoteException
Web service operation. Imports card from a file.

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
crd - the card as a string.
Throws:
RemoteException

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 RemoteException
Web service operation. Import cards from special format file.

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:
RemoteException

checkImportStream

public org.eclipse.higgins.rpps.core.tobj.FormatDescriptorTO checkImportStream(String userId,
                                                                               String password,
                                                                               byte[] crd)
                                                                        throws RemoteException
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.

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:
org.eclipse.higgins.rpps.core.RppsException
RemoteException

exportICards

public byte[] exportICards(String userId,
                           String password,
                           String formatID,
                           String[] cards,
                           org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO credential)
                    throws RemoteException
Web service operation. Returns file as byte array with special which contains select cards.

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:
RemoteException

getICardsByFormat

public org.eclipse.higgins.rpps.core.tobj.ICardTO[] getICardsByFormat(String userId,
                                                                      String password,
                                                                      String formatID)
                                                               throws RemoteException
Web service operation. Gets cards which may be export to special file format

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:
RemoteException

getOutputFormats

public org.eclipse.higgins.rpps.core.tobj.FormatDescriptorTO[] getOutputFormats(String userId,
                                                                                String password)
                                                                         throws RemoteException
Web service operation. Gets available file format for cards export

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
Returns:
array of FormatDescriptorTO
Throws:
RemoteException
See Also:
FormatDescriptorTO

deleteICard

public org.eclipse.higgins.rpps.core.tobj.ICardUpdateResponseTO deleteICard(String userId,
                                                                            String password,
                                                                            String cuid)
                                                                     throws RemoteException
Web service operation. Deletes specified card.

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:
RemoteException

deleteAllICard

public void deleteAllICard(String userId,
                           String password)
                    throws RemoteException
Web service operation. Deletes all user's card.

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
Throws:
RemoteException

getHigginsServiceGlobalIName

public String getHigginsServiceGlobalIName()
                                    throws RemoteException
Deprecated.  

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

Returns:
the global i-name.
Throws:
RemoteException

testStringArray

public String[] testStringArray(String[] strArray)
                         throws RemoteException
Deprecated.  

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

Parameters:
strArray - the string array to be returned.
Returns:
the string array inputed as a parameter.
Throws:
RemoteException

getTokenByClaims

public org.eclipse.higgins.rpps.core.tobj.TokenResponseTO getTokenByClaims(String sslCert,
                                                                           String claimNameArray,
                                                                           String claimValueArray)
                                                                    throws RemoteException
Web service operation. Makes xmlToken usage claim list.

Parameters:
sslCert - the SSL certificate
claimNameArray - the array which contains claim names
claimValueArray - the array which contains claim values
Returns:
the security token as a String
Throws:
RemoteException

getTokenObject

public 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)
                                                                  throws RemoteException
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:
userId - the id to identify the user.
password - the password to identify the user.
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

getTokenByUrl

public org.eclipse.higgins.rpps.core.tobj.TokenResponseTO getTokenByUrl(String userId,
                                                                        String password,
                                                                        String policy,
                                                                        String policytype,
                                                                        String sslCert,
                                                                        String url)
                                                                 throws RemoteException
Web service operation. Makes security token usage saved users information

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
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

getTokenExtraByUrl

public org.eclipse.higgins.rpps.core.tobj.ExtraTokenResponseTO getTokenExtraByUrl(String userId,
                                                                                  String password,
                                                                                  String policy,
                                                                                  String policytype,
                                                                                  String sslCert,
                                                                                  String url)
                                                                           throws RemoteException
Web service operation. Makes security token usage saved users information

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
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

getUserProfile

public org.eclipse.higgins.rpps.core.tobj.UserProfileTO getUserProfile(String userId,
                                                                       String password)
                                                                throws AccessException,
                                                                       RemoteException
Web service operation. Gets user profile as a UserProfileTO

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
Returns:
user profile information
Throws:
RemoteException
AccessException

addUserProfileFromHBX

public void addUserProfileFromHBX(String userId,
                                  String password)
                           throws RemoteException
Web service operation. Add user profile

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
Throws:
RemoteException

addUserProfile

public org.eclipse.higgins.rpps.core.tobj.ResponseMessage addUserProfile(String userId,
                                                                         String password,
                                                                         org.eclipse.higgins.rpps.core.tobj.UserProfileTO userProfile)
                                                                  throws RemoteException
Web service operation. Creates a new user profile

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
userProfile - the userProfile profile information as UserProfileTO
Returns:
Returns ResponseMessage with code field equals 0 if profile was added. Otherwise returns ResponseMessage with error code or throws an RemoteException
Throws:
RemoteException

addUrlCardRelation

public boolean addUrlCardRelation(String userId,
                                  String password,
                                  String cuid,
                                  String url)
                           throws RemoteException
Web service operation. Create relation between card and url

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the icard's CUID
url - the web page url
Returns:
Returns true if relation was added. Otherwise false
Throws:
RemoteException

deleteUserProfile

public org.eclipse.higgins.rpps.core.tobj.ResponseMessage deleteUserProfile(String userId,
                                                                            String password)
                                                                     throws RemoteException
Web service operation. Delete user profile with all user information

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
Returns:
Returns ResponseMessage with code field equals 0 if profile was deleted. Otherwise returns ResponseMessage with error code or throws an RemoteException
Throws:
Exception
RemoteException

deleteUrlCardRelation

public boolean deleteUrlCardRelation(String userId,
                                     String password,
                                     String cuid,
                                     String url)
                              throws RemoteException
Web service operation. Delete relation between card and site's url

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the icard's CUID
url - the url of site
Returns:
Returns true if relation was deleted. Otherwise false
Throws:
RemoteException

deleteUrlsCardsRelations

public boolean deleteUrlsCardsRelations(String userId,
                                        String password,
                                        String cuid)
                                 throws RemoteException
Web service operation. Delete all relations between card and site's urls

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the icard's CUID
Returns:
Returns true if relations were deleted. Otherwise false
Throws:
RemoteException

userIdentifierExists

public boolean userIdentifierExists(String userId)
                             throws RemoteException
Web service operation. Checks availability of user profile by userIdentifier

Parameters:
userId - the id to identify the user.
Returns:
Returns true if user identifier exists. Otherwise false
Throws:
RemoteException

modifyUserProfile

public org.eclipse.higgins.rpps.core.tobj.UserProfileTO modifyUserProfile(String userId,
                                                                          String password,
                                                                          org.eclipse.higgins.rpps.core.tobj.UserProfileTO userProfile)
                                                                   throws RemoteException
Web service operation. This method update user profile information.

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
userProfile - user profile information
Returns:
Return updated user profile
Throws:
RemoteException

setPinCode

public org.eclipse.higgins.rpps.core.tobj.ICardTO setPinCode(String userId,
                                                             String password,
                                                             String cuid,
                                                             String pinCode)
                                                      throws RemoteException
Web service operation. Sets pin code protection on personal card

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the icard's CUID
pinCode - pin code
Returns:
Returns updated card object
Throws:
RemoteException

resetPinCode

public org.eclipse.higgins.rpps.core.tobj.ICardTO resetPinCode(String userId,
                                                               String password,
                                                               String cuid,
                                                               String oldPinCode)
                                                        throws RemoteException
Web service operation. Remove pin code protection from personal card

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the icard's CUID
oldPinCode - pin code
Returns:
Returns updated card object
Throws:
RemoteException

editPinCode

public org.eclipse.higgins.rpps.core.tobj.ICardTO editPinCode(String userId,
                                                              String password,
                                                              String cuid,
                                                              String oldPinCode,
                                                              String newPinCode)
                                                       throws RemoteException
Web service operation. Changes pin code for personal card

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the icard's CUID
oldPinCode - Old pin code
newPinCode - New pin code
Returns:
Returns updated card object
Throws:
RemoteException

getCategory

public org.eclipse.higgins.rpps.core.tobj.CategoryTO[] getCategory(String userId,
                                                                   String password)
                                                            throws RemoteException
Web service operation. Gets list of card categories

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
Returns:
Returns array of category transfer object
Throws:
RemoteException

addCategory

public org.eclipse.higgins.rpps.core.tobj.CategoryTO addCategory(String userId,
                                                                 String password,
                                                                 org.eclipse.higgins.rpps.core.tobj.CategoryTO category)
                                                          throws RemoteException
Web service operation. Creates a new card's category

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
category - the category transfer object
Returns:
Returns saved card category object
Throws:
RemoteException

deleteCategory

public void deleteCategory(String userId,
                           String password,
                           String categoryId)
                    throws RemoteException
Web service operation. Delete the card's category

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
categoryId - category identifier
Throws:
RemoteException

modifyCategory

public org.eclipse.higgins.rpps.core.tobj.CategoryTO modifyCategory(String userId,
                                                                    String password,
                                                                    org.eclipse.higgins.rpps.core.tobj.CategoryTO category)
                                                             throws RemoteException
Web service operation. Modifies the card's category

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
category - category transfer object
Returns:
Returns modified category
Throws:
RemoteException

modifyCategories

public org.eclipse.higgins.rpps.core.tobj.ResponseMessage modifyCategories(String userId,
                                                                           String password,
                                                                           org.eclipse.higgins.rpps.core.tobj.CategoryTO[] categories)
                                                                    throws RemoteException
Web service operation. Modifies list of card's category

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
categories - list of card's category
Returns:
Returns ResponseMessage with code field equals 0 if category was updated. Otherwise returns ResponseMessage with error code or throws an RemoteException
Throws:
RemoteException

getCardInformation

public org.eclipse.higgins.rpps.core.tobj.CardInformationTO getCardInformation(String userId,
                                                                               String password,
                                                                               String cuid,
                                                                               int size)
                                                                        throws RemoteException
Web service operation. Gets card information object

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the icard's CUID
size - count of card history element which will be returned
Returns:
Return card information object
Throws:
RemoteException

clearCardCredential

public org.eclipse.higgins.rpps.core.tobj.ICardTO clearCardCredential(String userId,
                                                                      String password,
                                                                      String cuid)
                                                               throws RemoteException
Web service operation. Deletes saved authentication card information of the specified card

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the icard's CUID
Returns:
Returns updated card object
Throws:
RemoteException

setCardCredential

public boolean setCardCredential(String userId,
                                 String password,
                                 String cuid,
                                 org.eclipse.higgins.rpps.core.tobj.UITokenServiceCredentialTO tokenCredential)
                          throws RemoteException
Web service operation. Saves authentication card information of the specified card

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the icard's CUID
tokenCredential - authentication card information
Returns:
Returns true if card credential was set. Otherwise false
Throws:
RemoteException

clearCardHistory

public boolean clearCardHistory(String userId,
                                String password,
                                String cuid)
                         throws RemoteException
Web service operation. Deletes card history of the specified card on all URIs unless it is checked as "Use Always".

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the icard's CUID
Returns:
Returns true if card history was cleared. Otherwise false
Throws:
RemoteException

deleteCardHistoryRecord

public boolean deleteCardHistoryRecord(String userId,
                                       String password,
                                       String cuid,
                                       String url)
                                throws RemoteException
Web service operation. Delete specified record of card history.

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the icard's CUID
url - url of site which will be deleted from card history
Returns:
Returns true if card history record was deleted. Otherwise false
Throws:
RemoteException

getCardHistory

public org.eclipse.higgins.rpps.core.tobj.CardUsageTO[] getCardHistory(String userId,
                                                                       String password,
                                                                       String cuid,
                                                                       int startFrom,
                                                                       int capacity,
                                                                       String orderBy,
                                                                       String orderDirection)
                                                                throws RemoteException
Web service operation. Return list of card history records, beginning at the specified position in selection.

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
cuid - the icard's CUID
startFrom - starting position in the selection
capacity - count of record which will be returned
orderBy - name of field which be used for sorting. Can take one of these values: "date"," site","useAlways"
orderDirection - If value of this parameter is "desc" then result will be sorted in descending order. Otherwise in ascending order.
Returns:
array of CardUsageTO
Throws:
RemoteException

getHBXUIList

public String[] getHBXUIList(String version,
                             String windowsName)
                      throws RemoteException
Deprecated.  

Web service operation.

Parameters:
version -
windowsName -
Returns:
array of HBX messages
Throws:
RemoteException

updateClaimsAcrossCards

public org.eclipse.higgins.rpps.core.tobj.ICardUpdateResponseTO[] updateClaimsAcrossCards(String userId,
                                                                                          String password,
                                                                                          String[] claimTypes,
                                                                                          String[] claimValues,
                                                                                          org.eclipse.higgins.rpps.core.tobj.ICardUpdateTO[] cardUpdate)
                                                                                   throws RemoteException
Web service operation. This method updates some claim values in list of cards

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
claimTypes - array of claim's types
claimValues - array of claim's types. Must be in the same order as claimTypes
cardUpdate - array of ICardUpdateTO
Returns:
Return array of ICardUpdateResponseTO which contains update status for every card. If code field equals 0 then card was updated correctly. Otherwise code field contains error code
Throws:
RemoteException

getClaimValuesMRU

public org.eclipse.higgins.rpps.core.tobj.MapTO[] getClaimValuesMRU(String userId,
                                                                    String password)
                                                             throws RemoteException
Web service operation. Gets most recently used records

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
Returns:
Returns array of MapTO
Throws:
RemoteException

addClaimValuesMRU

public void addClaimValuesMRU(String userId,
                              String password,
                              String claimType,
                              String claimValue)
                       throws RemoteException
Web service operation. Adds most recently used record

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
claimType - claim's type
claimValue - claim's value
Throws:
RemoteException

removeClaimValuesMRU

public void removeClaimValuesMRU(String userId,
                                 String password,
                                 String claimType,
                                 String claimValue)
                          throws RemoteException
Web service operation. Deletes most recently used record

Parameters:
userId - the id to identify the user.
password - the password to identify the user.
claimType - claim's type
claimValue - claim's value
Throws:
RemoteException
Overview  Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD