net.liftweb.ldap

SimpleLDAPVendor

object SimpleLDAPVendor extends LDAPVendor

A simple extension to LDAPVendor to provide configuration methods. The class, parameters* methods and variable are now deprecated in favor of the configure methods on LDAPVendor. See LDAPVendor for more details.

linear super types: LDAPVendor, SimpleInjector, Injector, Loggable, AnyRef, Any
    deprecated:
  1. Instantiate directly from LDAPVendor

    see also:
  1. LDAPVendor

Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. SimpleLDAPVendor
  2. LDAPVendor
  3. SimpleInjector
  4. Injector
  5. Loggable
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. class Inject [T] extends StackableMaker[T] with Vendor[T]

    Create an object or val that is a subclass of the FactoryMaker to generate factory for a particular class as well as define session and request specific vendors and use doWith to define the vendor just for the scope of the call.

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. val DEFAULT_AUTHTYPE : java.lang.String("simple")

    attributes: final
    definition classes: LDAPVendor
  9. val DEFAULT_BASE_DN : java.lang.String("")

    attributes: final
    definition classes: LDAPVendor
  10. val DEFAULT_FACTORY : java.lang.String("com.sun.jndi.ldap.LdapCtxFactory")

    attributes: final
    definition classes: LDAPVendor
  11. val DEFAULT_LOOKUP : net.liftweb.common.Empty.type

    attributes: final
    definition classes: LDAPVendor
  12. val DEFAULT_MAX_RETRIES : Int(6)

    attributes: final
    definition classes: LDAPVendor
  13. val DEFAULT_PASSWORD : java.lang.String("")

    attributes: final
    definition classes: LDAPVendor
  14. val DEFAULT_RETRY_INTERVAL : Int(5000)

    attributes: final
    definition classes: LDAPVendor
  15. val DEFAULT_URL : java.lang.String("ldap://localhost")

    attributes: final
    definition classes: LDAPVendor
  16. val DEFAULT_USER : java.lang.String("")

    attributes: final
    definition classes: LDAPVendor
  17. val KEY_AUTHTYPE : java.lang.String("ldap.authType")

    attributes: final
    definition classes: LDAPVendor
  18. val KEY_BASE_DN : java.lang.String("ldap.base")

    attributes: final
    definition classes: LDAPVendor
  19. val KEY_FACTORY : java.lang.String("ldap.initial_context_factory")

    attributes: final
    definition classes: LDAPVendor
  20. val KEY_LOOKUP : java.lang.String("lift-ldap.testLookup")

    attributes: final
    definition classes: LDAPVendor
  21. val KEY_MAX_RETRIES : java.lang.String("lift-ldap.maxRetries")

    attributes: final
    definition classes: LDAPVendor
  22. val KEY_PASSWORD : java.lang.String("ldap.password")

    attributes: final
    definition classes: LDAPVendor
  23. val KEY_RETRY_INTERVAL : java.lang.String("lift-ldap.retryInterval")

    attributes: final
    definition classes: LDAPVendor
  24. val KEY_URL : java.lang.String("ldap.url")

    attributes: final
    definition classes: LDAPVendor
  25. val KEY_USER : java.lang.String("ldap.userName")

    attributes: final
    definition classes: LDAPVendor
  26. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  27. def attributesFromDn (dn: String) : Attributes

    definition classes: LDAPVendor
  28. def bindUser (dn: String, password: String) : Boolean

    Attempts to authenticate the given DN against the configured LDAP provider.

    Attempts to authenticate the given DN against the configured LDAP provider.

    definition classes: LDAPVendor
  29. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  30. def configuration : Map[String, String]

    The configuration to use for connecting to the provider.

    The configuration to use for connecting to the provider. It should be set via the configure methods

    definition classes: LDAPVendor
  31. def configure (props: Map[String, String]) : Unit

    Configure from the given Map[String,String]

    Configure from the given Map[String,String]

    definition classes: LDAPVendor
  32. def configure (stream: InputStream) : Unit

    Configure from the given input stream.

    Configure from the given input stream. The stream is expected to be in a format parseable by java.util.Properties

    definition classes: LDAPVendor
  33. def configure (filename: String) : Unit

    Configure from the given file.

    Configure from the given file. The file is expected to be in a format parseable by java.util.Properties

    definition classes: LDAPVendor
  34. def configure () : Unit

    Configure straight from the Props object.

    Configure straight from the Props object. This allows you to use Lift's run modes for different LDAP configuration.

    definition classes: LDAPVendor
  35. def defaultSearchControls () : SearchControls

    The default SearchControls to use: search the base DN with a sub-tree scope, and return the "cn" attribute.

    The default SearchControls to use: search the base DN with a sub-tree scope, and return the "cn" attribute.

    definition classes: LDAPVendor
  36. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  37. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  38. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  39. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  40. def getInitialContext () : InitialLdapContext

    This method attempts to fetch the cached InitialLdapContext for the current thread.

    This method attempts to fetch the cached InitialLdapContext for the current thread. If there isn't a current context, open a new one. If a test DN is configured, the connection (cached or new) will be validated by performing a lookup on the test DN.

    attributes: protected
    definition classes: LDAPVendor
  41. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  42. def initialContext : InitialLdapContext

    Obtains a (possibly cached) InitialContext instance based on the currently set parameters.

    Obtains a (possibly cached) InitialContext instance based on the currently set parameters.

    definition classes: LDAPVendor
  43. implicit def inject [T] (implicit man: Manifest[T]) : Box[T]

    Perform the injection for the given type.

    Perform the injection for the given type. You can call: inject[Date] or inject[List[Map[String, PaymentThing]]]. The appropriate Manifest will be

    attributes: implicit
    definition classes: SimpleInjectorInjector
  44. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  45. val ldapAuthType : Inject[String]

    This controls the type of authentication to use.

    This controls the type of authentication to use.

    definition classes: LDAPVendor
  46. val ldapBaseDn : Inject[String]

    This controls the base DN used for searcheds

    This controls the base DN used for searcheds

    definition classes: LDAPVendor
  47. val ldapFactory : Inject[String]

    This controls the factory used to obtain an InitialContext

    This controls the factory used to obtain an InitialContext

    definition classes: LDAPVendor
  48. val ldapPassword : Inject[String]

    This controls the password used to bind for searches (not authentication)

    This controls the password used to bind for searches (not authentication)

    definition classes: LDAPVendor
  49. val ldapUrl : Inject[String]

    This controls the URL used to connect to the LDAP server

    This controls the URL used to connect to the LDAP server

    definition classes: LDAPVendor
  50. val ldapUser : Inject[String]

    This controls the username used to bind for searches (not authentication)

    This controls the username used to bind for searches (not authentication)

    definition classes: LDAPVendor
  51. val logger : Logger

    attributes: protected
    definition classes: Loggable
  52. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  53. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  54. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  55. def openInitialContext () : InitialLdapContext

    This method does the actual work of setting up the environment and constructing the InitialLdapContext.

    This method does the actual work of setting up the environment and constructing the InitialLdapContext.

    attributes: protected
    definition classes: LDAPVendor
  56. def parameters : () ⇒ Map[String, String]

    definition classes: LDAPVendor
      deprecated:
    1. Use the configure(...) methods

  57. def parametersFromFile (filename: String) : Map[String, String]

      deprecated:
    1. Use the configure(filename : String) method

  58. def parametersFromStream (stream: InputStream) : Map[String, String]

      deprecated:
    1. Use the configure(stream : InputStream method

  59. def parameters_= (newParams: () ⇒ Map[String, String]) : Unit

    definition classes: LDAPVendor
      deprecated:
    1. Use the configure(...) methods

  60. def processConfig (input: Map[String, String]) : Map[String, String]

    This method checks the configuration and sets defaults for any properties that are required.

    This method checks the configuration and sets defaults for any properties that are required. It also processes any of the optional configuration propertes related to context testing and retries.

    This method is intended to be called during update of the default configuration, not during granular override of the config.

    definition classes: LDAPVendor
  61. def propertiesToMap (props: Properties) : Map[String, String]

    attributes: protected
    definition classes: LDAPVendor
  62. def registerInjection [T] (f: () ⇒ T)(implicit man: Manifest[T]) : Unit

    Register a function that will inject for the given Manifest

    Register a function that will inject for the given Manifest

    definition classes: SimpleInjector
  63. val retryInterval : Inject[Long]

    This sets the interval between connection attempts on the InitialContext.

    This sets the interval between connection attempts on the InitialContext. The default is 5 seconds

    definition classes: LDAPVendor
  64. val retryMaxCount : Inject[Int]

    This sets the maximum number of connection attempts before giving up.

    This sets the maximum number of connection attempts before giving up. The default is 6

    definition classes: LDAPVendor
  65. def search (filter: String) : List[String]

    Searches the base DN for entities matching the given filter.

    Searches the base DN for entities matching the given filter.

    definition classes: LDAPVendor
  66. val searchControls : Inject[SearchControls]

    This sets the Directory SearchControls instance that is used to refine searches on the provider.

    This sets the Directory SearchControls instance that is used to refine searches on the provider.

    definition classes: LDAPVendor
  67. def setupFromBoot : Unit

      deprecated:
    1. Use the configure() method

  68. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  69. val testLookup : Inject[Box[String]]

    This can be set to test the InitialContext on each LDAP operation.

    This can be set to test the InitialContext on each LDAP operation. It should be set to a search DN.

    definition classes: LDAPVendor
  70. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  71. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  72. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  73. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from LDAPVendor

Inherited from SimpleInjector

Inherited from Injector

Inherited from Loggable

Inherited from AnyRef

Inherited from Any