Liking cljdoc? Tell your friends :D

javax.naming.directory.InitialDirContext

This class is the starting context for performing directory operations. The documentation in the class description of InitialContext (including those for synchronization) apply here.

This class is the starting context for performing
directory operations. The documentation in the class description
of InitialContext (including those for synchronization) apply here.
raw docstring

->initial-dir-contextclj

(->initial-dir-context)
(->initial-dir-context environment)

Constructor.

Constructs an initial DirContext using the supplied environment. Environment properties are discussed in the javax.naming.InitialContext class description.

This constructor will not modify environment or save a reference to it, but may save a clone. Caller should not modify mutable keys and values in environment after it has been passed to the constructor.

environment - environment used to create the initial DirContext. Null indicates an empty environment. - java.util.Hashtable

throws: javax.naming.NamingException - if a naming exception is encountered

Constructor.

Constructs an initial DirContext using the supplied environment.
 Environment properties are discussed in the
 javax.naming.InitialContext class description.

  This constructor will not modify environment
 or save a reference to it, but may save a clone.
 Caller should not modify mutable keys and values in
 environment after it has been passed to the constructor.

environment - environment used to create the initial DirContext. Null indicates an empty environment. - `java.util.Hashtable`

throws: javax.naming.NamingException - if a naming exception is encountered
raw docstring

bindclj

(bind this name obj attrs)

Description copied from interface: DirContext

name - the name to bind; may not be empty - java.lang.String obj - the object to bind; possibly null - java.lang.Object attrs - the attributes to associate with the binding - javax.naming.directory.Attributes

throws: javax.naming.NameAlreadyBoundException - if name is already bound

Description copied from interface: DirContext

name - the name to bind; may not be empty - `java.lang.String`
obj - the object to bind; possibly null - `java.lang.Object`
attrs - the attributes to associate with the binding - `javax.naming.directory.Attributes`

throws: javax.naming.NameAlreadyBoundException - if name is already bound
raw docstring

create-subcontextclj

(create-subcontext this name attrs)

Description copied from interface: DirContext

name - the name of the context to create; may not be empty - java.lang.String attrs - the attributes to associate with the newly created context - javax.naming.directory.Attributes

returns: the newly created context - javax.naming.directory.DirContext

throws: javax.naming.NameAlreadyBoundException - if the name is already bound

Description copied from interface: DirContext

name - the name of the context to create; may not be empty - `java.lang.String`
attrs - the attributes to associate with the newly created context - `javax.naming.directory.Attributes`

returns: the newly created context - `javax.naming.directory.DirContext`

throws: javax.naming.NameAlreadyBoundException - if the name is already bound
raw docstring

get-attributesclj

(get-attributes this name)
(get-attributes this name attr-ids)

Description copied from interface: DirContext

name - The name of the object from which to retrieve attributes - java.lang.String attr-ids - the identifiers of the attributes to retrieve. null indicates that all attributes should be retrieved; an empty array indicates that none should be retrieved. - java.lang.String[]

returns: the requested attributes; never null - javax.naming.directory.Attributes

throws: javax.naming.NamingException - if a naming exception is encountered

Description copied from interface: DirContext

name - The name of the object from which to retrieve attributes - `java.lang.String`
attr-ids - the identifiers of the attributes to retrieve. null indicates that all attributes should be retrieved; an empty array indicates that none should be retrieved. - `java.lang.String[]`

returns: the requested attributes; never null - `javax.naming.directory.Attributes`

throws: javax.naming.NamingException - if a naming exception is encountered
raw docstring

get-schemaclj

(get-schema this name)

Description copied from interface: DirContext

name - the name of the object whose schema is to be retrieved - java.lang.String

returns: the schema associated with the context; never null - javax.naming.directory.DirContext

throws: javax.naming.OperationNotSupportedException - if schema not supported

Description copied from interface: DirContext

name - the name of the object whose schema is to be retrieved - `java.lang.String`

returns: the schema associated with the context; never null - `javax.naming.directory.DirContext`

throws: javax.naming.OperationNotSupportedException - if schema not supported
raw docstring

get-schema-class-definitionclj

(get-schema-class-definition this name)

Description copied from interface: DirContext

name - the name of the object whose object class definition is to be retrieved - java.lang.String

returns: the DirContext containing the named object's class definitions; never null - javax.naming.directory.DirContext

throws: javax.naming.OperationNotSupportedException - if schema not supported

Description copied from interface: DirContext

name - the name of the object whose object class definition is to be retrieved - `java.lang.String`

returns: the DirContext containing the named
          object's class definitions; never null - `javax.naming.directory.DirContext`

throws: javax.naming.OperationNotSupportedException - if schema not supported
raw docstring

modify-attributesclj

(modify-attributes this name mods)
(modify-attributes this name mod-op attrs)

Description copied from interface: DirContext

name - the name of the object whose attributes will be updated - java.lang.String mod-op - the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE. - int attrs - the attributes to be used for the modification; may not be null - javax.naming.directory.Attributes

throws: javax.naming.directory.AttributeModificationException - if the modification cannot be completed successfully

Description copied from interface: DirContext

name - the name of the object whose attributes will be updated - `java.lang.String`
mod-op - the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE. - `int`
attrs - the attributes to be used for the modification; may not be null - `javax.naming.directory.Attributes`

throws: javax.naming.directory.AttributeModificationException - if the modification cannot be completed successfully
raw docstring

rebindclj

(rebind this name obj attrs)

Description copied from interface: DirContext

name - the name to bind; may not be empty - java.lang.String obj - the object to bind; possibly null - java.lang.Object attrs - the attributes to associate with the binding - javax.naming.directory.Attributes

throws: javax.naming.directory.InvalidAttributesException - if some "mandatory" attributes of the binding are not supplied

Description copied from interface: DirContext

name - the name to bind; may not be empty - `java.lang.String`
obj - the object to bind; possibly null - `java.lang.Object`
attrs - the attributes to associate with the binding - `javax.naming.directory.Attributes`

throws: javax.naming.directory.InvalidAttributesException - if some "mandatory" attributes of the binding are not supplied
raw docstring

(search this name matching-attributes)
(search this name matching-attributes attributes-to-return)
(search this name filter-expr filter-args cons)

Description copied from interface: DirContext

name - the name of the context or object to search - java.lang.String filter-expr - the filter expression to use for the search. The expression may contain variables of the form "{i}" where i is a nonnegative integer. May not be null. - java.lang.String filter-args - the array of arguments to substitute for the variables in filterExpr. The value of filterArgs[i] will replace each occurrence of "{i}". If null, equivalent to an empty array. - java.lang.Object[] cons - the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())). - javax.naming.directory.SearchControls

returns: an enumeration of SearchResults of the objects that satisfy the filter; never null - javax.naming.NamingEnumeration<javax.naming.directory.SearchResult>

throws: javax.naming.directory.InvalidSearchControlsException - if cons contains invalid settings

Description copied from interface: DirContext

name - the name of the context or object to search - `java.lang.String`
filter-expr - the filter expression to use for the search. The expression may contain variables of the form "{i}" where i is a nonnegative integer. May not be null. - `java.lang.String`
filter-args - the array of arguments to substitute for the variables in filterExpr. The value of filterArgs[i] will replace each occurrence of "{i}". If null, equivalent to an empty array. - `java.lang.Object[]`
cons - the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())). - `javax.naming.directory.SearchControls`

returns: an enumeration of SearchResults of the objects
          that satisfy the filter; never null - `javax.naming.NamingEnumeration<javax.naming.directory.SearchResult>`

throws: javax.naming.directory.InvalidSearchControlsException - if cons contains invalid settings
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close