class URI::LDAP

[edit]

要約

LDAP URI を表すクラスです。[RFC2255] (Obsoleted by [RFC4510], [RFC4516])。 

ldap://<host>/<dn>[?<attrs>[?<scope>[?<filter>[?<extensions>]]]]

目次

特異メソッド
インスタンスメソッド

継承しているメソッド

URI::Genericから継承しているメソッド

特異メソッド

build(ary) -> URI::LDAP[permalink][rdoc][edit]
build(hash) -> URI::LDAP

引数で与えられた URI 構成要素から URI::LDAP オブジェクトを生成します。引数の正当性を検査します。

[PARAM] ary:
構成要素を表す配列を与えます。要素は次の順です。 
      [:host, :port, :dn, :attributes, :scope, :filter, :extensions]
[PARAM] hash:
構成要素を表すハッシュを与えます。ハッシュのキーは 
            :host, :port, :dn, :attributes, :scope, :filter, :extensions
のいずれかです。
[EXCEPTION] URI::InvalidComponentError:
各要素が適合しない場合に発生します。

例: 

require 'uri'
p URI::LDAP.build(["example.com", "1", "/a", "b", "c", "d", "e=f"]).to_s
#=> "ldap://example.com:1/a?b?c?d?e=f"
new(scheme, userinfo, host, port, registry, path, opaque, query, fragment, arg_check = false) -> URI::LDAP[permalink][rdoc][edit]

汎用的な構成要素から URI::LDAP オブジェクトを生成します。 build と異なり、デフォルトでは引数の正当性を検査しません。

[PARAM] scheme:
構成要素を表す文字列を与えます。
[PARAM] userinfo:
構成要素を表す文字列を与えます。
[PARAM] host:
構成要素を表す文字列を与えます。
[PARAM] port:
構成要素を表す文字列を与えます。
[PARAM] registry:
nil を与えます。
[PARAM] path:
構成要素を表す文字列を与えます。
[PARAM] opaque:
構成要素を表す文字列を与えます。
[PARAM] query:
構成要素を表す文字列を与えます。
[PARAM] fragment:
構成要素を表す文字列を与えます。
[PARAM] arg_check:
真が与えられた場合は、各引数が字句規則に適合しているか否かを検査します。適合しない場合は例外 URI::InvalidComponentError が起ります。
[EXCEPTION] URI::InvalidURIError:
use_registry が偽のとき、registry が与えられると発生します。
[EXCEPTION] URI::InvalidComponentError:
各要素が適合しない場合に発生します。

インスタンスメソッド

attributes -> String[permalink][rdoc][edit]

自身の Attribute を文字列で返します。

attributes=(s)[permalink][rdoc][edit]

自身の Attribute を文字列で設定します。

[PARAM] s:
自身の Attribute を文字列で設定します。
dn -> String[permalink][rdoc][edit]

自身の Distinguished Name を文字列で返します。

dn=(s)[permalink][rdoc][edit]

自身の Distinguished Name を文字列で設定します。

[PARAM] s:
自身の Distinguished Name を文字列で指定します。
extensions -> String[permalink][rdoc][edit]

自身の extensions を文字列で返します。

extensions=(s)[permalink][rdoc][edit]

自身の extensions を文字列で設定します。

[PARAM] s:
自身の extensions を文字列で設定します。
filter -> String[permalink][rdoc][edit]

自身の filter を文字列で返します。

filter=(s)[permalink][rdoc][edit]

自身の filter を文字列で設定します。

[PARAM] s:
自身の filter を文字列で設定します。
scope -> String[permalink][rdoc][edit]

自身の Scope を文字列で返します。

scope=(s)[permalink][rdoc][edit]

自身の Scope を文字列で設定します。

[PARAM] s:
自身の Scope を文字列で設定します。