Safe Haskell	None
Language	Haskell2010

Smith.Client.Config

Contents

Smith client runtime data.
Smith client input configuration.
OAuth2 scopes
High-level configuration operations.
Low-level configuration operations.
Configuration errors.

Description

Smith client configuration data and functions.

Synopsis

data Smith = Smith SmithEndpoint Manager Store
newtype SmithEndpoint = SmithEndpoint {
- getSmithEndpoint :: Text
}
data SmithCredentialsType
data SmithCredentials = SmithCredentials SmithCredentialsType IdentityId JWK
data SmithScope
- = ProfileScope
- | CAScope
configure :: IO (Either SmithConfigureError Smith)
configureWith :: [SmithScope] -> Manager -> IO (Either SmithConfigureError Smith)
configureT :: ExceptT SmithConfigureError IO Smith
configureWithT :: [SmithScope] -> Manager -> ExceptT SmithConfigureError IO Smith
configureEndpoint :: IO SmithEndpoint
configureOAuth2 :: Manager -> SmithEndpoint -> [Scope] -> JWK -> IdentityId -> IO Store
configureCredentials :: ExceptT SmithConfigureError IO SmithCredentials
configureCredentialsByteString :: SmithCredentialsType -> ByteString -> ExceptT SmithConfigureError IO SmithCredentials
configureCredentialsFile :: SmithCredentialsType -> FilePath -> ExceptT SmithConfigureError IO SmithCredentials
data SmithConfigureError
renderSmithConfigureError :: SmithConfigureError -> Text

Smith client runtime data.

data Smith Source #

Constructors

Smith SmithEndpoint Manager Store

Smith client input configuration.

newtype SmithEndpoint Source #

Constructors

SmithEndpoint
Fields getSmithEndpoint :: Text

Instances

Eq SmithEndpoint Source #
Instance details Defined in Smith.Client.Config Methods (==) :: SmithEndpoint -> SmithEndpoint -> Bool # (/=) :: SmithEndpoint -> SmithEndpoint -> Bool #
Ord SmithEndpoint Source #
Instance details Defined in Smith.Client.Config Methods compare :: SmithEndpoint -> SmithEndpoint -> Ordering # (<) :: SmithEndpoint -> SmithEndpoint -> Bool # (<=) :: SmithEndpoint -> SmithEndpoint -> Bool # (>) :: SmithEndpoint -> SmithEndpoint -> Bool # (>=) :: SmithEndpoint -> SmithEndpoint -> Bool # max :: SmithEndpoint -> SmithEndpoint -> SmithEndpoint # min :: SmithEndpoint -> SmithEndpoint -> SmithEndpoint #
Show SmithEndpoint Source #
Instance details Defined in Smith.Client.Config Methods showsPrec :: Int -> SmithEndpoint -> ShowS # show :: SmithEndpoint -> String # showList :: [SmithEndpoint] -> ShowS #

data SmithCredentialsType Source #

Constructors

EnvironmentCredentials
SmithHomeCredentials FilePath
HomeCredentials FilePath
SuppliedCredentials

Instances

Eq SmithCredentialsType Source #
Instance details Defined in Smith.Client.Config Methods (==) :: SmithCredentialsType -> SmithCredentialsType -> Bool # (/=) :: SmithCredentialsType -> SmithCredentialsType -> Bool #
Ord SmithCredentialsType Source #
Instance details Defined in Smith.Client.Config Methods compare :: SmithCredentialsType -> SmithCredentialsType -> Ordering # (<) :: SmithCredentialsType -> SmithCredentialsType -> Bool # (<=) :: SmithCredentialsType -> SmithCredentialsType -> Bool # (>) :: SmithCredentialsType -> SmithCredentialsType -> Bool # (>=) :: SmithCredentialsType -> SmithCredentialsType -> Bool # max :: SmithCredentialsType -> SmithCredentialsType -> SmithCredentialsType # min :: SmithCredentialsType -> SmithCredentialsType -> SmithCredentialsType #
Show SmithCredentialsType Source #
Instance details Defined in Smith.Client.Config Methods showsPrec :: Int -> SmithCredentialsType -> ShowS # show :: SmithCredentialsType -> String # showList :: [SmithCredentialsType] -> ShowS #

data SmithCredentials Source #

Constructors

SmithCredentials SmithCredentialsType IdentityId JWK

Instances

