Class/Object

spinoco.protocol.ldap

SearchRequest

Related Docs: object SearchRequest | package ldap

Permalink

case class SearchRequest(baseObject: LdapDN, scope: SearchRequest.SearchScope.Value, deferAliases: SearchRequest.Aliases.Value, sizeLimit: Int, timeLimit: Int, typesOnly: Boolean, filter: Filter, attributes: Vector[AttributeSelector]) extends ProtocolOp with Product with Serializable

Request to perform a LDAP search.

baseObject

The name of the base object entry.

scope

The scope of the search.

deferAliases

An indicator as to whether or not alias entries are to be dereferenced during stages of the Search operation.

sizeLimit

The number of entries to be returned

timeLimit

The time limit for the search in seconds

typesOnly

Whether the result should include only the attribute descriptions (false) or if we want to return the values to the descriptions as well (true).

filter

A filter that defines the conditions that must be fulfilled in order for the search to be matched.

attributes

A selection of attributes to be returned for search entries that match this search.

Source
SearchRequest.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, ProtocolOp, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchRequest
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ProtocolOp
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SearchRequest(baseObject: LdapDN, scope: SearchRequest.SearchScope.Value, deferAliases: SearchRequest.Aliases.Value, sizeLimit: Int, timeLimit: Int, typesOnly: Boolean, filter: Filter, attributes: Vector[AttributeSelector])

    Permalink

    baseObject

    The name of the base object entry.

    scope

    The scope of the search.

    deferAliases

    An indicator as to whether or not alias entries are to be dereferenced during stages of the Search operation.

    sizeLimit

    The number of entries to be returned

    timeLimit

    The time limit for the search in seconds

    typesOnly

    Whether the result should include only the attribute descriptions (false) or if we want to return the values to the descriptions as well (true).

    filter

    A filter that defines the conditions that must be fulfilled in order for the search to be matched.

    attributes

    A selection of attributes to be returned for search entries that match this search.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SearchRequest to any2stringadd[SearchRequest] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (SearchRequest, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SearchRequest to ArrowAssoc[SearchRequest] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. val attributes: Vector[AttributeSelector]

    Permalink

    A selection of attributes to be returned for search entries that match this search.

  8. val baseObject: LdapDN

    Permalink

    The name of the base object entry.

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. val deferAliases: SearchRequest.Aliases.Value

    Permalink

    An indicator as to whether or not alias entries are to be dereferenced during stages of the Search operation.

  11. def ensuring(cond: (SearchRequest) ⇒ Boolean, msg: ⇒ Any): SearchRequest

    Permalink
    Implicit information
    This member is added by an implicit conversion from SearchRequest to Ensuring[SearchRequest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: (SearchRequest) ⇒ Boolean): SearchRequest

    Permalink
    Implicit information
    This member is added by an implicit conversion from SearchRequest to Ensuring[SearchRequest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean, msg: ⇒ Any): SearchRequest

    Permalink
    Implicit information
    This member is added by an implicit conversion from SearchRequest to Ensuring[SearchRequest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean): SearchRequest

    Permalink
    Implicit information
    This member is added by an implicit conversion from SearchRequest to Ensuring[SearchRequest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. val filter: Filter

    Permalink

    A filter that defines the conditions that must be fulfilled in order for the search to be matched.

  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SearchRequest to StringFormat[SearchRequest] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. val scope: SearchRequest.SearchScope.Value

    Permalink

    The scope of the search.

  25. val sizeLimit: Int

    Permalink

    The number of entries to be returned

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  27. val timeLimit: Int

    Permalink

    The time limit for the search in seconds

  28. val typesOnly: Boolean

    Permalink

    Whether the result should include only the attribute descriptions (false) or if we want to return the values to the descriptions as well (true).

  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. def →[B](y: B): (SearchRequest, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SearchRequest to ArrowAssoc[SearchRequest] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ProtocolOp

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SearchRequest to any2stringadd[SearchRequest]

Inherited by implicit conversion StringFormat from SearchRequest to StringFormat[SearchRequest]

Inherited by implicit conversion Ensuring from SearchRequest to Ensuring[SearchRequest]

Inherited by implicit conversion ArrowAssoc from SearchRequest to ArrowAssoc[SearchRequest]

Ungrouped