LdapClient.BindSpec

Enclosing interface:: LdapClient

public static interface LdapClient.BindSpec

The specifications for the LdapClient.bind(java.lang.String) request.

Method Summary

Modifier and Type

Method

Description

LdapClient.BindSpec

attributes(Attributes attributes)

The attributes to associate with this binding.

void

execute()

Bind the name, object, and attributes together

LdapClient.BindSpec

object(Object object)

The object to associate with this binding.

LdapClient.BindSpec

replaceExisting(boolean replaceExisting)

Replace any existing binding with this one (equivalent to "rebind").

Method Details
- object
  
  LdapClient.BindSpec object(Object object)
  
  The object to associate with this binding.
  Note that this object is encoded into a set of attributes. If the object is of type DirContext, then it will be converted into attributes via DirContext.getAttributes(javax.naming.Name).
  
  Parameters:
  
  object - the object to associate
  
  Returns:
  
  the LdapClient.BindSpec for further configuration
- attributes
  
  LdapClient.BindSpec attributes(Attributes attributes)
  
  The attributes to associate with this binding.
  
  Parameters:
  
  attributes - the attributes
  
  Returns:
  
  the LdapClient.BindSpec for further configuration
- replaceExisting
  
  LdapClient.BindSpec replaceExisting(boolean replaceExisting)
  
  Replace any existing binding with this one (equivalent to "rebind").
  If false, then bind will throw a NameAlreadyBoundException if the entry already exists.
  
  Parameters:
  
  replaceExisting - whether to replace any existing entry
  
  Returns:
  
  the LdapClient.BindSpec for further configuration
- execute
  
  void execute()
  
  Bind the name, object, and attributes together
  
  Throws:
  
  NameAlreadyBoundException - if name is already bound and replaceExisting(boolean) is false