org.openid4java.discovery.yadis

Class YadisResult

java.lang.Object

org.openid4java.discovery.yadis.YadisResult

public class YadisResult
extends Object

The results of Yadis discovery performed on a YadisURL, represented through a stripped-down XRDS model, containing only the those discovery information pieces that are relevant for OpenID.

The payload is represented by the XRDS document. Along with it other meta-information is contained, which can be useful while consuming the results of Yadis discoveries.

Author:

Marius Scurtescu, Johnny Bufu

Constructor Summary

Constructors

Constructor and Description
YadisResult()

Method Summary

Methods

Modifier and Type	Method and Description
String	dump()
String	getContentType() Gets the content-type of the response from which the XRDS was extracted.
List	getDiscoveredInformation(Set targetTypes)
int	getEndpointCount()
List	getEndpoints() Gets the OpenID XRDS endpoints discovered from an identifier.
Throwable	getFailureCause() Gets the throwable (or exception) that caused the failure of the Yadis discovery, if one was thrown and intercepted
String	getNormalizedUrl() Gets the result of following redirects on the YadisURL
URL	getXrdsLocation() Gets the Yadis Resource Descriptor (XRDS) location
YadisUrl	getYadisUrl() Gets the YadisUrl on which discovery is to be performed.
boolean	hasEndpoints()
void	setContentType(String type) Sets the content-type of the response from which the XRDS was extracted.
void	setEndpoints(List endpoints) Sets the OpenID XRDS endpoints discovered from an identifier.
void	setFailureCause(Throwable e) Sets the throwable or exception that caused the failure of the Yadis discovery, if one was thrown and intercepted
void	setNormalizedUrl(String _normalizedUrl) Sets the result of following redirects on the YadisURL
void	setXrdsLocation(String xrdsLocation, int onFailError) Sets the Yadis Resource Descriptor (XRDS) location found during discovery.
void	setYadisUrl(YadisUrl url) Sets the YadisURL on which discovery will be performed.

Methods inherited from class java.lang.Object

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

Constructor Detail

YadisResult

public YadisResult()

Method Detail

setYadisUrl

public void setYadisUrl(YadisUrl url)

Sets the YadisURL on which discovery will be performed.

getYadisUrl

public YadisUrl getYadisUrl()

Gets the YadisUrl on which discovery is to be performed.

setXrdsLocation

public void setXrdsLocation(String xrdsLocation,
                   int onFailError)
                     throws YadisException

Sets the Yadis Resource Descriptor (XRDS) location found during discovery.

The XRDS location can be the same as the YadisUrl, or different if redirects are followed during discovery, or if delegation is used.

Parameters:

xrdsLocation - The Resource Descriptor URL from where the XRDS is downloaded

onFailError - The error code which will be set in the result if the XRDS location is not valid

Throws:

YadisException

getXrdsLocation

public URL getXrdsLocation()

Gets the Yadis Resource Descriptor (XRDS) location

setEndpoints

public void setEndpoints(List endpoints)

Sets the OpenID XRDS endpoints discovered from an identifier.

getEndpoints

public List getEndpoints()

Gets the OpenID XRDS endpoints discovered from an identifier.

getEndpointCount

public int getEndpointCount()

getDiscoveredInformation

public List getDiscoveredInformation(Set targetTypes)
                              throws DiscoveryException

Throws:

DiscoveryException

hasEndpoints

public boolean hasEndpoints()

Returns:

true if the YadisResult has at least one XRDS endpoint, false otherwise.

getNormalizedUrl

public String getNormalizedUrl()

Gets the result of following redirects on the YadisURL

setNormalizedUrl

public void setNormalizedUrl(String _normalizedUrl)

Sets the result of following redirects on the YadisURL

setContentType

public void setContentType(String type)

Sets the content-type of the response from which the XRDS was extracted.

Parameters:

type - The content-type of the HTTP response that contained the XRDS document

getContentType

public String getContentType()

Gets the content-type of the response from which the XRDS was extracted.

Returns:

The content-type of the HTTP response that contained the XRDS document

setFailureCause

public void setFailureCause(Throwable e)

Sets the throwable or exception that caused the failure of the Yadis discovery, if one was thrown and intercepted

getFailureCause

public Throwable getFailureCause()

Gets the throwable (or exception) that caused the failure of the Yadis discovery, if one was thrown and intercepted

dump

public String dump()