Difference between revisions of "Org.eclipse.higgins.icard"

Revision as of 13:08, 28 October 2006

This page describes the I-Card interface that all types of Higgins-compatible I-Cards must implement. It also describes other interfaces that implementers may choose to implement.

I-Card Interface

// Return the human friendly name of the card
String getCardName();

URI getUUID();

// Return the human friendly name of the card issuer (creator)
String getIssuerName();

// Return a background image of the card
Image getCardImage();
 
// Return the mime type of the background image (JPEG or GIF)
String getImageMimeType();

// Return when the card was first issued
Datetime getTimeIssued();

// Return the date and time after which the card should be 
// treated as expired and invalid. If there is no expiration 
// If card handles only simple claim types then 
// return a list of all possible types of claims that are supported
// throw exception otherwise
Iterable<String> getSupportedSimpleClaimTypes();

// If card handles complex claim types then
// return an OWL-DL schema describing types of complex claim 
// objects that are supported
String getSupportedComplexClaimTypes();

// Given a relying party policy Policy, return true
// if this card can provide the claims required/desired by the relying party
// else return false
boolean isMatch(Policy);

// Return whether the user wishes to be asked for explicit release of
// this card's information (i) every time it is requested (ii) only 
// the first time it is requested (iii) never 
ReleasePolicy getReleasePolicy();

// Set the release policy of this card
void setReleasePolicy(ReleasePolicy);

// Return a list of the types of expored card data stream formats supported
// ?? presumably a CardFormat also mentions XML language and/or version number
<Iterable>CardFormat getSupportedExportFormats();

// Return a data stream containing a serialization of the card
// The format depends on the kind of card 
// E.g. CardSpace I-Cards will export CardSpace format data
String export(CardFormat format);

To Do

• Need methods to get/set the access control list idea (see I-Card)

TokenIssuerCard Interface

// Return the EPR of the card issuer
// For CardSpace cards this is either the local STS endpoint (for
// self-asserted cards) or a remote STS (for managed cards)
// For some other kinds of cards this is might be an IdAS service endpoint
EndpointReference getICardIssuerEndpoint();

// If card is of type (1) then return a Digital Identity 
// that satisfies the policy policy
// The credential parameter used to authenticate to the 
// Token Issuer–-may be null if Token Issuer policy doesn’t require it
DigitalIdentity requestDigitalIdentity(Policy policy, DigitalIdentity credential);

// Return a list of endpoint references, credential hint, credential selector
Iterable<TokenService> getTokenServices()

// Return a list of supported token types
?? getPolicy?? (); 

// Is the RP identity required in the token request message?
boolean getRequireAppliesTo()

URLIssuerCard Interface

// Return a URL
// that satisfies the policy policy
URL requestURL(Policy policy);

IdASProvider

 ContextRef getContextRef();

See Also

• I-Card Provider
• I-Card Registry
• Higgins Wiki