Class: URI::LDAPS

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `LDAP`, `Generic`
Instance Chain: self, `LDAP`, `Generic`, `::URI`, `RFC2396_REGEXP`
Inherits:	URI::LDAP Object URI::Generic URI::LDAP URI::LDAPS
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

DEFAULT_PORT =

A Default port of 636 for LDAPS

# File 'lib/uri/ldaps.rb', line 18
```
636
```

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.
#scope	Returns scope.
#scope=	Setter for scope `val`.

`Generic` - Inherited

#absolute	Alias for Generic#absolute?.
#fragment	Returns the fragment component of the `::URI`.
#fragment=	Checks the fragment `v` component against the Parser Regexp for `:FRAGMENT`.
#hierarchical?	Returns true if `::URI` is hierarchical.
#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=	Sets 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 (without `::URI` decoding).
#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?	Returns true if `::URI` does not have a scheme (e.g.
#scheme	Returns the scheme component of the `::URI`.
#scheme=	Args.
#user	Returns the user component (without `::URI` decoding).
#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.
#-	Alias for Generic#route_from.
#==	Compares two URIs.
#absolute?	Returns true if `::URI` has a scheme (e.g.
#coerce	Args.
#component	Components of the `::URI` in the order.
#decoded_password	Returns the password component after `::URI` decoding.
#decoded_user	Returns the user component after `::URI` decoding.
#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`.
#to_str	Alias for Generic#to_s.
#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	Protected setter for the `user` component, and `password` if available (with validation).
#check_host	Checks the host `v` component for RFC2396 compliance and against the Parser Regexp for `:HOST`.
#check_opaque	Checks the opaque `v` component for RFC2396 compliance and against the Parser Regexp for `:OPAQUE`.
#check_password	Checks the password `v` component for RFC2396 compliance and against the Parser Regexp for `:USERINFO`.
#check_path	Checks the path `v` component for RFC2396 compliance and against the Parser Regexp for `:ABS_PATH` and `:REL_PATH`.
#check_port	Checks the port `v` component for RFC2396 compliance and against the Parser Regexp for `:PORT`.
#check_scheme	Checks the scheme `v` component against the Parser Regexp for `:SCHEME`.
#check_user	Checks the user `v` component for RFC2396 compliance and against the Parser Regexp for `:USERINFO`.
#check_userinfo	Checks 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!	Replaces 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

Class: URI::LDAPS

Overview

Constant Summary

::URI - Included

Generic - Inherited

LDAP - Inherited

Class Method Summary

LDAP - Inherited

Generic - Inherited

Instance Attribute Summary

LDAP - Inherited

Generic - Inherited

Instance Method Summary

LDAP - Inherited

Generic - Inherited

Constructor Details

`::URI` - Included

`Generic` - Inherited

`LDAP` - Inherited

`LDAP` - Inherited

`Generic` - Inherited

`LDAP` - Inherited

`Generic` - Inherited

`LDAP` - Inherited

`Generic` - Inherited