Safe Haskell	None
Language	Haskell2010

Network.PlanB.Introspection.Internal.Types

Synopsis

type LazyByteString = ByteString
data TokenIntrospector m = TokenIntrospector {
- introspectToken :: ByteString -> m TokenInfo
}
data TokenInfo = TokenInfo {
- tokenInfoExpiresIn :: Int
- tokenInfoScope :: Set Text
- tokenInfoUid :: Text
- tokenInfoRealm :: Text
}
data BackendHttp m = BackendHttp {
- httpRequestExecute :: Request -> m (Response LazyByteString)
}
data BackendEnv m = BackendEnv {
- envLookup :: Text -> m (Maybe Text)
}
data Backend m = Backend {
- backendHttp :: BackendHttp m
- backendEnv :: BackendEnv m
}
data Conf m = Conf {
- confIntrospectionRequest :: Request
- confBackend :: Backend m
}
data ErrorResponse = ErrorResponse {
- errorResponseError :: Text
- errorResponseErrorDescription :: Maybe Text
}
data IntrospectionError

Documentation

type LazyByteString = ByteString Source #

data TokenIntrospector m Source #

A TokenIntrospector can be used for introspecting tokens.

Constructors

TokenIntrospector
Fields introspectToken :: ByteString -> m TokenInfo Introspect the provided token.

data TokenInfo Source #

Information returned on a successful token introspection.

Constructors

TokenInfo
Fields tokenInfoExpiresIn :: Int tokenInfoScope :: Set Text tokenInfoUid :: Text tokenInfoRealm :: Text

Instances

Show TokenInfo Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Methods showsPrec :: Int -> TokenInfo -> ShowS # show :: TokenInfo -> String # showList :: [TokenInfo] -> ShowS #
Generic TokenInfo Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Associated Types type Rep TokenInfo :: Type -> Type # Methods from :: TokenInfo -> Rep TokenInfo x # to :: Rep TokenInfo x -> TokenInfo #
ToJSON TokenInfo Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Methods toJSON :: TokenInfo -> Value # toEncoding :: TokenInfo -> Encoding # toJSONList :: [TokenInfo] -> Value # toEncodingList :: [TokenInfo] -> Encoding #
FromJSON TokenInfo Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Methods parseJSON :: Value -> Parser TokenInfo # parseJSONList :: Value -> Parser [TokenInfo] #
type Rep TokenInfo Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types type Rep TokenInfo = D1 (MetaData "TokenInfo" "Network.PlanB.Introspection.Internal.Types" "planb-token-introspection-0.1.4.0-BcrjmGCfBxW3UAbM4QCMBf" False) (C1 (MetaCons "TokenInfo" PrefixI True) ((S1 (MetaSel (Just "tokenInfoExpiresIn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "tokenInfoScope") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set Text))) :: (S1 (MetaSel (Just "tokenInfoUid") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "tokenInfoRealm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))

data BackendHttp m Source #

Constructors

BackendHttp
Fields httpRequestExecute :: Request -> m (Response LazyByteString)

data BackendEnv m Source #

Constructors

BackendEnv
Fields envLookup :: Text -> m (Maybe Text)

data Backend m Source #

Type for backends for the PlanB token introspector.

Constructors

Backend
Fields backendHttp :: BackendHttp m backendEnv :: BackendEnv m

data Conf m Source #

Constructors

Conf
Fields confIntrospectionRequest :: Request confBackend :: Backend m

data ErrorResponse Source #

Contains the error response data returned from a PlanB server in case of an introspection error.

Constructors

ErrorResponse
Fields errorResponseError :: Text errorResponseErrorDescription :: Maybe Text

Instances

Eq ErrorResponse Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Methods (==) :: ErrorResponse -> ErrorResponse -> Bool # (/=) :: ErrorResponse -> ErrorResponse -> Bool #
Show ErrorResponse Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Methods showsPrec :: Int -> ErrorResponse -> ShowS # show :: ErrorResponse -> String # showList :: [ErrorResponse] -> ShowS #
Generic ErrorResponse Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Associated Types type Rep ErrorResponse :: Type -> Type # Methods from :: ErrorResponse -> Rep ErrorResponse x # to :: Rep ErrorResponse x -> ErrorResponse #
ToJSON ErrorResponse Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Methods toJSON :: ErrorResponse -> Value # toEncoding :: ErrorResponse -> Encoding # toJSONList :: [ErrorResponse] -> Value # toEncodingList :: [ErrorResponse] -> Encoding #
FromJSON ErrorResponse Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Methods parseJSON :: Value -> Parser ErrorResponse # parseJSONList :: Value -> Parser [ErrorResponse] #
type Rep ErrorResponse Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types type Rep ErrorResponse = D1 (MetaData "ErrorResponse" "Network.PlanB.Introspection.Internal.Types" "planb-token-introspection-0.1.4.0-BcrjmGCfBxW3UAbM4QCMBf" False) (C1 (MetaCons "ErrorResponse" PrefixI True) (S1 (MetaSel (Just "errorResponseError") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "errorResponseErrorDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))

data IntrospectionError Source #

This type models the error scenarios specific to a token introspection attempt. These can be used as exceptions and are in fact thrown by a PlanB token introspector.

Constructors

DeserializationFailure Text ByteString
InvalidRequest ErrorResponse
InvalidToken ErrorResponse
Other ErrorResponse
NoEndpoint

Instances

Eq IntrospectionError Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Methods (==) :: IntrospectionError -> IntrospectionError -> Bool # (/=) :: IntrospectionError -> IntrospectionError -> Bool #
Show IntrospectionError Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Methods showsPrec :: Int -> IntrospectionError -> ShowS # show :: IntrospectionError -> String # showList :: [IntrospectionError] -> ShowS #
Generic IntrospectionError Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Associated Types type Rep IntrospectionError :: Type -> Type # Methods from :: IntrospectionError -> Rep IntrospectionError x # to :: Rep IntrospectionError x -> IntrospectionError #
Exception IntrospectionError Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types Methods toException :: IntrospectionError -> SomeException # fromException :: SomeException -> Maybe IntrospectionError # displayException :: IntrospectionError -> String #
type Rep IntrospectionError Source #
Instance details Defined in Network.PlanB.Introspection.Internal.Types type Rep IntrospectionError = D1 (MetaData "IntrospectionError" "Network.PlanB.Introspection.Internal.Types" "planb-token-introspection-0.1.4.0-BcrjmGCfBxW3UAbM4QCMBf" False) ((C1 (MetaCons "DeserializationFailure" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)) :+: C1 (MetaCons "InvalidRequest" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ErrorResponse))) :+: (C1 (MetaCons "InvalidToken" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ErrorResponse)) :+: (C1 (MetaCons "Other" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ErrorResponse)) :+: C1 (MetaCons "NoEndpoint" PrefixI False) (U1 :: Type -> Type))))