| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Ldap.Client
Contents
- data Host
- data Ldap
- data LdapError
- = IOError IOError
- | ParseError ASN1Error
- | ResponseError ResponseError
- | DisconnectError Disconnect
- data ResponseError
- data ResultCode
- = Success
- | OperationError
- | ProtocolError
- | TimeLimitExceeded
- | SizeLimitExceeded
- | CompareFalse
- | CompareTrue
- | AuthMethodNotSupported
- | StrongerAuthRequired
- | Referral
- | AdminLimitExceeded
- | UnavailableCriticalExtension
- | ConfidentialityRequired
- | SaslBindInProgress
- | NoSuchAttribute
- | UndefinedAttributeType
- | InappropriateMatching
- | ConstraintViolation
- | AttributeOrValueExists
- | InvalidAttributeSyntax
- | NoSuchObject
- | AliasProblem
- | InvalidDNSyntax
- | AliasDereferencingProblem
- | InappropriateAuthentication
- | InvalidCredentials
- | InsufficientAccessRights
- | Busy
- | Unavailable
- | UnwillingToPerform
- | LoopDetect
- | NamingViolation
- | ObjectClassViolation
- | NotAllowedOnNonLeaf
- | NotAllowedOnRDN
- | EntryAlreadyExists
- | ObjectClassModsProhibited
- | AffectsMultipleDSAs
- | Other
- data Async a
- with :: Host -> PortNumber -> (Ldap -> IO a) -> IO (Either LdapError a)
- bind :: Ldap -> Dn -> Password -> IO ()
- search :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> IO [SearchEntry]
- data SearchEntry = SearchEntry Dn (AttrList [])
- data Search
- data Mod a
- scope :: Scope -> Mod Search
- data Scope
- size :: Int32 -> Mod Search
- time :: Int32 -> Mod Search
- typesOnly :: Bool -> Mod Search
- derefAliases :: DerefAliases -> Mod Search
- data Filter
- modify :: Ldap -> Dn -> [Operation] -> IO ()
- data Operation
- add :: Ldap -> Dn -> AttrList NonEmpty -> IO ()
- delete :: Ldap -> Dn -> IO ()
- modifyDn :: Ldap -> Dn -> RelativeDn -> Bool -> Maybe Dn -> IO ()
- compare :: Ldap -> Dn -> Attr -> AttrValue -> IO Bool
- extended :: Ldap -> Oid -> Maybe ByteString -> IO ()
- wait :: Async a -> IO (Either ResponseError a)
- newtype Dn = Dn Text
- newtype RelativeDn = RelativeDn Text
- newtype Oid = Oid Text
- newtype Password = Password ByteString
- type AttrList f = [(Attr, f AttrValue)]
- newtype Attr = Attr Text
- type AttrValue = ByteString
- data NonEmpty a :: * -> *
- data PortNumber :: *
Documentation
Constructors
| IOError IOError | |
| ParseError ASN1Error | |
| ResponseError ResponseError | |
| DisconnectError Disconnect |
data ResponseError Source
Constructors
| ResponseInvalid Request Response | |
| ResponseErrorCode Request ResultCode Dn Text |
data ResultCode Source
Constructors
Instances
with :: Host -> PortNumber -> (Ldap -> IO a) -> IO (Either LdapError a) Source
The entrypoint into LDAP.
Bind
bind :: Ldap -> Dn -> Password -> IO () Source
Perform the Bind operation synchronously. Raises ResponseError on failures.
Search
search :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> IO [SearchEntry] Source
Perform the Search operation synchronously. Raises ResponseError on failures.
Search modifiers
Constructors
| BaseObject | |
| SingleLevel | |
| WholeSubtree |
derefAliases :: DerefAliases -> Mod Search Source
Modify
modify :: Ldap -> Dn -> [Operation] -> IO () Source
Perform the Modify operation synchronously. Raises ResponseError on failures.
Type of modification being performed.
Constructors
| Delete Attr [AttrValue] | Delete values from the attribute. Deletes the attribute if the list is empty or all current values are listed. |
| Add Attr [AttrValue] | Add values to the attribute, creating it if necessary. |
| Replace Attr [AttrValue] | Replace all existing values of the attribute with the new list. Deletes the attribute if the list is empty. |
Add
add :: Ldap -> Dn -> AttrList NonEmpty -> IO () Source
Perform the Add operation synchronously. Raises ResponseError on failures.
Delete
delete :: Ldap -> Dn -> IO () Source
Perform the Delete operation synchronously. Raises ResponseError on failures.
ModifyDn
modifyDn :: Ldap -> Dn -> RelativeDn -> Bool -> Maybe Dn -> IO () Source
Perform the Modify DN operation synchronously. Raises ResponseError on failures.
Compare
compare :: Ldap -> Dn -> Attr -> AttrValue -> IO Bool Source
Perform the Compare operation synchronously. Raises ResponseError on failures.
Extended
extended :: Ldap -> Oid -> Maybe ByteString -> IO () Source
Perform the Extended operation synchronously. Raises ResponseError on failures.
Waiting for completion
Miscellanous
Constructors
| Password ByteString |
type AttrValue = ByteString Source
Re-exports
data NonEmpty a :: * -> *
Instances
| Monad NonEmpty | |
| Functor NonEmpty | |
| MonadFix NonEmpty | |
| Applicative NonEmpty | |
| Foldable NonEmpty | |
| Traversable NonEmpty | |
| Generic1 NonEmpty | |
| MonadZip NonEmpty | |
| IsList (NonEmpty a) | |
| Eq a => Eq (NonEmpty a) | |
| Data a => Data (NonEmpty a) | |
| Ord a => Ord (NonEmpty a) | |
| Read a => Read (NonEmpty a) | |
| Show a => Show (NonEmpty a) | |
| Generic (NonEmpty a) | |
| NFData a => NFData (NonEmpty a) | |
| Hashable a => Hashable (NonEmpty a) | |
| ToAsn1 a => ToAsn1 (NonEmpty a) | |
| Semigroup (NonEmpty a) | |
| type Rep1 NonEmpty = D1 D1NonEmpty (C1 C1_0NonEmpty ((:*:) (S1 NoSelector Par1) (S1 NoSelector (Rec1 [])))) | |
| type Rep (NonEmpty a) = D1 D1NonEmpty (C1 C1_0NonEmpty ((:*:) (S1 NoSelector (Rec0 a)) (S1 NoSelector (Rec0 [a])))) | |
| type Item (NonEmpty a) = a |
data PortNumber :: *