123456789_123456789_123456789_123456789_123456789_

Class: URI::LDAPS

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, LDAP, Generic
Instance Chain:
Inherits: URI::LDAP
Defined in: lib/uri/ldaps.rb

Overview

The default port for LDAPS URIs is 636, and the scheme is 'ldaps:' rather than 'ldap:'. Other than that, LDAPS URIs are identical to LDAP URIs; see LDAP.

Constant Summary

::URI - Included

DEFAULT_PARSER, HTML5ASCIIINCOMPAT, Parser, REGEXP, RFC3986_PARSER, TBLDECWWWCOMP_, TBLENCWWWCOMP_, VERSION, VERSION_CODE, WEB_ENCODINGS_

Generic - Inherited

COMPONENT, DEFAULT_PORT, USE_REGISTRY

LDAP - Inherited

COMPONENT, DEFAULT_PORT, SCOPE

Class Method Summary

LDAP - Inherited

.build

Description.

.new

Description.

Generic - Inherited

.build

Synopsis.

.build2

Synopsis.

.component

Components of the ::URI in the order.

.default_port

Returns default port.

.new

Args.

.use_proxy?, .use_registry

Instance Attribute Summary

LDAP - Inherited

#attributes

returns attributes.

#attributes=

setter for attributes val

#dn

returns dn.

#dn=

setter for dn val

#extensions

returns extensions.

#extensions=

setter for extensions val

#filter

returns filter.

#filter=

setter for filter val

#hierarchical?

Checks if ::URI has a path For LDAP this will return false

#scope

returns scope.

#scope=

setter for scope val

Generic - Inherited

#absolute
#fragment

returns the fragment component of the ::URI.

#fragment=

check the fragment v component against the Parser Regexp for :FRAGMENT.

#hierarchical?

Checks if ::URI has a path.

#host

returns the host component of the ::URI.

#host=

Args.

#hostname

extract the host part of the ::URI and unwrap brackets for IPv6 addresses.

#hostname=

set the host part of the ::URI as the argument with brackets for IPv6 addresses.

#opaque

returns the opaque part of the ::URI.

#opaque=

Args.

#password

returns the password component.

#password=

Args.

#path

returns the path component of the ::URI.

#path=

Args.

#port

returns the port component of the ::URI.

#port=

Args.

#query

returns the query component of the ::URI.

#query=

Args.

#registry=,
#relative?

Checks if ::URI is relative.

#scheme

returns the scheme component of the ::URI.

#scheme=

Args.

#user

returns the user component.

#user=

Args.

#userinfo

returns the userinfo, either as 'user' or 'user:password'.

#userinfo=

Sets userinfo, argument is string like 'name:pass'.

#registry

Instance Method Summary

LDAP - Inherited

#set_attributes

private setter for attributes val

#set_dn

private setter for dn val

#set_extensions

private setter for extensions val

#set_filter

private setter for filter val

#set_scope

private setter for scope val

#build_path_query

private method to assemble query from attributes, scope, filter and extensions.

#parse_dn

private method to cleanup dn from using the path component attribute.

#parse_query

private method to cleanup attributes, scope, filter and extensions, from using the query component attribute.

Generic - Inherited

#+

Alias for Generic#merge.

#-
#==

Compares two URIs.

#absolute?

Checks if ::URI is an absolute one.

#coerce

Args.

#component

Components of the ::URI in the order.

#default_port

Returns default port.

#eql?,
#find_proxy

returns a proxy ::URI.

#hash, #inspect,
#merge

Args.

#merge!

Args.

#normalize

Returns normalized ::URI.

#normalize!

Destructive version of #normalize

#parser

returns the parser to be used.

#route_from

Args.

#route_to

Args.

#select

Args.

#to_s

Constructs String from ::URI.

#component_ary

returns an Array of the components defined from the COMPONENT Array.

#set_host

protected setter for the host component v

#set_opaque

protected setter for the opaque component v

#set_password

protected setter for the password component v

#set_path

protected setter for the path component v

#set_port

protected setter for the port component v

#set_scheme

protected setter for the scheme component v

#set_user

protected setter for the user component v

#set_userinfo

protect setter for the user component, and password if available.

#check_host

check the host v component for RFC2396 compliance and against the Parser Regexp for :HOST.

#check_opaque

check the opaque v component for RFC2396 compliance and against the Parser Regexp for :OPAQUE.

#check_password

check the password v component for RFC2396 compliance and against the Parser Regexp for :USERINFO.

#check_path

check the path v component for RFC2396 compliance and against the Parser Regexp for :ABS_PATH and :REL_PATH.

#check_port

check the port v component for RFC2396 compliance and against the Parser Regexp for :PORT.

#check_scheme

check the scheme v component against the Parser Regexp for :SCHEME.

#check_user

check the user v component for RFC2396 compliance and against the Parser Regexp for :USERINFO.

#check_userinfo

check the user and password.

#escape_userpass

escapes 'user:password' v based on RFC 1738 section 3.1.

#merge_path

Merges a base path base, with relative path rel, returns a modified base path.

#replace!

replace self by other ::URI object.

#route_from0,
#split_path

returns an Array of the path split on '/'.

#split_userinfo

returns the userinfo ui as user, password if properly formatted as 'user:password'.

#set_registry, #check_registry, #route_from_path

Constructor Details

This class inherits a constructor from URI::LDAP