elements

Type Members

1. case class Attribute(tpe: AttributeDescription, vals: Set[AttributeValue]) extends Product with Serializable

   

   An attribute with its description and at least one value.

   An attribute with its description and at least one value.

   tpe

   The type of the attribute.

   vals

   The values for the given attribute type. This set of values have to have at least one value.

2. sealed trait AttributeDescription extends AnyRef

   

   The identification of an attribute.

3. sealed trait AttributeSelector extends AnyRef

   

   Selector for LDAP object's attributes.

4. case class AttributeValueAssertion(attributeDesc: AttributeDescription, assertionValue: AssertionValue) extends Product with Serializable

   

   Assertion of whether a given attribute matches the given value for said attribute.

   Assertion of whether a given attribute matches the given value for said attribute.

   attributeDesc

   The identification of the attribute.

   assertionValue

   The value of the attribute against which we are matching.

5. case class Control(controlType: LdapOID, criticality: Boolean, controlValue: Option[ByteVector]) extends Product with Serializable

   

   An extension argument for a protocolOp.

   An extension argument for a protocolOp. Mechanism in which way client and server can extend any protocolOp with additional values they understand.

   controlType

   An unique identification of this control.

   criticality

   Whether the request should fail if the server does not understand the control type.

   controlValue

   The value of the control, that should be decoded according the the correct type specified by controlType

6. sealed trait Filter extends AnyRef

   

   Filter for spinoco.protocol.ldap.SearchRequest *

7. case class LdapDN(names: Vector[RelativeDistinguishedName]) extends Product with Serializable

   

   Representation of distinguished name, defined in RFC 4514.

   Representation of distinguished name, defined in RFC 4514.

   names

   The vector of relative names. This vector can be empty, that denotes the root object.

8. case class LdapOID(oid: DottedDecimal) extends Product with Serializable

   

   The OID identification of an attribute.

   The OID identification of an attribute.

   oid

   The dotted decimal format of the object identifier.

9. case class LdapResult(resultCode: LdapResult.ResultCode.Value, matchedDN: LdapDN, diagnosticMessage: LDAPString, referral: Option[Vector[LDAPString]]) extends Product with Serializable

   

   The result of an LDAP request.

   The result of an LDAP request.

   resultCode

   The code for the result of the operation.

   matchedDN

   In most cases this field is to be empty except for cases specified in the: RFC 4511 section 4.1.9.

   diagnosticMessage

   Human readable message for the result. Non standardised, implementation has to be independent of this.

   referral

   The list of URIs that can be accessed via LDAP to fulfil the request. This field exists only in case the result code is set to spinoco.protocol.ldap.elements.LdapResult.ResultCode.referral.

10. case class MatchingRuleAssertion(matchingRule: Option[MatchingRuleId], tpe: Option[AttributeDescription], matchValue: AssertionValue, dnAttributes: Boolean) extends Product with Serializable

    

    Extension for filter matching.

    Extension for filter matching. Follows these rules:

    • If the matchingRule field is absent, the type field MUST be present, and an equality match is performed for that type.
    • If the type field is absent and the matchingRule is present, the matchValue is compared against all attributes in an entry that support that matchingRule.
    • If the type field is present and the matchingRule is present, the matchValue is compared against the specified attribute type and its subtypes.

    matchingRule

    The rule which is to be used for matching, if not present, then this is an equality match.

    tpe

    The entry against which the matching is done. If not specified, the match is done against all entries.

    matchValue

    The desired value for the matching.

    dnAttributes

    If set to true then the matching should be done against the DN attributes of the entry as well. And the matching is true only if there is at least one value in the DN that is true for this match.

11. case class PartialAttribute(tpe: AttributeDescription, vals: Set[AttributeValue]) extends Product with Serializable

    

    Same as Attribute but does not have to have any value provided to it.

    Same as Attribute but does not have to have any value provided to it.

    tpe

    The type of the attribute.

    vals

    The values for the given attribute type.

12. case class RelativeLdapDN(nameComponent: RelativeDistinguishedName) extends Product with Serializable

    

    Same as LdapDN but has exactly one RelativeDistinguishedName.

    Same as LdapDN but has exactly one RelativeDistinguishedName.

    nameComponent

    An unique identification of an entry.

13. case class SubStrings(initial: Option[Initial], any: Vector[Anywhere], last: Option[Final]) extends Product with Serializable

    

    A filter for a format of a given value.

    A filter for a format of a given value.

    initial

    The attribute value should start with this value.

    any

    These values should appear anywhere in the attribute value.

    last

    The attribute value should end with this value.