Ldap.Client.Internal

Documentation

data Host

LDAP host.

Constructors

Plain String

Plain LDAP.

Tls String TLSSettings

LDAP over TLS.

Instances

Show Host

Defined in Ldap.Client.Internal

Methods

showsPrec :: Int -> Host -> ShowS

show :: Host -> String

showList :: [Host] -> ShowS

data PortNumber

Port number. Use the Num instance (i.e. use a literal) to create a PortNumber value.

>>> 1 :: PortNumber
1
>>> read "1" :: PortNumber
1
>>> show (12345 :: PortNumber)
"12345"
>>> 50000 < (51000 :: PortNumber)
True
>>> 50000 < (52000 :: PortNumber)
True
>>> 50000 + (10000 :: PortNumber)
60000

Instances

Bounded PortNumber

Defined in Network.Socket.Types

Methods

minBound :: PortNumber

maxBound :: PortNumber

Enum PortNumber

Defined in Network.Socket.Types

Methods

succ :: PortNumber -> PortNumber

pred :: PortNumber -> PortNumber

toEnum :: Int -> PortNumber

fromEnum :: PortNumber -> Int

enumFrom :: PortNumber -> [PortNumber]

enumFromThen :: PortNumber -> PortNumber -> [PortNumber]

enumFromTo :: PortNumber -> PortNumber -> [PortNumber]

enumFromThenTo :: PortNumber -> PortNumber -> PortNumber -> [PortNumber]

Eq PortNumber

Defined in Network.Socket.Types

Methods

(==) :: PortNumber -> PortNumber -> Bool

(/=) :: PortNumber -> PortNumber -> Bool

Integral PortNumber

Defined in Network.Socket.Types

Methods

quot :: PortNumber -> PortNumber -> PortNumber

rem :: PortNumber -> PortNumber -> PortNumber

div :: PortNumber -> PortNumber -> PortNumber

mod :: PortNumber -> PortNumber -> PortNumber

quotRem :: PortNumber -> PortNumber -> (PortNumber, PortNumber)

divMod :: PortNumber -> PortNumber -> (PortNumber, PortNumber)

toInteger :: PortNumber -> Integer

Num PortNumber

Defined in Network.Socket.Types

Methods

(+) :: PortNumber -> PortNumber -> PortNumber

(-) :: PortNumber -> PortNumber -> PortNumber

(*) :: PortNumber -> PortNumber -> PortNumber

negate :: PortNumber -> PortNumber

abs :: PortNumber -> PortNumber

signum :: PortNumber -> PortNumber

fromInteger :: Integer -> PortNumber

Ord PortNumber

Defined in Network.Socket.Types

Methods

compare :: PortNumber -> PortNumber -> Ordering

(<) :: PortNumber -> PortNumber -> Bool

(<=) :: PortNumber -> PortNumber -> Bool

(>) :: PortNumber -> PortNumber -> Bool

(>=) :: PortNumber -> PortNumber -> Bool

max :: PortNumber -> PortNumber -> PortNumber

min :: PortNumber -> PortNumber -> PortNumber

Read PortNumber

Defined in Network.Socket.Types

Methods

readsPrec :: Int -> ReadS PortNumber

readList :: ReadS [PortNumber]

readPrec :: ReadPrec PortNumber

readListPrec :: ReadPrec [PortNumber]

Real PortNumber

Defined in Network.Socket.Types

Methods

toRational :: PortNumber -> Rational

Show PortNumber

Defined in Network.Socket.Types

Methods

showsPrec :: Int -> PortNumber -> ShowS

show :: PortNumber -> String

showList :: [PortNumber] -> ShowS

Storable PortNumber

Defined in Network.Socket.Types

Methods

sizeOf :: PortNumber -> Int

alignment :: PortNumber -> Int

peekElemOff :: Ptr PortNumber -> Int -> IO PortNumber

pokeElemOff :: Ptr PortNumber -> Int -> PortNumber -> IO ()

peekByteOff :: Ptr b -> Int -> IO PortNumber

pokeByteOff :: Ptr b -> Int -> PortNumber -> IO ()

peek :: Ptr PortNumber -> IO PortNumber

poke :: Ptr PortNumber -> PortNumber -> IO ()

data Ldap

