net.jxta.credential
Class AuthenticationCredential

java.lang.Object
  net.jxta.credential.AuthenticationCredential

All Implemented Interfaces:

Credential

public final class AuthenticationCredential
extends Object
implements Credential

Authenication credentials are used by JXTA Membership Services as the basis for applications for peergroup membership. The AuthenticationCredential provides two important pieces of inforamtion:

• the authetication method being requested
• identity information which will be provided to that authentication method.

Not all authentication methods use the identity nformation.

See Also:

Credential, MembershipService, Authenticator

---

Constructor Summary
AuthenticationCredential(PeerGroup peergroup, Element root)           Creates new AuthenticationCredential
AuthenticationCredential(PeerGroup peergroup, String method, Element indentityInfo)           Creates new AuthenticationCredential

 

Method Summary
StructuredDocument	getDocument(MimeMediaType as)           Write credential into a document. as is a mime media-type specification and provides the form of the document which is being requested.
Element	getIdentityInfo()           Returns the StructuredDocument Element containing the identity information which was originally provided when this AuthenticationCredential was created.
String	getMethod()           Returns the authentication method which this AuthenticationCredential will be requesting when it is provided to a Membership Service during the "Apply" operation.
ID	getPeerGroupID()           Returns the peerGroupID associated with this credential AuthenticationCredentials are created in the context of a PeerGroup though they are generally independant of peergroups.
ID	getPeerID()           Returns the peerID associated with this credential
Service	getSourceService()           Returns the service which generated this credential.
Object	getSubject()           Returns the subject of this credential. There is no straightforward mechansim for identifying the subject unfortunately.
protected  boolean	handleElement(TextElement elem)           Process an individual element from the document.
protected  void	initialize(Element root)           Intialize from a portion of a structured document.
boolean	isExpired()           If true then the credential is expired. AuthenticationCredential are never expired.
boolean	isValid()           Returns true if this credential is currently valid. AuthenticationCredential are always valid, the Authenticator will determine the true validity from the included identity info.
protected  void	setMethod(String authenticationMethod)

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

AuthenticationCredential

public AuthenticationCredential(PeerGroup peergroup,
                                String method,
                                Element indentityInfo)

Creates new AuthenticationCredential

Parameters:

peergroup - The peergroup context in which this AuthenticationCredential is created.

method - The authentication method which will be requested when the AuthentiationCredential is provided to the peergroup Membership Service.

indentityInfo - Optional additional information about the identity being requested which is used by the authentication method. This information is passed to the authentication method during the apply operation of the Membership Service.

---

AuthenticationCredential

public AuthenticationCredential(PeerGroup peergroup,
                                Element root)

Creates new AuthenticationCredential

Parameters:

peergroup - The peergroup context in which this AuthenticationCredential is created.

root - the document containing the serialized representation of the AuthenticationCredential.

Method Detail

getPeerGroupID

public ID getPeerGroupID()

Returns the peerGroupID associated with this credential

AuthenticationCredentials are created in the context of a PeerGroup though they are generally independant of peergroups. The intent is that the AuthenticationCredential will be passed to the MembershipService service of the same peergroup as the AuthenticationCredenitals.

Specified by:

getPeerGroupID in interface Credential

Returns:

PeerGroupID associated with this AuthenticationCredential.

---

getPeerID

public ID getPeerID()

Returns the peerID associated with this credential

Specified by:

getPeerID in interface Credential

Returns:

the peerID associated with this credential

---

getSourceService

public Service getSourceService()

Returns the service which generated this credential.

Specified by:

getSourceService in interface Credential

Returns:

the service which generated this credential.

---

isExpired

public boolean isExpired()

If true then the credential is expired. Some credential implementations may never epxire.

AuthenticationCredential are never expired. The Authenticator will determine the true validity from the included identity info.

Specified by:

isExpired in interface Credential

---

isValid

public boolean isValid()

Returns true if this credential is currently valid.

AuthenticationCredential are always valid, the Authenticator will determine the true validity from the included identity info.

Specified by:

isValid in interface Credential

Returns:

boolean true if the credential is currently valid, otherwise false.

---

getSubject

public Object getSubject()

Returns the subject of this credential. The Objects returned must support Object.equals(Object) and Object.hashCode().

There is no straightforward mechansim for identifying the subject unfortunately.

Specified by:

getSubject in interface Credential

Returns:

the subject of the credential as an abstract object.

---

getDocument

public StructuredDocument getDocument(MimeMediaType as)
                               throws Exception

Write credential into a document. as is a mime media-type specification and provides the form of the document which is being requested. Two standard document forms are defined. "text/text" encodes the document in a form nice for printing out and "text/xml" which provides an XML format.

Specified by:

getDocument in interface Credential

Parameters:

as - The mime media type of the encoding format being requested.

Returns:

the StructuredDocument which represents this credential.

Throws:

Exception - When errors occur.

---

getMethod

public String getMethod()

Returns the authentication method which this AuthenticationCredential will be requesting when it is provided to a Membership Service during the "Apply" operation.

Returns:

String containing the authentication method being requested.

---

setMethod

protected void setMethod(String authenticationMethod)

---

getIdentityInfo

public Element getIdentityInfo()

Returns the StructuredDocument Element containing the identity information which was originally provided when this AuthenticationCredential was created.

Returns:

StructuredDocument Element containing the identity information which was originally provided when this AuthenticationCredential was created.

---

handleElement

protected boolean handleElement(TextElement elem)

Process an individual element from the document.

Parameters:

elem - the element to be processed.

Returns:

true if the element was recognized, otherwise false.

---

initialize

protected void initialize(Element root)

Intialize from a portion of a structured document.

---

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

---