Tsukuyomi OpenID
0.2.0

jp.sourceforge.tsukuyomi.openid.yadis
クラス YadisResult

java.lang.Object
  上位を拡張 jp.sourceforge.tsukuyomi.openid.yadis.YadisResult

public class YadisResult
extends Object

The results of Yadis discovery performed on a YadisURL.

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.

作成者:
Marius Scurtescu, Johnny Bufu

フィールドの概要
static int GET_ERROR
           
static int GET_INVALID_RESPONSE
           
static int GET_NO_XRDS
           
static int GET_TRANSPORT_ERROR
           
static int HEAD_INVALID_RESPONSE
           
static int HEAD_TRANSPORT_ERROR
           
static int HTMLMETA_DOWNLOAD_ERROR
           
static int HTMLMETA_INVALID_RESPONSE
           
static int INVALID_SCHEME
           
static int INVALID_URL
           
static int OK
           
static int UNDISCOVERED
           
static int UNKNOWN_ERROR
           
static int XRDS_DOWNLOAD_ERROR
           
static int XRDS_PARSING_ERROR
           
static int XRDS_SIZE_EXCEEDED
           
 
コンストラクタの概要
YadisResult()
           
 
メソッドの概要
 String dump()
           
 String getContentType()
          Gets the content-type of the response from which the XRDS was extracted.
 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
 int getStatus()
          Gets the status code which indicates whether the Yadis discovery succeeded or failed.
 String getStatusMessage()
          Gets a status message giving more details about the status of the Yadis discovery.
 org.openxri.xml.XRDS getXrds()
          Gets the Yadis Resource Descriptor (XRDS) document.
 URL getXrdsLocation()
          Gets the Yadis Resource Descriptor (XRDS) location
 YadisUrl getYadisUrl()
          Gets the YadisUrl on which discovery is to be performed.
 void setContentType(String type)
          Sets the content-type of the response from which the XRDS was extracted.
 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 setStatus(int status)
          Sets the status code for the Yadis discovery, indicating whether it succeeded or failed.
 void setStatusMessage(String statusMessage)
          Sets a status message which gives more details about the status of the Yadis discovery.
 void setXrds(org.openxri.xml.XRDS xrds)
          Sets the Yadis Resource Descriptor (XRDS)
 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.
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

UNDISCOVERED

public static final int UNDISCOVERED
関連項目:
定数フィールド値

OK

public static final int OK
関連項目:
定数フィールド値

UNKNOWN_ERROR

public static final int UNKNOWN_ERROR
関連項目:
定数フィールド値

INVALID_URL

public static final int INVALID_URL
関連項目:
定数フィールド値

INVALID_SCHEME

public static final int INVALID_SCHEME
関連項目:
定数フィールド値

HEAD_TRANSPORT_ERROR

public static final int HEAD_TRANSPORT_ERROR
関連項目:
定数フィールド値

HEAD_INVALID_RESPONSE

public static final int HEAD_INVALID_RESPONSE
関連項目:
定数フィールド値

GET_ERROR

public static final int GET_ERROR
関連項目:
定数フィールド値

GET_TRANSPORT_ERROR

public static final int GET_TRANSPORT_ERROR
関連項目:
定数フィールド値

GET_INVALID_RESPONSE

public static final int GET_INVALID_RESPONSE
関連項目:
定数フィールド値

GET_NO_XRDS

public static final int GET_NO_XRDS
関連項目:
定数フィールド値

HTMLMETA_DOWNLOAD_ERROR

public static final int HTMLMETA_DOWNLOAD_ERROR
関連項目:
定数フィールド値

HTMLMETA_INVALID_RESPONSE

public static final int HTMLMETA_INVALID_RESPONSE
関連項目:
定数フィールド値

XRDS_DOWNLOAD_ERROR

public static final int XRDS_DOWNLOAD_ERROR
関連項目:
定数フィールド値

XRDS_PARSING_ERROR

public static final int XRDS_PARSING_ERROR
関連項目:
定数フィールド値

XRDS_SIZE_EXCEEDED

public static final int XRDS_SIZE_EXCEEDED
関連項目:
定数フィールド値
コンストラクタの詳細

YadisResult

public YadisResult()
メソッドの詳細

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.

パラメータ:
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
例外:
YadisException

getXrdsLocation

public URL getXrdsLocation()
Gets the Yadis Resource Descriptor (XRDS) location


setXrds

public void setXrds(org.openxri.xml.XRDS xrds)
Sets the Yadis Resource Descriptor (XRDS)

パラメータ:
xrds - The XRDS document associated with the YadisURL obtained through Yadis discovery

getXrds

public org.openxri.xml.XRDS getXrds()
Gets the Yadis Resource Descriptor (XRDS) document.

戻り値:
The XRDS document associated with the YadisURL obtained through Yadis discovery

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.

パラメータ:
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.

戻り値:
The content-type of the HTTP response that contained the XRDS document

getStatus

public int getStatus()
Gets the status code which indicates whether the Yadis discovery succeeded or failed.


setStatus

public void setStatus(int status)
Sets the status code for the Yadis discovery, indicating whether it succeeded or failed.


getStatusMessage

public String getStatusMessage()
Gets a status message giving more details about the status of the Yadis discovery.


setStatusMessage

public void setStatusMessage(String statusMessage)
Sets a status message which gives more details about the status of the Yadis discovery.


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()

Tsukuyomi OpenID
0.2.0

Copyright © 2008 Project Tsukuyomi. All Rights Reserved.