An LDAP connection handle

Constructors

Ldap

Fields

• reqQ :: !(TQueue ClientMessage)

  Request queue for client messages to be send.

• workers :: !(Async Void)

  Workers group for communicating with the server.

• conn :: !Connection

  Network connection to the server.

data ClientMessage

Constructors

New !Request !(TMVar (NonEmpty ProtocolServerOp))

data ResultCode

LDAP operation's result.

Constructors

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

Instances

Eq ResultCode

Defined in Ldap.Asn1.Type

Methods

(==) :: ResultCode -> ResultCode -> Bool

(/=) :: ResultCode -> ResultCode -> Bool

Show ResultCode

Defined in Ldap.Asn1.Type

Methods

showsPrec :: Int -> ResultCode -> ShowS

show :: ResultCode -> String

showList :: [ResultCode] -> ShowS

data Async a

Asynchronous LDAP operation. Use wait or waitSTM to wait for its completion.

Instances

Functor Async

Defined in Ldap.Client.Internal

Methods

fmap :: (a -> b) -> Async a -> Async b

(<$) :: a -> Async b -> Async a

type AttrList f = [(Attr, f AttrValue)]

List of attributes and their values. f is the structure these values are in, e.g. NonEmpty.

Waiting for Request Completion

wait :: Async a -> IO (Either ResponseError a)

Wait for operation completion.

waitSTM :: Async a -> STM (Either ResponseError a)

Wait for operation completion inside STM.

Do not use this inside the same STM transaction the operation was requested in! To give LDAP the chance to respond to it that transaction should commit. After that, applying waitSTM to the corresponding Async starts to make sense.

Misc

type Response = NonEmpty InMessage

data ResponseError

Response indicates a failed operation.

Constructors

ResponseInvalid !Request !Response

LDAP server did not follow the protocol, so ldap-client couldn't make sense of the response.

ResponseErrorCode !Request !ResultCode !Dn !Text

The response contains a result code indicating failure and an error message.

Instances

Eq ResponseError

Defined in Ldap.Client.Internal

Methods

(==) :: ResponseError -> ResponseError -> Bool

(/=) :: ResponseError -> ResponseError -> Bool

Show ResponseError

Defined in Ldap.Client.Internal

Methods

showsPrec :: Int -> ResponseError -> ShowS

show :: ResponseError -> String

showList :: [ResponseError] -> ShowS

Exception ResponseError

Defined in Ldap.Client.Internal

Methods

toException :: ResponseError -> SomeException

fromException :: SomeException -> Maybe ResponseError

displayException :: ResponseError -> String

type Request = ProtocolClientOp

eitherToIO :: Exception e => Either e a -> IO a

sendRequest :: Ldap -> (Response -> Either ResponseError a) -> Request -> STM (Async a)

newtype Dn

Unique identifier of an LDAP entry.

Constructors

Dn Text

Instances

Eq Dn

Defined in Ldap.Client.Internal

Methods

(==) :: Dn -> Dn -> Bool

(/=) :: Dn -> Dn -> Bool

Show Dn

Defined in Ldap.Client.Internal

Methods

showsPrec :: Int -> Dn -> ShowS

show :: Dn -> String

showList :: [Dn] -> ShowS

newtype Attr

Attribute name.

Constructors

Attr Text

Instances

Eq Attr

Defined in Ldap.Client.Internal

Methods

(==) :: Attr -> Attr -> Bool

(/=) :: Attr -> Attr -> Bool

Show Attr

Defined in Ldap.Client.Internal

Methods

showsPrec :: Int -> Attr -> ShowS

show :: Attr -> String

showList :: [Attr] -> ShowS

type AttrValue = ByteString

Attribute value.

unAttr :: Attr -> Text

Unbind operation

unbindAsync :: Ldap -> IO ()

Terminate the connection to the Directory.

Note that unbindAsync does not return an Async, because LDAP server never responds to UnbindRequests, hence a call to wait on a hypothetical Async would have resulted in an exception anyway.

unbindAsyncSTM :: Ldap -> STM ()

Terminate the connection to the Directory.

Note that unbindAsyncSTM does not return an Async, because LDAP server never responds to UnbindRequests, hence a call to wait on a hypothetical Async would have resulted in an exception anyway.