Eq SmithCredentials Source #
Instance details Defined in Smith.Client.Config Methods (==) :: SmithCredentials -> SmithCredentials -> Bool # (/=) :: SmithCredentials -> SmithCredentials -> Bool #
Show SmithCredentials Source #
Instance details Defined in Smith.Client.Config Methods showsPrec :: Int -> SmithCredentials -> ShowS # show :: SmithCredentials -> String # showList :: [SmithCredentials] -> ShowS #

OAuth2 scopes

data SmithScope Source #

Constructors

ProfileScope
CAScope

Instances

Bounded SmithScope Source #
Instance details Defined in Smith.Client.Config Methods minBound :: SmithScope # maxBound :: SmithScope #
Enum SmithScope Source #
Instance details Defined in Smith.Client.Config Methods succ :: SmithScope -> SmithScope # pred :: SmithScope -> SmithScope # toEnum :: Int -> SmithScope # fromEnum :: SmithScope -> Int # enumFrom :: SmithScope -> [SmithScope] # enumFromThen :: SmithScope -> SmithScope -> [SmithScope] # enumFromTo :: SmithScope -> SmithScope -> [SmithScope] # enumFromThenTo :: SmithScope -> SmithScope -> SmithScope -> [SmithScope] #
Eq SmithScope Source #
Instance details Defined in Smith.Client.Config Methods (==) :: SmithScope -> SmithScope -> Bool # (/=) :: SmithScope -> SmithScope -> Bool #
Ord SmithScope Source #
Instance details Defined in Smith.Client.Config Methods compare :: SmithScope -> SmithScope -> Ordering # (<) :: SmithScope -> SmithScope -> Bool # (<=) :: SmithScope -> SmithScope -> Bool # (>) :: SmithScope -> SmithScope -> Bool # (>=) :: SmithScope -> SmithScope -> Bool # max :: SmithScope -> SmithScope -> SmithScope # min :: SmithScope -> SmithScope -> SmithScope #
Show SmithScope Source #
Instance details Defined in Smith.Client.Config Methods showsPrec :: Int -> SmithScope -> ShowS # show :: SmithScope -> String # showList :: [SmithScope] -> ShowS #

High-level configuration operations.

configure :: IO (Either SmithConfigureError Smith) Source #

configureWith :: [SmithScope] -> Manager -> IO (Either SmithConfigureError Smith) Source #

configureT :: ExceptT SmithConfigureError IO Smith Source #

configureWithT :: [SmithScope] -> Manager -> ExceptT SmithConfigureError IO Smith Source #

Low-level configuration operations.

configureEndpoint :: IO SmithEndpoint Source #

configureOAuth2 :: Manager -> SmithEndpoint -> [Scope] -> JWK -> IdentityId -> IO Store Source #

configureCredentials :: ExceptT SmithConfigureError IO SmithCredentials Source #

configureCredentialsByteString :: SmithCredentialsType -> ByteString -> ExceptT SmithConfigureError IO SmithCredentials Source #

configureCredentialsFile :: SmithCredentialsType -> FilePath -> ExceptT SmithConfigureError IO SmithCredentials Source #

Configuration errors.

data SmithConfigureError Source #

Constructors

SmithConfigureCredentialsNotFound SmithCredentialsType
SmithConfigureJsonDecodeError SmithCredentialsType
SmithConfigureJwkDecodeError SmithCredentialsType
SmithConfigureIdentityIdDecodeError SmithCredentialsType

Instances

Eq SmithConfigureError Source #
Instance details Defined in Smith.Client.Config Methods (==) :: SmithConfigureError -> SmithConfigureError -> Bool # (/=) :: SmithConfigureError -> SmithConfigureError -> Bool #
Ord SmithConfigureError Source #
Instance details Defined in Smith.Client.Config Methods compare :: SmithConfigureError -> SmithConfigureError -> Ordering # (<) :: SmithConfigureError -> SmithConfigureError -> Bool # (<=) :: SmithConfigureError -> SmithConfigureError -> Bool # (>) :: SmithConfigureError -> SmithConfigureError -> Bool # (>=) :: SmithConfigureError -> SmithConfigureError -> Bool # max :: SmithConfigureError -> SmithConfigureError -> SmithConfigureError # min :: SmithConfigureError -> SmithConfigureError -> SmithConfigureError #
Show SmithConfigureError Source #
Instance details Defined in Smith.Client.Config Methods showsPrec :: Int -> SmithConfigureError -> ShowS # show :: SmithConfigureError -> String # showList :: [SmithConfigureError] -> ShowS #

renderSmithConfigureError :: SmithConfigureError -> Text Source #