Join MDN and developers like you at Mozilla's View Source conference, 12-14 September in Berlin, Germany. Learn more at https://viewsourceconf.org

nsIEffectiveTLDService

nsIEffectiveTLDServiceはホスト名を検証し、それがTLDであるように見えるもっとも長い部分を決定します。URIのベースドメインを決定する役割も持ちます。

Please add a summary to this article.
  最終更新: Gecko 1.9 (Firefox 3)

継承元: nsISupports

実装: @mozilla.org/network/effective-tld-service;1

このサービスを使うには:

var eTLDService = Components.classes["@mozilla.org/network/effective-tld-service;1"]
                                .getService(Components.interfaces.nsIEffectiveTLDService); 

メソッドの概要

ACString getPublicSuffix(in nsIURI aURI);
ACString getBaseDomain(in nsIURI aURI, [optional] in PRUint32 aAdditionalParts);
ACString getPublicSuffixFromHost(in AUTF8String aHost);
ACString getBaseDomainFromHost(in AUTF8String aHost, [optional] in PRUint32 aAdditionalParts);

メソッド

getPublicSuffix()

URIのパブリック接尾辞を返します。パブリック接尾辞はその下に個々のドメインが登録される最高位レベルのドメインです。パブリック接尾辞はひとつまたはそれ以上のドットを含みます。例えば、www.bbc.co.ukのパブリック接尾辞はco.ukになります、なぜならば.uk TLDはその下にドメインを登録することを許していないからです。その他の例として、developer.mozilla.orgではorgになります。

ACString getPublicSuffix(
  in nsIURI aURI
); 
引数
aURI
解析するURI

戻り値

パブリック接尾辞を含むACStringオブジェクト

例外
NS_ERROR_INVALID_ARG
この例外はaURIに含まれるホスト名が空であった場合に発生します。
NS_ERROR_HOST_IS_IP_ADDRESS
この例外はaURIが数値、IPv4アドレス、IPv6アドレスのいずれかであった場合に発生します。

getBaseDomain()

URIのベースドメインを返します。ベースドメインは、パブリック接尾辞に指定された数の追加ドメイン名を追加したものです。

ACString getBaseDomain(
  in nsIURI aURI
  [optional] in PRUint32 aAdditionalParts
); 
引数
aURI
解析するURI
aAdditionalParts
パブリック接尾辞に追加するドメイン名の数
戻り値

ベースドメインを含むACStringオブジェクト(パブリック接尾辞に、追加パート部分を足したもの)

例外
NS_ERROR_INVALID_ARG
この例外はaURIが空であった場合に発生します。
NS_ERROR_INSUFFICIENT_DOMAIN_LEVELS
この例外はaAdditionalPartsで指定された値に対してサブドメインが不足する場合に発生します。
NS_ERROR_HOST_IS_IP_ADDRESS
この例外はaURIが数値、IPv4アドレス、IPv6アドレスのいずれかであった場合に発生します。

getPublicSuffixFromHost()

ホスト文字列のパブリック接尾辞を返します。さもなくば機能的にはgetPublicSuffix()と同じです。

ACString getPublicSuffixFromHost(
  in AUTF8String aHost
); 
引数
aHost
解析されるホスト名
戻り値

パブリック接尾辞を含むACStringオブジェクト

例外
NS_ERROR_INVALID_ARG
この例外はaHostが空であった場合に発生します。
NS_ERROR_UNEXPECTED
この例外はaHostがURI中に含まれることを許可されない文字を含む場合にnsIIDNService内のNormalize()メソッドにより発生します。

getBaseDomainFromHost()

ホスト名のベースドメイン部分を返します。さもなくば機能的にはgetBaseDomain()と同じです。

ACString getBaseDomainFromHost(
  in AUTF8String aHost,
  [optional] in PRUint32 aAdditionalParts
); 
引数
aHost
解析されるホスト名
aAdditionalParts
パブリック接尾辞に追加するドメイン名の数
戻り値

ベースドメインを含むACStringオブジェクト(パブリック接尾辞に、追加パート部分を足したもの)

例外
NS_ERROR_INVALID_ARG
aHostが空であった場合に発生します。
NS_ERROR_UNEXPECTED
この例外はaHostがURI中に含まれることを許可されない文字を含む場合にnsIIDNService内のNormalize()メソッドにより発生します。
NS_ERROR_INSUFFICIENT_DOMAIN_LEVELS
この例外はaAdditionalPartsで指定された値に対してサブドメインが不足する場合に発生します。
NS_ERROR_HOST_IS_IP_ADDRESS
この例外はaHostが数値、IPv4アドレス、IPv6アドレスのいずれかであった場合に発生します。

言及

全ての戻り値はASCII/ACEでエンコーディングされ、RFC 3454に沿っています。

ドキュメントのタグと貢献者

 このページの貢献者: teoli, ethertank, tomotaka
 最終更新者: teoli,