ldap

Type Members

1. case class AbandonRequest(msgId: @@[Int, LdapMessage]) extends ProtocolOp with Product with Serializable

   

   Client requests a given message abandoned.

   Client requests a given message abandoned.

   The server as such may abandon the operation connected to the given message.

   Server MUST not send any additional data if the AbandonRequest is to as SearchRequest. That includes the SearchResultDone.

   msgId

   The id of the message that should have its progress cancelled.

2. case class AddRequest(entry: LdapDN, attributes: Vector[Attribute]) extends ProtocolOp with Product with Serializable

   

   Adds an entry with a given attributes.

   Adds an entry with a given attributes.

   entry

   The unique identifier of this entity.

   attributes

   The attributes this entity should take

3. case class AddResponse(response: LdapResult) extends ProtocolOp with Product with Serializable

   

   Response to the AddRequest *

4. type AssertionValue = ByteVector

   

5. type AttributeValue = ByteVector

   

6. case class BindRequest(version: Int, name: LdapDN, auth: AuthenticationChoice) extends ProtocolOp with Product with Serializable

   

   A request for authentication of the client to the server.

   A request for authentication of the client to the server.

   version

   The version of the protocol.

   name

   The name of the directory object the client wishes to bind as.

   auth

   The method of authentication against the server.

7. case class BindResponse(result: LdapResult, serverSaslCreds: Option[ByteVector]) extends ProtocolOp with Product with Serializable

   

   The result of a bind operation.

   The result of a bind operation.

   result

   The way bind resulted.

   serverSaslCreds

   If server side SASL authentication is required, this field contains data for it.

8. case class CompareRequest(entry: LdapDN, ava: AttributeValueAssertion) extends ProtocolOp with Product with Serializable

   

   A request to compare a given attribute of a given entry with the provided value.

   A request to compare a given attribute of a given entry with the provided value.

   entry

   The entry which is to be compared.

   ava

   The attribute that is to be compared

9. case class CompareResponse(response: LdapResult) extends ProtocolOp with Product with Serializable

   

   Response to the CompareRequest *

10. case class DelRequest(entry: LdapDN) extends ProtocolOp with Product with Serializable

    

    Request to delete a given entry.

    Request to delete a given entry.

    entry

    The entry to be deleted.

11. case class DelResponse(response: LdapResult) extends ProtocolOp with Product with Serializable

    

12. case class ExtendedRequest(requestName: LdapOID, requestValue: Option[ByteVector]) extends ProtocolOp with Product with Serializable

    

    Additional operations that are not already defined in protocol.

    Additional operations that are not already defined in protocol.

    requestName

    The id of the operation.

    requestValue

    The value of the request.

13. case class ExtendedResponse(response: LdapResult, responseName: Option[LdapOID], responseValue: Option[ByteVector]) extends ProtocolOp with Product with Serializable

    

    Response to ExtendedRequest

    Response to ExtendedRequest

    response

    The result of the request.

    responseName

    The name of the response to the request.

    responseValue

    The value of the response.

14. case class IntermediateResponse(responseName: Option[LdapOID], responseValue: Option[ByteVector]) extends ProtocolOp with Product with Serializable

    

    A mechanism for a response to a client before the request is completed.

    A mechanism for a response to a client before the request is completed.

    This is like SearchResultEntry but for requests other than SearchRequest

    responseName

    The name of the response.

    responseValue

    The value of the response.

15. type LDAPString = String

    

16. case class LdapMessage(messageId: Int, protocolOp: ProtocolOp, controls: Option[Vector[Control]]) extends Product with Serializable

    

    The base of all LDAP messages.

    The base of all LDAP messages.

    messageId

    The id of the message, this is only incremented by client.

    protocolOp

    The LDAP operation to be performed. This includes responses from server to client.

    controls

    The possible additional arguments for the protocol op.

17. type MatchingRuleId = String

    

18. case class ModifyDNRequest(entry: LdapDN, newRdn: RelativeLdapDN, deleteOldRdn: Boolean, newSuperior: Option[LdapDN]) extends ProtocolOp with Product with Serializable

    

    Request to modify the relativeDN of a given entry.

    Request to modify the relativeDN of a given entry. This also allows to more the entry and its whole sub tree to a new parent.

    entry

    The entry that is being modified.

    newRdn

    The new relativeDN of the entry that is to be set.

    deleteOldRdn

    Whether the old relativeDN of the entry should be deleted

    newSuperior

    The new root for this entry and its subtree.

19. case class ModifyDNResponse(response: LdapResult) extends ProtocolOp with Product with Serializable

    

    Response to ModifyDNRequest *

20. case class ModifyRequest(entry: LdapDN, changes: Vector[Change]) extends ProtocolOp with Product with Serializable

    

    A request to modify given entry with given changes.

    A request to modify given entry with given changes.

    entry

    The entry to be modified.

    changes

    The changes to be applied to the entry.

21. case class ModifyResponse(response: LdapResult) extends ProtocolOp with Product with Serializable

    

    Response to the ModifyRequest *

22. trait ProtocolOp extends AnyRef

    

23. 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.

    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.

24. case class SearchResultDone(result: LdapResult) extends ProtocolOp with Product with Serializable

    

    A search request is completed, no more entries to follow.

    A search request is completed, no more entries to follow.

    result

    The status how the request ended.

25. case class SearchResultEntry(objectName: LdapDN, attributes: PartialAttributeList) extends ProtocolOp with Product with Serializable

    

    A result of search.

    A result of search. Contains one resulting entry.

    objectName

    The identification for the object that represents this entry.

    attributes

    The attributes of this entry. These attributes do not have to have values, they may only contain descriptions of their attributes.

26. case class SearchResultReference(uris: Vector[LDAPString]) extends ProtocolOp with Product with Serializable

    

    A response to the SearchRequest, that tells the client the unexplored areas of the search.

    A response to the SearchRequest, that tells the client the unexplored areas of the search.

    uris

    The areas that are not yet explored, this should be URI.