ServiceStack

Whether to allow configured connection to be modified

Return only specified UserAuth Properties in AdminQueryUsers

Specify different size media rules when a property should be visible, e.g: MediaRules.ExtraSmall.Show<UserAuth>(x => new { x.Id, x.Email, x.DisplayName })

Which User fields can be updated

Which UserAuth fields cannot be updated using UserAuthProperties dictionary

Invoked before user is created or updated. A non-null return (e.g. HttpResult/HttpError) invalidates the request and is used as the API Response instead

Invoked before a User is created

Invoked after a User is created

Invoked before a User is updated. (NewUser, ExistingUser, Service)

Invoked after a User is updated. (NewUser, ExistingUser, Service)

Invoked before a User is deleted

Invoked after a User is deleted

Whether to execute OnRegistered Events for Users created through Admin UI (default true).

Add a new API Handler at a custom route. RawHttpHandlers.Add(ApiHandlers.Json("/api/{Request}")) => delegates /api/* requests to JSON Request Handler, e.g: - /api/Hello => {"result":"Hello"} - /api/Hello?name=World => {"result":"Hello, World"}

Inherit from this class if you want to host your web services inside an ASP.NET application.

The fallback ScriptContext to use if no SharpPagesFeature plugin was registered

Custom Rest Paths to register

Auto Register built-in dependencies when not registered

List of Plugins to Register

Exclude Assemblies when Auto Registering ServiceStack Services

Find All Service Assemblies

Find all IService types in Service Assemblies

Find all Request DTO types in Service Assemblies

Find all available Request DTOs in GlobalServiceAssemblies, GlobalServices and GlobalServiceRoutes

Get an IAppHost container. Note: Registering dependencies should only be done during setup/configuration stage and remain immutable there after for thread-safety.

Inherit from this class if you want to host your web services inside a Console Application, Windows Service, etc. Usage of HttpListener allows you to host webservices on the same port (:80) as IIS however it requires admin user privileges.

Default redirect URL if [Authenticate] attribute doesn't permit access.

Default redirect URL if Required Role or Permission attributes doesn't permit access.

The Interface Auth Repositories need to implement to support API Keys

The POCO Table used to persist API Keys

Enable access to protected Services using API Keys

Modify the registration of GetApiKeys and RegenerateApiKeys Services

How much entropy should the generated keys have. (default 24)

Generate different keys for different environments. (default live,test)

Different types of Keys each user can have. (default secret)

Whether to automatically expire keys. (default no expiry)

Automatically create the ApiKey Table for AuthRepositories which need it. (default true)

Whether to only allow access via API Key from a secure connection. (default true)

Change how API Key is generated

Run custom filter after API Key is created

Cache the User Session so it can be reused between subsequent API Key Requests

Whether to allow API Keys in 'apikey' QueryString or FormData

Specify all roles to be used by this application

Only allow access to users in specified roles

Inject logic into existing services by introspecting the request and injecting your own validation logic. Exceptions thrown will have the same behaviour as if the service threw it. If a non-null object is returned the request will short-circuit and return that response.

The instance of the service GET,POST,PUT,DELETE Response DTO; non-null will short-circuit execution and return that response

Get AuthProviders Registered in AuthFeature Plugin.

specific provider, or null for all providers

Get specific AuthProvider

Public API entry point to authenticate via code

null; if already authenticated otherwise a populated instance of AuthResponse

The specified may change as a side-effect of this method. If subsequent code relies on current data be sure to reload the session instance via .

Fired when a new Session is created

Called when the user is registered or on the first OAuth login

Override with Custom Validation logic to Assert if User is allowed to Authenticate. Returning a non-null response invalidates Authentication with IHttpResult response returned to client.

Called after the user has successfully authenticated

Fired before the session is removed after the /auth/logout Service is called

Called when the user is registered or on the first OAuth login

Override with Custom Validation logic to Assert if User is allowed to Authenticate. Returning a non-null response invalidates Authentication with IHttpResult response returned to client.

Called after the user has successfully authenticated

Fired before the session is removed after the /auth/logout Service is called

Convenient base class with empty virtual methods so subclasses only need to override the hooks they need.

Allows specifying a global fallback config that if exists is formatted with the Provider as the first arg. E.g. this appSetting with the TwitterAuthProvider: oauth.CallbackUrl="http://localhost:11001/auth/{0}" Would result in: oauth.CallbackUrl="http://localhost:11001/auth/twitter"

Remove the Users Session

Sync AuthProvider base class for compatibility with Sync Auth Providers

Remove the Users Session

Create an OAuth2 App at: https://discord.com/developers/applications The Apps Callback URL should match the CallbackUrl here. Discord OAuth2 info: https://discord.com/developers/docs/topics/oauth2 Discord OAuth2 Scopes from: https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes email: Basic info, plus will return email info from /users/@me API, this is the minimum required for ServiceStack integration. Checking of email verification is enforced due to Discord not requiring verified emails. Use `oauth.discord.ClientId` and `oauth.discord.ClientSecret` for Discord App settings.

Create a Facebook App at: https://developers.facebook.com/apps The Callback URL for your app should match the CallbackUrl provided.

Create an App at: https://github.com/settings/applications/new The Callback URL for your app should match the CallbackUrl provided.

Create an OAuth2 App at: https://code.google.com/apis/console/ The Apps Callback URL should match the CallbackUrl here. Google OAuth2 info: https://developers.google.com/accounts/docs/OAuth2Login Google OAuth2 Scopes from: https://www.googleapis.com/discovery/v1/apis/oauth2/v2/rest?fields=auth(oauth2(scopes)) https://www.googleapis.com/auth/plus.login: Know your name, basic info, and list of people you're connected to on Google+ https://www.googleapis.com/auth/plus.me Know who you are on Google+ https://www.googleapis.com/auth/userinfo.email View your email address https://www.googleapis.com/auth/userinfo.profile View basic information about your account

Download Yammer User Info given its ID.

The Yammer User ID. The User info in JSON format. Yammer provides a method to retrieve current user information via "https://www.yammer.com/api/v1/users/current.json". However, to ensure consistency with the rest of the Auth codebase, the explicit URL will be used, where [:id] denotes the User ID: "https://www.yammer.com/api/v1/users/[:id].json" Refer to: https://developer.yammer.com/restapi/ for full documentation.

Remove the Users Session

The entry point for all AuthProvider providers. Runs inside the AuthService so exceptions are treated normally. Overridable so you can provide your own Auth implementation.

Determine if the current session is already authenticated with this AuthProvider

Intercept successful Authenticate Request DTO requests

Intercept successful OAuth redirect requests

Instance of AuthenticateService

The current HTTP Request

Selected Auth Provider for Request

Authenticated Users Session

Authenticate Request DTO

Authenticate Response DTO

Optimal Session Referrer URL to use redirects

If User was already authenticated

If User Authenticated in this request

Original User Source (if exists)

The current HTTP Request

Authenticated Users Session

RegisterResponse DTO

Optimal Session Referrer URL to use redirects

The Response returned for this successful Auth Request

Instance of Service used in this Request

Current HTTP Request Context

Authenticated Users Session

Fired when a new Session is created

Called when the user is registered or on the first OAuth login

Called after the user has successfully authenticated

Fired before the session is removed after the /auth/logout Service is called

Return User Attributes for this Session

High-level overridable API that ServiceStack uses to check whether a user has all requiredRoles.

High-level overridable API that ServiceStack uses to check whether a user has any of the specified roles.

High-level overridable API that ServiceStack uses to check whether a user has all requiredPermissions.

High-level overridable API that ServiceStack uses to check whether a user has any of the specified roles.

Fired before Session is resolved

Called when the user is registered or on the first OAuth login

Called after the user has successfully authenticated

Fired before the session is removed after the /auth/logout Service is called

Override with Custom Validation logic to Assert if User is allowed to Authenticate. Returning a non-null response invalidates Authentication with IHttpResult response returned to client.

Custom logic to populate Session with data from Identity Auth Claims

Thread-safe In memory UserAuth data store so it can be used without a dependency on Redis.

Used to Issue and process JWT Tokens and registers ConvertSessionToToken Service to convert Sessions to JWT Tokens

Whether to populate the Bearer Token in the AuthenticateResponse

Print Dump contents of JWT to Console

Enable access to protected Services using JWT Tokens

Different HMAC Algorithms supported

Different RSA Signing Algorithms supported

Whether to only allow access via API Key from a secure connection. (default true)

Run custom filter after JWT Header is created

Run custom filter after JWT Payload is created

Run custom filter after session is restored from a JWT Token

Run Async custom filter after session is restored from a JWT Token

Whether to encrypt JWE Payload (default false). Uses RSA-OAEP for Key Encryption and AES/128/CBC HMAC SHA256 for Content Encryption

Which Hash Algorithm should be used to sign the JWT Token. (default HS256)

Whether to only allow processing of JWT Tokens using the configured HashAlgorithm. (default true)

The Issuer to embed in the token. (default ssjwt)

The Audience to embed in the token. (default null)

Embed Multiple Audiences in the token. (default none) A JWT is valid if it contains ANY audience in this List

Tokens must contain aud which is validated

What Id to use to identify the Key used to sign the token. (default First 3 chars of Base64 Key)

The AuthKey used to sign the JWT Token

Allow verification using multiple Auth keys

The RSA Private Key used to Sign the JWT Token when RSA is used

Convenient overload to initialize the Private Key via exported XML

The RSA Public Key used to Verify the JWT Token when RSA is used

Convenient overload to initialize the Public Key via exported XML

Allow verification using multiple public keys

Allow verification using multiple private keys for JWE tokens

How long should JWT Tokens be valid for. (default 14 days)

How long should JWT Refresh Tokens be valid for. (default 365 days)

Convenient overload to initialize ExpireTokensIn with an Integer

Allow custom logic to invalidate JWT Tokens

Allow custom logic to invalidate Refresh Tokens

Whether to invalidate all JWT Access Tokens issued before a specified date.

Whether to invalidate all JWT Refresh Tokens issued before a specified date.

Modify the registration of ConvertSessionToToken Service

Allow JWT in ?ss-tok=jwt QueryString. (default false)

Allow JWT in ss-tok=jwt HTML POST FormData. (default false)

Whether to automatically remove expired or invalid cookies

Whether to also Include Token in ConvertSessionToTokenResponse

Whether to store JWTs in Cookies (ss-tok) for successful Authentications (default true)

Override conversion to Unix Time used in issuing JWTs and validation

Inspect or modify JWT Payload before validation, return error message if invalid else null

Change resolution for resolving unique jti id for Access Tokens

Get the next AutoId for usage in jti JWT Access Tokens

Get the last jti AutoId generated

Change resolution for resolving unique jti id for Refresh Tokens

Get the next AutoId for usage in jti JWT Refresh Tokens

Invalidate JWTs with ids

Return token payload which is both verified and still valid

Return token payload which has been verified to be created using the configured encryption key. Use GetValidJwtPayload() instead if you also want the payload validated.

Return token payload which has been verified to be created using the configured encryption key. Use GetValidJwePayload() instead if you also want the payload validated.

Create new App at: https://www.linkedin.com/secure/developer

Create an Microsoft Graph App at: https://apps.dev.microsoft.com The Apps Callback URL should match the CallbackUrl here. Microsoft Graph Info: https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-overview Microsoft Graph Scopes: https://developer.microsoft.com/en-us/graph/docs/concepts/permissions_reference

Override to return User chosen username or Email for this AuthProvider

Custom DisplayName resolver function when not provided

Override to return User chosen username or Email for this AuthProvider

The entry point for all AuthProvider providers. Runs inside the AuthService so exceptions are treated normally. Overridable so you can provide your own Auth implementation.

Sets the CallbackUrl and session.ReferrerUrl if not set and initializes the session tokens for this AuthProvider

The entry point for all AuthProvider providers. Runs inside the AuthService so exceptions are treated normally. Overridable so you can provide your own Auth implementation.

Sets the CallbackUrl and session.ReferrerUrl if not set and initializes the session tokens for this AuthProvider

Create Odnoklassniki App at: http://www.odnoklassniki.ru/devaccess The Callback URL for your app should match the CallbackUrl provided. NB: They claim they use OAuth 2.0, but they in fact don't. http://apiok.ru/wiki/display/api/Authorization+OAuth+2.0

Allow utilizing an alternative PBKDF2 implementation.

The PBKDF2 strategy PasswordHasher implementation that's used for hashing PBKDF2 passwords.

The Password Hasher provider used to hash users passwords which uses the same algorithm used by ASP.NET Identity v3: PBKDF2 with HMAC-SHA256, 128-bit salt, 256-bit subkey, 10000 iterations.

Gets the number of iterations used when hashing passwords using PBKDF2. Default is 10,000.

The number of iterations used when hashing passwords using PBKDF2. Default is 10,000.

The Format Version specifier for this PasswordHasher embedded as the first byte in password hashes.

Returns a hashed representation of the supplied for the specified user.

The password to hash. A hashed representation of the supplied for the specified user.

Specifies the PRF which should be used for the key derivation algorithm.

The HMAC algorithm (RFC 2104) using the SHA-1 hash function (FIPS 180-4).

The HMAC algorithm (RFC 2104) using the SHA-256 hash function (FIPS 180-4).

The HMAC algorithm (RFC 2104) using the SHA-512 hash function (FIPS 180-4).

Provides algorithms for performing key derivation.

Performs key derivation using the PBKDF2 algorithm.

The password from which to derive the key. The salt to be used during the key derivation process. The pseudo-random function to be used in the key derivation process. The number of iterations of the pseudo-random function to apply during the key derivation process. The desired length (in bytes) of the derived key. The derived key. The PBKDF2 algorithm is specified in RFC 2898.

Internal interface used for abstracting away the PBKDF2 implementation since the implementation is OS-specific.

A PBKDF2 provider which utilizes the managed hash algorithm classes as PRFs. This isn't the preferred provider since the implementation is slow, but it is provided as a fallback.

Update an existing registration

Create new Registration

Logic to update UserAuth from Registration info, not enabled on PUT because of security.

Thank you Martijn http://www.dijksterhuis.org/creating-salted-hash-values-in-c/ Stronger/Slower Alternative: https://github.com/defuse/password-hashing/blob/master/PasswordStorage.cs

Create an OAuth2 App at: https://developer.spotify.com/dashboard/applications The Apps Callback URL should match the CallbackUrl here. Spotify OAuth2 info: https://developer.spotify.com/documentation/general/guides/authorization-guide/

Create an app at https://dev.twitter.com/apps to get your ConsumerKey and ConsumerSecret for your app. The Callback URL for your app should match the CallbackUrl provided.

Returns either the native IAuthRepositoryAsync provider or an IAuthRepositoryAsync sync-wrapped provider over IAuthRepository

Creates the required missing tables or DB schema

Create VK App at: http://vk.com/editapp?act=create The Callback URL for your app should match the CallbackUrl provided.

If previous attempts fails, the sequential calls build up code value like "code1,code2,code3" so we need the last one only

The ServiceStack Yammer OAuth provider.

This provider is loosely based on the existing ServiceStack's Facebook OAuth provider. For the full info on Yammer's OAuth2 authentication flow, refer to: https://developer.yammer.com/authentication/#a-oauth2 Note: Add these to your application / web config settings under appSettings and replace values as appropriate. ]]>

The OAuth provider name / identifier.

Initializes a new instance of the class.

The application settings (in web.config).

Gets or sets the Yammer OAuth client id.

Gets or sets the Yammer OAuth client secret.

Gets or sets the Yammer OAuth pre-auth url.

Authenticate against Yammer OAuth endpoint.

The auth service. The session. The request. The .

Load the UserAuth info into the session.

The User session. The OAuth tokens. The auth info.

Load the UserOAuth info into the session.

The auth session. The OAuth tokens.

The Yammer User's email addresses.

Gets or sets the email address type (e.g. primary).

Gets or sets the email address.

Create Yandex App at: https://oauth.yandex.ru/client/new The Callback URL for your app should match the CallbackUrl provided.

Protect access to this API to Authenticated Users only

Restrict authentication to a specific . For example, if this attribute should only permit access if the user is authenticated with , you should set this property to .

Redirect the client to a specific URL if authentication failed. If this property is null, simply `401 Unauthorized` is returned.

Enable the authentication feature and configure the AuthService.

Fired before any [Authenticate] or [Required*] Auth Attribute is validated. Return non-null IHttpResult to write to response and short-circuit request.

Custom Validation Function in AuthenticateService

Invoked before AuthFeature is registered

Invoked after AuthFeature is registered

Invoked on AddToAppMetadata

Invoked after User is Signed Out

Redirect path to when Access by Authenticated User is Denied

What queryString param to capture redirect param on

Redirect path to when Authenticated User requires 2FA

Redirect path to when User is Locked out

Whether to only capture return path or absolute URL (default)

Where users should redirect to after logging out

Whether to Create Digest Auth MD5 Hash when Creating/Updating Users. Defaults to only creating Digest Auth when DigestAuthProvider is registered.

Should UserName or Emails be saved in AuthRepository in LowerCase

UI Layout for Authentication

Allow or deny all GET Authenticate Requests

Add /authenticate and /authenticate/{provider} alias routes

The Session to return for AuthSecret

Use a plugin or OnBeforeInit delegate to register authProvider dynamically. Your plugin can implement `IPreInitPlugin` interface to call `appHost.GetPlugin<AuthFeature>().RegisterAuthProvider()` before the AuthFeature is registered.

User chosen Username when available or Email

High-level overridable API that ServiceStack uses to check whether a user has all requiredRoles.

High-level overridable API that ServiceStack uses to check whether a user has any of the specified roles.

High-level overridable API that ServiceStack uses to check whether a user has all requiredPermissions.

High-level overridable API that ServiceStack uses to check whether a user has any of the specified permissions.

The BaseUrl of the ServiceStack instance (inferred)

The different Content Type formats to display

The configured MaxLimit for AutoQuery

Whether to publish this Service to the public Services registry

Only show AutoQuery Services attributed with [AutoQueryViewer]

List of different Search Filters available

The Column which should be selected by default

The Query Type filter which should be selected by default

The search text which should be populated by default

Returns true if the User Is Authenticated

How many queries are available to this user

Removes items from cache that have keys matching the specified wildcard pattern

Cache client The wildcard, where "*" means any sequence of characters and "?" means any single character.

Removes items from cache that have keys matching the specified wildcard pattern

Cache client The wildcard, where "*" means any sequence of characters and "?" means any single character.

Removes items from the cache based on the specified regular expression pattern

Cache client Regular expression pattern to search cache keys

Removes items from the cache based on the specified regular expression pattern

Cache client Regular expression pattern to search cache keys

The CacheKey to be use store the response against

The base Cache Key used to cache the Service response

Additional CacheKey Modifiers used to cache different outputs for a single Service Response

How long to cache the resource for. Fallsback to HttpCacheFeature.DefaultExpiresIn

The unique ETag returned for this resource clients can use to determine whether their local version has changed

The Age for this resource returned to clients

The MaxAge returned to clients to indicate how long they can use their local cache before re-validating

The LastModified date to use for the Cache and HTTP Header

Cache-Control HTTP Headers

Create unique cache per user

Use HostContext.LocalCache or HostContext.Cache

Skip compression for this Cache Result

Cache the Response of a Service

Cache expiry in seconds

MaxAge in seconds

Cache-Control HTTP Headers

Vary cache per user

Vary cache for users in these roles

Vary cache for different HTTP Headers

Use HostContext.LocalCache or HostContext.Cache

Skip compression for this Cache Result

Returns underlying wrapped sync ICacheClient or ICacheClient API if cache implements it

Returns sync ICacheClient if wrapped

Decorates the ICacheClient (and its siblings) prefixing every key with the given prefix Useful for multi-tenant environments

Create new instance of CacheEntry.

UTC time at which CacheEntry expires.

Stores The value with key only if such key doesn't exist at the server yet. true if added

Adds or replaces the value with key. true if added

Replace the value with specified key only if it exists. true if updated

Add the value with key to the cache, set to never expire.

Add or replace the value with key to the cache, set to never expire.

Replace the value with key in the cache, set to never expire.

Add the value with key to the cache, set to expire at specified DateTime.

This method examines the DateTimeKind of expiresAt to determine if conversion to universal time is needed. The version of Add that takes a TimeSpan expiration is faster than using this method with a DateTime of Kind other than Utc, and is not affected by ambiguous local time during daylight savings/standard time transition.

Add or replace the value with key to the cache, set to expire at specified DateTime.

This method examines the DateTimeKind of expiresAt to determine if conversion to universal time is needed. The version of Set that takes a TimeSpan expiration is faster than using this method with a DateTime of Kind other than Utc, and is not affected by ambiguous local time during daylight savings/standard time transition.

Replace the value with key in the cache, set to expire at specified DateTime.

This method examines the DateTimeKind of expiresAt to determine if conversion to universal time is needed. The version of Replace that takes a TimeSpan expiration is faster than using this method with a DateTime of Kind other than Utc, and is not affected by ambiguous local time during daylight savings/standard time transition.

Add the value with key to the cache, set to expire after specified TimeSpan.

Add or replace the value with key to the cache, set to expire after specified TimeSpan.

Replace the value with key in the cache, set to expire after specified TimeSpan.

More familiar name for the new crowd.

The tier lets you specify a retrieving a setting with the tier prefix first before falling back to the original key. E.g a tier of 'Live' looks for 'Live.{Key}' or if not found falls back to '{Key}'.

Returns string if exists, otherwise null

User app.settings for Sharp App

Would've preferred to use [assembly: ContractNamespace] attribute but it is not supported in Mono

Gets the nullable app setting.

Gets the app setting.

Returns AppSetting[key] if exists otherwise defaultValue

Returns AppSetting[key] if exists otherwise defaultValue, for non-string values

Gets the connection string.

Gets the list from app setting.

Gets the dictionary from app setting.

Provides a common interface for Settings providers such as ConfigurationManager or Azure's RoleEnvironment. The only requirement is that if the implementation cannot find the specified key, the return value must be null

The key for the setting The string value of the specified key, or null if the key was invalid

Return all keys in this configuration source.

Represents a builder for the class.

Initializes a new instance of the class with a specified .

The of the .

Adds an that reads configuration values from the Web.config file.

The .

Adds an that reads configuration values from the Web.config file.

The tier of the . The .

Adds a that reads configuration values from a dictionary.

The dictionary of settings to add. The .

Adds an that reads configuration values from environmental variables.

The .

Adds an that reads configuration values from environmental variables.

The tier of the . The .

Adds an that reads configuration values from a text file at .

The path of the text file. The .

Adds an that reads configuration values from a text file at with a specified .

The path of the text file. The delimeter fo the text file. The .

Adds an that reads configuration values from a text file at with a specified .

The path of the text file. The delimeter fo the text file. The tier of the . The .

Builds an .

An .

Wrappers for improving consistency with .NET Core Conventions

Registers the type in the IoC container and adds auto-wiring to the specified type.

Registers a named instance of type in the IoC container and adds auto-wiring to the specified type.

Registers the type in the IoC container and adds auto-wiring to the specified type. The reuse scope is set to none (transient).

Registers the types in the IoC container and adds auto-wiring to the specified types. The reuse scope is set to none (transient).

Plugin adds support for Cross-origin resource sharing (CORS, see http://www.w3.org/TR/access-control/). CORS allows to access resources from different domain which usually forbidden by origin policy.

Represents a default constructor with Allow Origin equals to "*", Allowed GET, POST, PUT, DELETE, OPTIONS request and allowed "Content-Type" header.

Allow custom AppHost registrations to run at different plugin lifecycle events

Lets you Register new Services and the optional restPaths will be registered against this default Request Type

Change the default HTML view or template used for the HTML response of this service

Tracks created objects. Used by to track created IDisposable instances. These instances are tracked and disposed at the end of a request.

Adds disposable to the tracker

Dispose all disposables in the tracker. If disposable is still alive also .Release() is called to release the object.

Naming convention for the ResponseStatus property name on the response DTO

Create an instance of the service response dto type and inject it with the supplied responseStatus

Create an Error Response DTO for the specified Request DTO from the Exception

Attribute marks that specific response class has support for Cross-origin resource sharing (CORS, see http://www.w3.org/TR/access-control/). CORS allows to access resources from different domain which usually forbidden by origin policy.

Represents a default constructor with Allow Origin equals to "*", Allowed GET, POST, PUT, DELETE, OPTIONS request and allowed "Content-Type" header.

Redirect to the https:// version of this url if not already.

Don't redirect when in DebugMode

Don't redirect if the request was a forwarded request, e.g. from a Load Balancer

The current HTTP Request

The Request DTO

The Request DTO explicitly casted to a strong Type

The file to upload

The Uploaded file name

The Uploaded file extension

Date String Formatted as 'yyyy/MM/dd'

The FilesUploadFeature Plugin

The UploadLocation used for this upload

The User Session associated with this Request

The Authenticated User Id

Transform the file to upload. Can ignore file upload by returning null.

Base class for object validators.

The type of the object being validated

Base class for entity validator classes.

Sets the cascade mode for all rules within this validator.

Validates the specified instance

The object to validate A ValidationResult object containing any validation failures

Validates the specified instance asynchronously

The object to validate Cancellation token A ValidationResult object containing any validation failures

Validates the specified instance.

Validation Context A ValidationResult object containing any validation failures.

Validates the specified instance asynchronously.

Validation Context Cancellation token A ValidationResult object containing any validation failures.

Adds a rule to the current validator.

Creates a that can be used to obtain metadata about the current validator.

Defines a validation rule for a specify property.

RuleFor(x => x.Surname)... The type of property being validated The expression representing the property to validate an IRuleBuilder instance on which validators can be defined

Defines a validation rule for a specify property and transform it to a different type.

Transform(x => x.OrderNumber, to: orderNumber => orderNumber.ToString())... The type of property being validated The type after the transformer has been applied The expression representing the property to transform Function to transform the property value into a different type an IRuleBuilder instance on which validators can be defined

Defines a validation rule for a specify property and transform it to a different type.

Invokes a rule for each item in the collection.

Type of property Expression representing the collection to validate An IRuleBuilder instance on which validators can be defined

Invokes a rule for each item in the collection, transforming the element from one type to another.

Type of property The type after the transformer has been applied Expression representing the collection to validate Function to transform the collection element into a different type An IRuleBuilder instance on which validators can be defined

Invokes a rule for each item in the collection, transforming the element from one type to another.

Defines a RuleSet that can be used to group together several validators.

The name of the ruleset. Action that encapsulates the rules in the ruleset.

Defines a condition that applies to several rules

The condition that should apply to multiple rules Action that encapsulates the rules.

Defines a condition that applies to several rules

The condition that should apply to multiple rules Action that encapsulates the rules.

Defines an inverse condition that applies to several rules

The condition that should be applied to multiple rules Action that encapsulates the rules

Defines an inverse condition that applies to several rules

The condition that should be applied to multiple rules Action that encapsulates the rules

Defines an asynchronous condition that applies to several rules

The asynchronous condition that should apply to multiple rules Action that encapsulates the rules.

Defines an asynchronous condition that applies to several rules

The asynchronous condition that should apply to multiple rules Action that encapsulates the rules.

Defines an inverse asynchronous condition that applies to several rules

The asynchronous condition that should be applied to multiple rules Action that encapsulates the rules

Defines an inverse asynchronous condition that applies to several rules

The asynchronous condition that should be applied to multiple rules Action that encapsulates the rules

Includes the rules from the specified validator

Returns an enumerator that iterates through the collection of validation rules.

A that can be used to iterate through the collection. 1

Throws an exception if the instance being validated is null.

Determines if validation should occur and provides a means to modify the context and ValidationResult prior to execution. If this method returns false, then the ValidationResult is immediately returned from Validate/ValidateAsync.

Throws a ValidationException. This method will only be called if the validator has been configured to throw exceptions if validation fails. The default behaviour is not to throw an exception.

Validators are auto-wired transient instances

Defines a RuleSet that can be used to provide specific validation rules for specific HTTP methods (GET, POST...)

The HTTP methods where this rule set should be used. Action that encapsulates the rules in the ruleset.

Class that can be used to find all the validators from a collection of types.

Creates a scanner that works on a sequence of types.

Finds all the validators in the specified assembly.

Finds all the validators in the specified assemblies

Finds all the validators in the assembly containing the specified type.

Performs the specified action to all of the assembly scan results.

Returns an enumerator that iterates through the collection.

A that can be used to iterate through the collection. 1

Result of performing a scan.

Creates an instance of an AssemblyScanResult.

Validator interface type, eg IValidator<Foo>

Concrete type that implements the InterfaceType, eg FooValidator.

Extension methods that provide the default set of validators.

Defines a 'not null' validator on the current rule builder. Validation will fail if the property is null.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined

Defines a 'null' validator on the current rule builder. Validation will fail if the property is not null.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined

Defines a 'not empty' validator on the current rule builder. Validation will fail if the property is null, an empty string, whitespace, an empty collection or the default value for the type (for example, 0 for integers but null for nullable integers)

Type of object being validated Type of property being validated The rule builder on which the validator should be defined

Defines a 'empty' validator on the current rule builder. Validation will fail if the property is not null, an empty or the default value for the type (for example, 0 for integers)

Type of object being validated Type of property being validated The rule builder on which the validator should be defined

Defines a length validator on the current rule builder, but only for string properties. Validation will fail if the length of the string is outside of the specified range. The range is inclusive.

Type of object being validated The rule builder on which the validator should be defined

Defines a length validator on the current rule builder, but only for string properties. Validation will fail if the length of the string is outside of the specified range. The range is inclusive.

Type of object being validated The rule builder on which the validator should be defined

Defines a length validator on the current rule builder, but only for string properties. Validation will fail if the length of the string is not equal to the length specified.

Type of object being validated The rule builder on which the validator should be defined

Defines a length validator on the current rule builder, but only for string properties. Validation will fail if the length of the string is not equal to the length specified.

Type of object being validated The rule builder on which the validator should be defined

Defines a regular expression validator on the current rule builder, but only for string properties. Validation will fail if the value returned by the lambda does not match the regular expression.

Type of object being validated The rule builder on which the validator should be defined The regular expression to check the value against.

Defines a length validator on the current rule builder, but only for string properties. Validation will fail if the length of the string is larger than the length specified.

Type of object being validated The rule builder on which the validator should be defined

Defines a length validator on the current rule builder, but only for string properties. Validation will fail if the length of the string is less than the length specified.

Type of object being validated The rule builder on which the validator should be defined

Defines a regular expression validator on the current rule builder, but only for string properties. Validation will fail if the value returned by the lambda does not match the regular expression.

Type of object being validated The rule builder on which the validator should be defined The regular expression to check the value against.

Defines a regular expression validator on the current rule builder, but only for string properties. Validation will fail if the value returned by the lambda does not match the regular expression.

Type of object being validated The rule builder on which the validator should be defined The regular expression to use

Defines a regular expression validator on the current rule builder, but only for string properties. Validation will fail if the value returned by the lambda does not match the regular expression.

Type of object being validated The rule builder on which the validator should be defined The regular expression to use

Defines a regular expression validator on the current rule builder, but only for string properties. Validation will fail if the value returned by the lambda does not match the regular expression.

Type of object being validated The rule builder on which the validator should be defined The regular expression to check the value against. Regex options

Defines a regular expression validator on the current rule builder, but only for string properties. Validation will fail if the value returned by the lambda does not match the regular expression.

Type of object being validated The rule builder on which the validator should be defined The regular expression to check the value against. Regex options

Defines an email validator on the current rule builder for string properties. Validation will fail if the value returned by the lambda is not a valid email address.

Type of object being validated The rule builder on which the validator should be defined The mode to use for email validation. If set to , then a regular expression will be used. This is the same regex used by the EmailAddressAttribute in .NET 4.x. If set to then this uses the simplified ASP.NET Core logic for checking an email address, which just checks for the presence of an @ sign.

Defines a 'not equal' validator on the current rule builder. Validation will fail if the specified value is equal to the value of the property. For strings, this performs an ordinal comparison unless you specify a different comparer.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined The value to compare Equality comparer to use

Defines a 'not equal' validator on the current rule builder using a lambda to specify the value. Validation will fail if the value returned by the lambda is equal to the value of the property. For strings, this performs an ordinal comparison unless you specify a different comparer.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined A lambda expression to provide the comparison value Equality Comparer to use

Defines an 'equals' validator on the current rule builder. Validation will fail if the specified value is not equal to the value of the property. For strings, this performs an ordinal comparison unless you specify a different comparer.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined The value to compare Equality Comparer to use

Defines an 'equals' validator on the current rule builder using a lambda to specify the comparison value. Validation will fail if the value returned by the lambda is not equal to the value of the property. For strings, this performs an ordinal comparison unless you specify a different comparer.

The type of object being validated Type of property being validated The rule builder on which the validator should be defined A lambda expression to provide the comparison value Equality comparer to use

Defines a predicate validator on the current rule builder using a lambda expression to specify the predicate. Validation will fail if the specified lambda returns false. Validation will succeed if the specified lambda returns true.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined A lambda expression specifying the predicate

Defines an asynchronous predicate validator on the current rule builder using a lambda expression to specify the predicate. Validation will fail if the specified lambda returns false. Validation will succeed if the specified lambda returns true.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined A lambda expression specifying the predicate

Defines a 'less than' validator on the current rule builder. The validation will succeed if the property value is less than the specified value. The validation will fail if the property value is greater than or equal to the specified value.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined The value being compared

Defines a 'less than or equal' validator on the current rule builder. The validation will succeed if the property value is less than or equal to the specified value. The validation will fail if the property value is greater than the specified value.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined The value being compared

Defines a 'greater than' validator on the current rule builder. The validation will succeed if the property value is greater than the specified value. The validation will fail if the property value is less than or equal to the specified value.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined The value being compared

Defines a 'greater than or equal' validator on the current rule builder. The validation will succeed if the property value is greater than or equal the specified value. The validation will fail if the property value is less than the specified value.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined The value being compared

Defines a 'less than' validator on the current rule builder using a lambda expression. The validation will succeed if the property value is less than the specified value. The validation will fail if the property value is greater than or equal to the specified value.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined A lambda that should return the value being compared

Defines a 'less than or equal' validator on the current rule builder using a lambda expression. The validation will succeed if the property value is less than or equal to the specified value. The validation will fail if the property value is greater than the specified value.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined The value being compared

Defines a 'less than' validator on the current rule builder using a lambda expression. The validation will succeed if the property value is greater than the specified value. The validation will fail if the property value is less than or equal to the specified value.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined The value being compared

Defines a 'greater than' validator on the current rule builder using a lambda expression. The validation will succeed if the property value is greater than or equal the specified value. The validation will fail if the property value is less than the specified value.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined The value being compared

Defines a 'greater than or equal to' validator on the current rule builder using a lambda expression. The validation will succeed if the property value is greater than or equal the specified value. The validation will fail if the property value is less than the specified value.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined The value being compared

Defines an 'inclusive between' validator on the current rule builder, but only for properties of types that implement IComparable. Validation will fail if the value of the property is outside of the specified range. The range is inclusive.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined The lowest allowed value The highest allowed value

Defines an 'exclusive between' validator on the current rule builder, but only for properties of types that implement IComparable. Validation will fail if the value of the property is outside of the specified range. The range is exclusive.

Type of object being validated Type of property being validated The rule builder on which the validator should be defined The lowest allowed value The highest allowed value

Defines a credit card validator for the current rule builder that ensures that the specified string is a valid credit card number.

Defines a enum value validator on the current rule builder that ensures that the specific value is a valid enum value.

Type of Enum being validated Type of property being validated The rule builder on which the validator should be defined

Defines a scale precision validator on the current rule builder that ensures that the specific value has a certain scale and precision

Type of object being validated The rule builder on which the validator should be defined Allowed scale of the value Allowed precision of the value Whether the validator will ignore trailing zeros.

Defines a scale precision validator on the current rule builder that ensures that the specific value has a certain scale and precision

Type of object being validated The rule builder on which the validator should be defined Allowed scale of the value Allowed precision of the value Whether the validator will ignore trailing zeros.

Defines a custom validation rule

Allows rules to be built against individual elements in the collection.

Defines a enum value validator on the current rule builder that ensures that the specific value is a valid enum name.

Type of Enum being validated The rule builder on which the validator should be defined The enum whose the string should match any name If the comparison between the string and the enum names should be case sensitive

Defines child rules for a nested property.

The rule builder. Callback that will be invoked to build the rules.

Defines one or more validators that can be used to validate sub-classes or implementors in an inheritance hierarchy. This is useful when the property being validated is an interface or base-class, but you want to define rules for properties of a specific subclass.

Callback for setting up the inheritance validators.

Validates the specified instance using a combination of extra options

The validator The instance to validate Callback to configure additional options

Validates the specified instance using a combination of extra options

The validator The instance to validate Cancellation token Callback to configure additional options

Performs validation and then throws an exception if validation fails. This method is a shortcut for: Validate(instance, options => options.ThrowOnFailures());

The validator this method is extending. The instance of the type we are validating.

Performs validation asynchronously and then throws an exception if validation fails. This method is a shortcut for: ValidateAsync(instance, options => options.ThrowOnFailures());

The validator this method is extending. The instance of the type we are validating.

Validates certain properties of the specified instance.

The current validator The object to validate Expressions to specify the properties to validate A ValidationResult object containing any validation failures

Validates certain properties of the specified instance.

The object to validate The names of the properties to validate. A ValidationResult object containing any validation failures.

Validates an object using either a custom validator selector or a ruleset.

Validates certain properties of the specified instance asynchronously.

The current validator The object to validate Expressions to specify the properties to validate A ValidationResult object containing any validation failures

Validates certain properties of the specified instance asynchronously.

The object to validate The names of the properties to validate. A ValidationResult object containing any validation failures.

Validates an object asynchronously using a custom validator selector or a ruleset

Performs validation and then throws an exception if validation fails.

The validator this method is extending. The instance of the type we are validating. Optional: a ruleset when need to validate against.

Performs validation asynchronously and then throws an exception if validation fails.

The validator this method is extending. The instance of the type we are validating. Optional: a ruleset when need to validate against.

Performs validation and then throws an exception if validation fails.

The validator this method is extending. The instance of the type we are validating. The ruleset to validate against.

Performs validation asynchronously and then throws an exception if validation fails.

The validator this method is extending. The instance of the type we are validating. Optional: a ruleset when need to validate against.

Default options that can be used to configure a validator.

Specifies the cascade mode for failures. If set to 'Stop' then execution of the rule will stop once the first validator in the chain fails. If set to 'Continue' then all validators in the chain will execute regardless of failures.

Specifies a custom action to be invoked when the validator fails.

Specifies a custom error message to use when validation fails. Only applies to the rule that directly precedes it.

The current rule The error message to use

Specifies a custom error message to use when validation fails. Only applies to the rule that directly precedes it.

The current rule Delegate that will be invoked to retrieve the localized message.

Specifies a custom error message to use when validation fails. Only applies to the rule that directly precedes it.

The current rule Delegate that will be invoked.Uses_localized_name to retrieve the localized message.

Specifies a custom error code to use if validation fails.

The current rule The error code to use

Specifies a condition limiting when the validator should run. The validator will only be executed if the result of the lambda returns true.

The current rule A lambda expression that specifies a condition for when the validator should run Whether the condition should be applied to the current rule or all rules in the chain

Specifies a condition limiting when the validator should run. The validator will only be executed if the result of the lambda returns true.

The current rule A lambda expression that specifies a condition for when the validator should run Whether the condition should be applied to the current rule or all rules in the chain

Specifies a condition limiting when the validator should not run. The validator will only be executed if the result of the lambda returns false.

The current rule A lambda expression that specifies a condition for when the validator should not run Whether the condition should be applied to the current rule or all rules in the chain

Specifies a condition limiting when the validator should not run. The validator will only be executed if the result of the lambda returns false.

The current rule A lambda expression that specifies a condition for when the validator should not run Whether the condition should be applied to the current rule or all rules in the chain

Specifies an asynchronous condition limiting when the validator should run. The validator will only be executed if the result of the lambda returns true.

The current rule A lambda expression that specifies a condition for when the validator should run Whether the condition should be applied to the current rule or all rules in the chain

Specifies an asynchronous condition limiting when the validator should run. The validator will only be executed if the result of the lambda returns true.

The current rule A lambda expression that specifies a condition for when the validator should run Whether the condition should be applied to the current rule or all rules in the chain

Specifies an asynchronous condition limiting when the validator should not run. The validator will only be executed if the result of the lambda returns false.

The current rule A lambda expression that specifies a condition for when the validator should not run Whether the condition should be applied to the current rule or all rules in the chain

Specifies an asynchronous condition limiting when the validator should not run. The validator will only be executed if the result of the lambda returns false.

The current rule A lambda expression that specifies a condition for when the validator should not run Whether the condition should be applied to the current rule or all rules in the chain

Applies a filter to a collection property.

The current rule The condition

Triggers an action when the rule passes. Typically used to configure dependent rules. This applies to all preceding rules in the chain.

The current rule An action to be invoked if the rule is valid

Specifies a custom property name to use within the error message.

The current rule The property name to use

Specifies a custom property name to use within the error message.

The current rule Func used to retrieve the property's display name

Overrides the name of the property associated with this rule. NOTE: This is a considered to be an advanced feature. Most of the time that you use this, you actually meant to use WithName.

The current rule The property name to use

Overrides the name of the property associated with this rule. NOTE: This is a considered to be an advanced feature. Most of the time that you use this, you actually meant to use WithName.

The current rule An expression referencing another property

Specifies custom state that should be stored alongside the validation message when validation fails for this rule.

Specifies custom severity that should be stored alongside the validation message when validation fails for this rule.

Specifies custom method that will be called when specific rule fails

Allows the generated indexer to be overridden for collection rules.

The current rule The callback. Receives the model, the collection, the current element and the current index as parameters. Should return a string representation of the indexer. The default is "[" + index + "]"

Gets the default message for a property validator

The validator type The translated string

Specifies how rules should cascade when one fails.

When a rule fails, execution continues to the next rule.

When a rule fails, validation is stopped and all other rules in the chain will not be executed.

When a rule fails, validation is immediately halted.

Specifies where a When/Unless condition should be applied

Applies the condition to all validators declared so far in the chain.

Applies the condition to the current validator only.

Specifies the severity of a rule.

Error

Warning

Info

Validator implementation that allows rules to be defined without inheriting from AbstractValidator.


             public class Customer {
               public int Id { get; set; }
               public string Name { get; set; }
            
               public static readonly InlineValidator<Customer> Validator = new InlineValidator<Customer> {
                 v => v.RuleFor(x => x.Name).NotNull(),
                 v => v.RuleFor(x => x.Id).NotEqual(0),
               }
             }

Allows configuration of the validator.

Member accessor cache.

Gets an accessor func based on an expression

The member represented by the expression Accessor func

Rule definition for collection properties

Initializes new instance of the CollectionPropertyRule class

Filter that should include/exclude items in the collection.

Constructs the indexer in the property name associated with the error message. By default this is "[" + index + "]"

Creates a new property rule from a lambda expression.

Invokes the validator asynchronously

Invokes the validator

Custom logic for performing comparisons

Tries to compare the two objects.

The resulting comparison value. True if all went well, otherwise False.

Tries to do a proper comparison but may fail. First it tries the default comparison, if this fails, it will see if the values are fractions. If they are, then it does a double comparison, otherwise it does a long comparison.

Tries to compare the two objects, but will throw an exception if it fails.

True on success, otherwise False.

Tries to compare the two objects, but will throw an exception if it fails.

True on success, otherwise False.

Defines a condition that applies to several rules

The condition that should apply to multiple rules Action that encapsulates the rules.

Defines an inverse condition that applies to several rules

The condition that should be applied to multiple rules Action that encapsulates the rules

Defines an asynchronous condition that applies to several rules

The asynchronous condition that should apply to multiple rules Action that encapsulates the rules.

Defines an inverse asynchronous condition that applies to several rules

The asynchronous condition that should be applied to multiple rules Action that encapsulates the rules

Default validator selector that will execute all rules that do not belong to a RuleSet.

Determines whether or not a rule should execute.

The rule Property path (eg Customer.Address.Line1) Contextual information Whether or not the validator can execute.

Display name cache.

Useful extensions

Checks if the expression is a parameter expression

Gets a MemberInfo from a member expression.

Splits pascal case, so "FooBar" would become "Foo Bar"

Helper method to construct a constant expression from a constant.

Type of object being validated Type of property being validated The value being compared

Checks whether this is an asynchronous validation run.

Represents an object that is configurable.

Type of object being configured Return type

Configures the current object.

Action to configure the object.

Marker interface indicating an include rule.

Include rule

Creates a new IncludeRule

Creates a new include rule from an existing validator

Determines whether or not a rule should execute.

The rule Property path (eg Customer.Address.Line1) Contextual information Whether or not the validator can execute.

Selects validators that are associated with a particular property.

Creates a new instance of MemberNameValidatorSelector.

Member names that are validated.

Determines whether or not a rule should execute.

The rule Property path (eg Customer.Address.Line1) Contextual information Whether or not the validator can execute.

Creates a MemberNameValidatorSelector from a collection of expressions.

Gets member names from expressions

Assists in the construction of validation messages.

Default Property Name placeholder.

Default Property Value placeholder.

Adds a value for a validation message placeholder.

Appends a property name to the message.

The name of the property

Appends a property value to the message.

The value of the property

Adds additional arguments to the message for use with standard string placeholders.

Additional arguments

Constructs the final message from the specified template.

Message template The message with placeholders replaced with their appropriate values

Additional arguments to use

Additional placeholder values

Represents a chain of properties

Creates a new PropertyChain.

Creates a new PropertyChain based on another.

Creates a new PropertyChain

Creates a PropertyChain from a lambda expression

Adds a MemberInfo instance to the chain

Member to add

Adds a property name to the chain

Name of the property to add

Adds an indexer to the property chain. For example, if the following chain has been constructed: Parent.Child then calling AddIndexer(0) would convert this to: Parent.Child[0]

Whether square brackets should be applied before and after the indexer. Default true.

Creates a string representation of a property chain.

Checks if the current chain is the child of another chain. For example, if chain1 were for "Parent.Child" and chain2 were for "Parent.Child.GrandChild" then chain2.IsChildChainOf(chain1) would be true.

The parent chain to compare True if the current chain is the child of the other chain, otherwise false

Builds a property path.

Number of member names in the chain

Defines a rule associated with a property.

Condition for all validators in this rule.

Asynchronous condition for all validators in this rule.

Checks whether this rule has a condition defined.

Checks whether this rule has an async condition defined.

Property associated with this rule.

Function that can be invoked to retrieve the value of the property.

Expression that was used to create the rule.

String source that can be used to retrieve the display name (if null, falls back to the property name)

Sets the display name for the property.

The property's display name

Sets the display name for the property using a function.

The function for building the display name

Rule set that this rule belongs to (if specified)

Function that will be invoked if any of the validators associated with this rule fail.

The current validator being configured by this rule.

Type of the property being validated

Cascade mode for this rule.

Validators associated with this rule.

Creates a new property rule.

Property Function to get the property value Lambda expression used to create the rule Function to get the cascade mode. Type to validate Container type that owns the property

Creates a new property rule from a lambda expression.

Adds a validator to the rule.

Replaces a validator in this rule. Used to wrap validators.

Remove a validator in this rule.

Clear all validators from this rule.

Returns the property name for the property being validated. Returns null if it is not a property being validated (eg a method call)

Allows custom creation of an error message

Dependent rules

Display name for the property.

Performs validation using a validation context and returns a collection of Validation Failures.

Validation Context A collection of validation failures

Performs asynchronous validation using a validation context and returns a collection of Validation Failures.

Validation Context A collection of validation failures

Invokes the validator asynchronously

Invokes a property validator using the specified validation context.

Gets the property value, including any transformations that need to be applied.

The parent object The value to be validated

Applies a condition to the rule

Applies the condition to the rule asynchronously

Builds a validation rule and constructs a validator.

Type of object being validated Type of property being validated

The rule being created by this RuleBuilder.

Parent validator

Creates a new instance of the RuleBuilder class.

Sets the validator associated with the rule.

The validator to set

Sets the validator associated with the rule. Use with complex properties where an IValidator instance is already declared for the property type.

The validator to set

Sets the validator associated with the rule. Use with complex properties where an IValidator instance is already declared for the property type.

The validator provider to set

Associates a validator provider with the current property rule.

The validator provider to use

Sets the validator associated with the rule. Use with complex properties where an IValidator instance is already declared for the property type.

The validator provider to set

Selects validators that belong to the specified rulesets.

Rule sets

Creates a new instance of the RulesetValidatorSelector.

Determines whether or not a rule should execute.

The rule Property path (eg Customer.Address.Line1) Contextual information Whether or not the validator can execute.

Checks if the rule is an IncludeRule

Indicates that only the specified properties should be validated.

The property names to validate.

Indicates that only the specified properties should be validated.

The properties to validate, defined as expressions.

Indicates that all rules not in a rule-set should be included for validation (the equivalent of calling IncludeRuleSets("default")). This method can be combined with IncludeRuleSets.

Indicates that all rules should be executed, regardless of whether or not they're in a ruleset. This is the equivalent of IncludeRuleSets("*").

Indicates that only the specified rule sets should be validated.

The names of the rulesets to validate.

Indicates that the specified selector should be used to control which rules are executed.

The custom selector to use

Indicates that the validator should throw an exception if it fails, rather than return a validation result.

Defines a validation context.

The object currently being validated.

The value of the property being validated.

Parent validation context.

Validation context

Additional data associated with the validation request.

Property chain

Selector

Whether this is a child context

Whether this is a child collection context.

Validation context

Creates a new validation context

Creates a new validation context with a custom property chain and selector

Creates a new validation context using the specified options.

The instance to validate Callback that allows extra options to be configured.

The object to validate

Additional data associated with the validation request.

Property chain

Object being validated

Selector

Whether this is a child context

Whether this is a child collection context.

Whether the root validator should throw an exception when validation fails. Defaults to false.

Gets or creates generic validation context from non-generic validation context.

Creates a new validation context for use with a child validator

Creates a new validation context for use with a child collection validator

Defines a rule associated with a property which can have multiple validators.

The validators that are grouped under this rule.

Name of the rule-set to which this rule belongs.

Performs validation using a validation context and returns a collection of Validation Failures.

Validation Context A collection of validation failures

Performs validation using a validation context and returns a collection of Validation Failures asynchronously.

Validation Context Cancellation token A collection of validation failures

Applies a condition to either all the validators in the rule, or the most recent validator in the rule chain.

The condition to apply Indicates whether the condition should be applied to all validators in the rule, or only the current one

Applies an asynchronous condition to either all the validators in the rule, or the most recent validator in the rule chain.

The condition to apply Indicates whether the condition should be applied to all validators in the rule, or only the current one

Applies a condition that wraps the entire rule.

The condition to apply.

Applies an asynchronous condition that wraps the entire rule.

The condition to apply.

Defines a validator for a particular type.

Validates the specified instance.

The instance to validate A ValidationResult object containing any validation failures.

Validate the specified instance asynchronously

The instance to validate A ValidationResult object containing any validation failures.

Sets the cascade mode for all rules within this validator.

Defines a validator for a particular type.

Validates the specified instance.

A ValidationContext A ValidationResult object contains any validation failures.

Validates the specified instance asynchronously.

A ValidationContext Cancellation token A ValidationResult object contains any validation failures.

Creates a hook to access various meta data properties

A IValidatorDescriptor object which contains methods to access metadata

Checks to see whether the validator can validate objects of the specified type

Provides metadata about a validator.

Gets the name display name for a property.

Gets a collection of validators grouped by property.

Gets validators for a particular property.

Gets rules for a property.

Gets validators for a particular type.

Gets the validator for the specified type.

Validator metadata.

Condition associated with the validator. If the condition fails, the validator will not run.

Async condition associated with the validator. If the condition fails, the validator will not run.

Whether or not this validator has a condition associated with it.

Whether or not this validator has an async condition associated with it.

Adds a condition for this validator. If there's already a condition, they're combined together with an AND.

Function used to retrieve custom state for the validator

Function used to retrieve the severity for the validator

Retrieves the error code.

Retrieves the unformatted error message template.

Retrieves the error code.

Returns the default error message template for this validator, when not overridden.

Gets the error message. If a context is supplied, it will be used to format the message if it has placeholders. If no context is supplied, the raw unformatted message will be returned, containing placeholders.

The current property validator context. Either the formatted or unformatted error message.

Sets the overridden error message template for this validator.

A function for retrieving the error message template.

Sets the overridden error message template for this validator.

The error message to set

Marker interface that indicates a PropertyValidatorContext should be passed to GetString

Allows the default error message translations to be managed.

Whether localization is enabled.

Default culture to use for all requests to the LanguageManager. If not specified, uses the current UI culture.

Gets a translated string based on its key. If the culture is specific and it isn't registered, we try the neutral culture instead. If no matching culture is found to be registered we use English.

The key The culture to translate into

Provides error message templates

Construct the error message template

Error message template

Base class for languages

Name of language (culture code)

Adds a translation

Adds a translation for a type

Gets the localized version of a string with a specific key.

Allows the default error message translations to be managed.

Language factory.

The culture code. The key to load The corresponding Language instance or null.

Whether localization is enabled.

Default culture to use for all requests to the LanguageManager. If not specified, uses the current UI culture.

Removes all languages except the default.

Gets a translated string based on its key. If the culture is specific and it isn't registered, we try the neutral culture instead. If no matching culture is found to be registered we use English.

The key The culture to translate into

IStringSource implementation that uses the default language manager.

Lazily loads the string

Creates a LazyStringSource

Gets the value

Represents a static string.

Creates a new StringErrorMessageSource using the specified error message as the error template.

The error message template.

Construct the error message template

Error message template

Defines a validation failure

Creates a new validation failure.

Creates a new ValidationFailure.

The name of the property.

The error message

The property value that caused the failure.

Custom state associated with the failure.

Custom severity level associated with the failure.

Gets or sets the formatted message arguments. These are values for custom formatted message in validator resource files Same formatted message can be reused in UI and with same number of format placeholders Like "Value {0} that you entered should be {1}"

Gets or sets the formatted message placeholder values.

Creates a textual representation of the failure.

Creates a new ValidationFailure with ErrorCode.

Gets or sets the error code.

The result of running a validator

Whether validation succeeded

A collection of errors

Creates a new validationResult

Creates a new ValidationResult from a collection of failures

List of which is later available through . This list get's copied. Every caller is responsible for not adding null to the list.

Generates a string representation of the error messages separated by new lines.

Generates a string representation of the error messages separated by the specified character.

The character to separate the error messages.

Rule builder that starts the chain

Transforms the property value before validation occurs.

Rule builder

Associates a validator with this the property for this rule builder.

The validator to set

Associates an instance of IValidator with the current property rule.

The validator to use

Associates a validator provider with the current property rule.

The validator provider to use

Associates a validator provider with the current property rule.

The validator provider to use

Rule builder

Rule builder that starts the chain for a child collection

Transforms the collection element value before validation occurs.

Fluent interface for conditions (When/Unless/WhenAsync/UnlessAsync)

Rules to be invoked if the condition fails.

An exception that represents failed validation

Validation errors

Creates a new ValidationException

appends default validation error message to message

Creates a new ValidationException

Implementation of and that looks for the instance on the specified or in order to provide the validator instance.

Creates an instance of .

Creates an instance of with the supplied instance factory delegate used for creation of instances.

The instance factory delegate.

Gets a validator for the appropriate type.

Created instance; if a validator cannot be created.

Gets a validator for .

The instance to get a validator for. Created instance; if a validator cannot be created.

Validator attribute to define the class that will describe the Validation rules.

The type of the validator used to validate the current type or parameter.

Creates an instance of allowing a validator type to be specified.

Gets validators for method parameters.

Gets a validator for .

The instance to get a validator for. Created instance; if a validator cannot be created.

Used for providing metadata about a validator.

Rules associated with the validator

Creates a ValidatorDescriptor

Gets the display name or a property property

Gets all members with their associated validators

Gets validators for a specific member

Gets rules for a specific member

Gets the member name from an expression

Gets validators for a member

Gets rules grouped by ruleset

Information about rulesets

Creates a new RulesetMetadata

Ruleset name

Rules in the ruleset

Factory for creating validators

Gets a validator for a type

Instantiates the validator

Configuration options for validators.

Default cascade mode

Default property chain separator

Default language manager

Customizations of validator selector

Specifies a factory for creating MessageFormatter instances.

Pluggable logic for resolving property names

Pluggable logic for resolving display names

Disables the expression accessor cache. Not recommended.

Pluggable resolver for default error codes

Validator runtime options

Global configuration for all validators.

Default cascade mode

Default property chain separator

Default language manager

Customizations of validator selector

Specifies a factory for creating MessageFormatter instances.

Pluggable logic for resolving property names

Pluggable logic for resolving display names

Disables the expression accessor cache. Not recommended.

Pluggable resolver for default error codes

ValidatorSelector options

Factory func for creating the default validator selector

Factory func for creating the member validator selector

Factory func for creating the ruleset validator selector

Base class for all comparison validators

Performs the comparison

Override to perform the comparison

Metadata- the comparison type

Metadata- the member being compared

Metadata- the value being compared

Defines a comparison validator

Metadata- the comparison type

Metadata- the member being compared

Metadata- the value being compared

Asynchronous custom validator

Creates a new AsyncPredicateValidator

Defines a property validator that can be run asynchronously.

Indicates that this validator wraps another validator.

The type of the underlying validator

Ensures that the property value is a valid credit card number.

Custom validator that allows for manual/direct creation of ValidationFailure instances.

Creates a new instance of the CustomValidator

Creates a new instance of the CustomValidator.

Custom validation context

Creates a new CustomContext

The parent PropertyValidatorContext that represents this execution

Adds a new validation failure.

The property name The error message

Adds a new validation failure (the property name is inferred)

The error message

Adds a new validation failure

The failure to add

Defines which mode should be used for email validation.

Uses a regular expression for email validation. This is the same regex used by the EmailAddressAttribute in .NET 4.x.

Uses the simplified ASP.NET Core logic for checking an email address, which just checks for the presence of an @ sign.

A custom property validator. This interface should not be implemented directly in your code as it is subject to change. Please inherit from PropertyValidator instead.

Performs validation

Performs validation asynchronously.

Determines whether this validator should be run asynchronously or not.

Additional options for configuring the property validator.

Performs runtime checking of the value being validated, and passes validation off to a subclass validator.

Root model type Base type of property being validated.

Adds a validator to handle a specific subclass.

The derived validator Optionally specify rulesets to execute. If set, rules not in these rulesets will not be run

Adds a validator to handle a specific subclass.

The derived validator Optionally specify rulesets to execute. If set, rules not in these rulesets will not be run

Adds a validator to handle a specific subclass.

The derived validator Optionally specify rulesets to execute. If set, rules not in these rulesets will not be run

Adds a validator to handle a specific subclass. This method is not publicly exposed as it takes a non-generic IValidator instance which could result in a type-unsafe validation operation. It allows derived validaors more flexibility in handling type conversion. If you make use of this method, you should ensure that the validator can correctly handle the type being validated.

Optionally specify rulesets to execute. If set, rules not in these rulesets will not be run

Retrieves a localized string from the LanguageManager. If an ErrorCode is defined for this validator, the error code is used as the key. If no ErrorCode is defined (or the language manager doesn't have a translation for the error code) then the fallback key is used instead.

The fallback key to use for translation, if no ErrorCode is available. The translated error message template.

Prepares the of for an upcoming .

The validator context

Creates an error validation result for this validator.

The validator context Returns an error validation result.

Allows a decimal to be validated for scale and precision. Scale would be the number of digits to the right of the decimal point. Precision would be the number of digits. This number includes both the left and the right sides of the decimal point. It can be configured to use the effective scale and precision (i.e. ignore trailing zeros) if required. 123.4500 has an scale of 4 and a precision of 7, but an effective scale and precision of 2 and 5 respectively.

Use .NET XmlSerializer instead of .NET XML DataContract Serializer

Singleton access to AppHost

When the AppHost was instantiated.

When the Init function was done. Called at begin of

When all configuration was completed. Called at the end of

If app currently runs for unit tests. Used for overwriting AuthSession.

Whether to add Timestamp to Request

The base path ServiceStack is hosted on

The assemblies reflected to find api services. These can be provided in the constructor call.

Whether AppHost has been already initialized

Whether AppHost configuration is done. Note: It doesn't mean the start function was called.

Whether AppHost is ready configured and either ready to run or already running. Equals

Sharp App Name

Init Options before AppHost is initialized, e.g. in services.AddServiceStack(asm, options => { ... })

Configure your AppHost and its dependencies

Set the host config of the AppHost.

Initializes the AppHost. Calls the method. Should be called before start.

Gets Full Directory Path of where the app is running

Override to intercept VFS Providers registered for this AppHost

Starts the AppHost. this methods needs to be overwritten in subclass to provider a listener to start handling requests.

Url to listen to

The public name of this App

ServiceStack's Configuration API, see: https://docs.servicestack.net/appsettings

The populated Metadata for this AppHost's Services

The ServiceController that executes Services

Provides a pure object model for executing the full HTTP Request pipeline which returns the Response DTO back to ASP .NET Core gRPC which handles sending the response back to the HTTP/2 connected client.

The AppHost.Container. Note: it is not thread safe to register dependencies after AppStart.

Dynamically register Service Routes

Registered Routes

Manage registered Content Types & their sync/async serializers supported by this AppHost

Collection of PreRequest filters. They are called before each request is handled by a service, but after an HttpHandler is by the chosen. called in .

Collection of RequestConverters. Can be used to convert/change Input Dto Called after routing and model binding, but before request filters. All request converters are called unless Converter can return null, original model will be used. Note one converter could influence the input for the next converter!

Collection of ResponseConverters. Can be used to convert/change Output Dto Called directly after response is handled, even before !

Lists of view engines for this app. If view is needed list is looped until view is found.

Get "Catch All" IHttpHandler predicate IHttpHandler's, e.g. Used by HTML View Engines

Fallback IServiceStackHandler to handle Error Responses

Captured StartUp Exceptions

Captured Unobserved Async Errors

Which plugins were loaded in this AppHost

Collection of added plugins.

Writable Virtual File Source, uses FileSystemVirtualFiles at content root by default

Virtual File Sources from WebRoot, typically a MultiVirtualFiles containing a cascading list of Sources

FileSystem VFS for WebRoot

The Content Root Directory for this AppHost

Insert higher priority VFS providers at the start of the VFS providers list

Append lower priority VFS providers at the end of the VFS providers list

The fallback ScriptContext to use if no SharpPagesFeature plugin was registered

Global #Script ScriptContext for AppHost. Returns SharpPagesFeature plugin or fallsback to DefaultScriptContext.

Evaluate Expressions in ServiceStack's ScriptContext. Can be overridden if you want to customize how different expressions are evaluated.

Evaluate a script value, `IScriptValue.Expression` results are cached globally. If `IRequest` is provided, results from the same `IScriptValue.Eval` are cached per request.

Override to intercept sync #Script execution

Override to intercept async #Script execution

Executed immediately before a Service is executed. Use return to change the request DTO used, must be of the same type.

Executed immediately after a service is executed. Use return to change response used.

Occurs when the Service throws an Service Gateway Exception

Occurs when the Service throws an Exception.

Occurs when an exception is thrown whilst processing a request.

Override to intercept Response Exceptions

Override to intercept Short Circuited Authentication Errors

Override to intercept Exceptions thrown at Startup. Use StrictMode to rethrow Startup Exceptions

The Configuration for this AppHost

Override to intercept after the Config was loaded

Override to intercept when the Config has changed

Override to intercept before the AppHost is initialized

Override to intercept after the AppHost has been initialized

Override to intercept releasing this Service or Attribute instance

Override to intercept the final callback after executing this Request

Registers type to be automatically wired by the Ioc container of the AppHost.

Concrete type Abstract type

Tries to resolve type through the ioc container of the AppHost. Can return null.

Resolves Type through the Ioc container of the AppHost.

If type is not registered

Looks for first plugin of this type in Plugins.

Returns true if App has this plugin registered

Looks for first plugin of this type in Plugins.

Returns true if App has this plugin registered

Override to use a Custom ServiceRunner to execute this Request DTO

Override to use a localized string for internal routes & text used by ServiceStack

Override to customize the Absolute URL for this virtualPath for this IRequest

Override to change whether absolute links should use https:// URLs

Gets request parameter string value by looking in the following order: - QueryString[name] - FormData[name] - Cookies[name] - Items[name]

string value or null if it doesn't exist

Override to customize the BaseUrl to use for this IRequest

Override to customize the Physical Path for this virtualPath for this IRequest

Manually register Plugin to load

Override to intercept Service Requests

Override to intercept Async Service Requests

Override to intercept Service Requests

Override to intercept MQ Requests

Manually register ServiceStack Service at these routes

Return the [Route] attributes for this Request DTO Type

Override to customize WSDL returned in SOAP /metadata pages

Override to customize the physical path to return for this relativePath

Override to customize normalized /path/info to use for this request

Normalizes /path/info based on Config.HandlerFactoryPath

Override to customize Redirect Responses

Override to customize IHttpHandler used to service ?debug=requestinfo requests

Executes OnDisposeCallbacks and Disposes IDisposable's dependencies in the IOC & reset singleton states

Executes Service Request Converters

Executes Service Response Converters

Apply PreRequest Filters for participating Custom Handlers, e.g. RazorFormat, MarkdownFormat, etc

Apply PreAuthenticate Filters from IAuthWithRequest AuthProviders

Applies the raw request filters. Returns whether or not the request has been handled and no more processing should be done.

Applies the request filters. Returns whether or not the request has been handled and no more processing should be done.

Executes Service Request Filters

Applies the response filters. Returns whether or not the request has been handled and no more processing should be done.

Executes Service Response Filters

Executes MQ Response Filters

Execute Service Gateway Request Filters

Execute Service Gateway Response Filters

Executes Typed Request Filters

Configuration of ServiceStack's /metadata pages

Return the Default Session Expiry for this Request

Return whether this App supports this feature

Assert whether this App supports this feature

Assert whether this App should server this contentType

Override to return whether this request can access the metadata for the request

Override to handle Forbidden Feature Error Responses

Override to customize the IServiceStackHandler that should handle the specified errorStatusCode

Override to customize the IServiceStackHandler that should handle the specified HttpStatusCode

Override to change the IServiceStackHandler that should handle 404 NotFount Responses

Override to customize the IHttpHandler that should handle the specified HttpStatusCode

Return true if the current request is configured with the super user AdminAuthSecret or not

Override to customize converting an Exception into a generic ErrorResponse DTO

Override to customize converting an Exception into the ResponseStatus DTO

Return the Exception to use when creating the Error Response DTO and ResponseStatus

Callback for handling when errors are logged, also called for non-Exception error logging like 404 requests

Try infer UserId from IRequest

Override to intercept & customize Exception responses

Sanitize strings against XSS returned in API Responses

Override to intercept when Sessions using sync APIs are saved

Override to intercept when Sessions using async APIs are saved

Inspect or modify ever new UserSession created or resolved from cache. return null if Session is invalid to create new Session.

Override built-in Cookies, return false to prevent the Cookie from being set.

Overriden by AppHost's to return the current IRequest if it supports singleton access to the Request Context

Override to intercept the response of a ServiceStack Service request

Override to customize what DTOs are displayed on metadata pages

Gets IDbConnection Checks if DbInfo is seat in RequestContext. See multitenancy: https://docs.servicestack.net/multitenancy Called by itself, and ViewPageBase

Provided by services and pageView, can be helpful when overriding this method

Resolves based on .GetClient(); Called by itself, and ViewPageBase

Provided by services and pageView, can be helpful when overriding this method

Resolves based on .GetClient(); Called by itself, and ViewPageBase

Provided by services and pageView, can be helpful when overriding this method

If they don't have an ICacheClient configured use an In Memory one.

Tries to resolve through IoC container. If not registered, it falls back to .GetClient(), otherwise returns DefaultCache MemoryCacheClient

Get registered ICacheClientAsync otherwise returns async wrapped sync ICacheClient

Only sets cacheAsync if native Async provider, otherwise sets cacheSync

Returns . cache is only persisted for this running app instance. Called by .MemoryCacheClient

Provided by services and pageView, can be helpful when overriding this method Nullable MemoryCacheClient

Returns from the IOC container. Called by itself, and ViewPageBase

Provided by services and PageViewBase, can be helpful when overriding this method

Get the configured

Get the configured for this request.

Gets the registered

Gets the registered Returns native IAuthRepositoryAsync if exists, a sync wrapper if IAuthRepository exists, otherwise null.

Default logic to determine whether a Session is Authenticated

Return the ICookies implementation to use

Override to return whether static files should be sent compressed or not (if supported by UserAgent)

Allow overriding ServiceStack runtime config like JWT Keys

Override to intercept MQ Publish Requests

Override to intercept auto HTML Page Response

Override to alter what registered plugins you want discoverable (used by ServiceStack Studio to enable features).

Override Authorization Header resolution

Override Authorization Bearer Token resolution

Override JWT Token resolution

Override Authorization Refresh Token resolution

Override JWT Refresh Token resolution

Context to capture IService action

Can ignore as doesn't throw if HTTP Headers already written

Creates instance using straight Resolve approach. This will throw an exception if resolution fails

Creates instance using the TryResolve approach if tryResolve = true. Otherwise uses Resolve approach, which will throw an exception if resolution fails

Sets a persistent cookie which never expires

Sets a session cookie which expires after the browser session closes

Deletes a specified cookie by setting its value to empty and expiration to -1 days

Return File at specified virtualPath from AppHost.VirtualFiles ContentRootPath

Keep default file contents in-memory

Wrapper class for the HTTPListener to allow easier access to the server, for start and stop management and event routing of the actual inbound requests.

Starts the Web Service

A Uri that acts as the base that the server is listening on. Format should be: http://127.0.0.1:8080/ or http://127.0.0.1:8080/somevirtual/ Note: the trailing slash is required! For more info see the HttpListener.Prefixes property on MSDN.

Shut down the Web Service

Overridable method that can be used to implement a custom handler

Reserves the specified URL for non-administrator users and accounts. http://msdn.microsoft.com/en-us/library/windows/desktop/cc307223(v=vs.85).aspx

Reserved Url if the process completes successfully

Can ignore as doesn't throw if HTTP Headers already written

Used in Unit tests

The number of segments separated by '/' determinable by path.Split('/').Length e.g. /path/to/here.ext == 3

The total number of segments after subparts have been exploded ('.') e.g. /path/to/here.ext == 4

Provide for quick lookups based on hashes that can be determined from a request url

For performance withPathInfoParts should already be a lower case string to minimize redundant matching operations.

Get all Request DTO types implemented in Service Types

Get all Auto Batched requests implemented in service types

Get Best Matching Route.

If not null, ensures any Route matches any [Route(Matches)]

Execute MQ

Execute MQ with requestContext

Execute using empty RequestContext

Execute a Service with a Request DTO. See ExecuteAsync for a non-blocking alternative.

Execute a Service with a Request DTO.

Execute In Process Gateway Request with Gateway + Validation Filters

Gets the name of the base most type in the heirachy tree with the same. We get an exception when trying to create a schema with multiple types of the same name like when inheriting from a DataContract with the same name.

The type.

Ignore handling requests with matching /path/info prefixes

If enabled reverts to persist password hashes using the original SHA256 SaltedHash implementation. By default ServiceStack uses the more secure ASP.NET Identity v3 PBKDF2 with HMAC-SHA256 implementation. New Users will have their passwords persisted with the specified implementation, likewise existing users will have their passwords re-hased to use the current registered IPasswordHasher.

Older Password Hashers that were previously used to hash passwords. Failed password matches check to see if the password was hashed with any of the registered FallbackPasswordHashers, if true the password attempt will succeed and password will get re-hashed with the current registered IPasswordHasher.

Configure cookies to use SameSite=[null:Lax,true:Strict,false:None]

Read/Write Virtual FileSystem. Defaults to FileSystemVirtualPathProvider

Cascading collection of virtual file sources, inc. Embedded Resources, File System, In Memory, S3

The WebRoot VFS Directory of VirtualFilesSources

The ContentRoot VFS Directory of VirtualFiles

The FileSystem VirtualFiles provider in VirtualFileSources

The Memory VirtualFiles provider in VirtualFileSources

The GistVirtualFiles provider in VirtualFileSources (if any)

Call to signal the completion of a ServiceStack-handled Request

Resolves and auto-wires a ServiceStack Service from a ASP.NET HttpContext.

Resolves and auto-wires a ServiceStack Service from a HttpListenerContext.

Resolves and auto-wires a ServiceStack Service.

Back-end Service used by /js/hot-fileloader.js to detect file changes in /wwwroot and auto reload page.

Class that compresses given HTML source by removing comments, extra spaces and line breaks while preserving content within <pre>, <textarea>, <script> and <style> tags.

Blocks that should be additionally preserved could be marked with:

<!-- {{{ -->
             <!-- }}} -->

or any number of user defined patterns.

Content inside <script> or <style> tags could be optionally compressed using

Yahoo YUI ICompressor or Google Closure Compiler libraries. @author Sergiy Kovalchuk Predefined pattern that matches <?php ... ?> tags. Could be passed inside a list to {@link #setPreservePatterns(List) setPreservePatterns} method. Predefined pattern that matches <% ... %> tags. Could be passed inside a list to {@link #setPreservePatterns(List) setPreservePatterns} method. Predefined pattern that matches <--# ... --> tags. Could be passed inside a list to {@link #setPreservePatterns(List) setPreservePatterns} method. Predefined list of tags that are very likely to be block-level. Could be passed to {@link #setRemoveSurroundingSpaces(string) setRemoveSurroundingSpaces} method. Predefined list of tags that are block-level by default, excluding <div> and <li> tags. Table tags are also included. Could be passed to {@link #setRemoveSurroundingSpaces(string) setRemoveSurroundingSpaces} method. Could be passed to {@link #setRemoveSurroundingSpaces(string) setRemoveSurroundingSpaces} method to remove all surrounding spaces (not recommended). If set to false all compression will be bypassed. Might be useful for testing purposes. Default is true. @param enabled set false to bypass all compression Gets or Sets JavaScript compressor implementation that will be used to compress inline JavaScript in HTML. Returns CSS compressor implementation that will be used to compress inline CSS in HTML. If set to true all HTML comments will be removed. Default is true. @param removeComments set true to remove all HTML comments If set to true all multiple whitespace characters will be replaced with single spaces. Default is true. @param removeMultiSpaces set true to replace all multiple whitespace characters will single spaces. If set to true all inter-tag whitespace characters will be removed. Default is false.

Note: It is fairly safe to turn this option on unless you rely on spaces for page formatting. Even if you do, you can always preserve required spaces with  . This option has no performance impact.

@param removeIntertagSpaces set true to remove all inter-tag whitespace characters If set to true all unnecessary quotes will be removed from tag attributes. Default is false.

Note: Even though quotes are removed only when it is safe to do so, it still might break strict HTML validation. Turn this option on only if a page validation is not very important or to squeeze the most out of the compression. This option has no performance impact. @param removeQuotes set true to remove unnecessary quotes from tag attributes

Enables JavaScript compression within <script> tags if set to true. Default is false for performance reasons.

Note: Compressing JavaScript is not recommended if pages are compressed dynamically on-the-fly because of performance impact. You should consider putting JavaScript into a separate file and compressing it using standalone YUICompressor for example.

@param compressJavaScript set true to enable JavaScript compression. Default is false Enables CSS compression within <style> tags using Yahoo YUI ICompressor if set to true. Default is false for performance reasons.

Note: Compressing CSS is not recommended if pages are compressed dynamically on-the-fly because of performance impact. You should consider putting CSS into a separate file and compressing it using standalone YUICompressor for example.

@param compressCss set true to enable CSS compression. Default is false If set to true, existing DOCTYPE declaration will be replaced with simple <!DOCTYPE html> declaration. Default is false. @param simpleDoctype set true to replace existing DOCTYPE declaration with <!DOCTYPE html> If set to true, following attributes will be removed from <script> tags:

type="text/javascript"
type="application/javascript"
language="javascript"

Default is false.

@param removeScriptAttributes set true to remove unnecessary attributes from <script> tags If set to true, type="text/style" attributes will be removed from <style> tags. Default is false. @param removeStyleAttributes set true to remove type="text/style" attributes from <style> tags If set to true, following attributes will be removed from <link rel="stylesheet"> and <link rel="alternate stylesheet"> tags:

type="text/css"
type="text/plain"

Default is false. @param removeLinkAttributes set true to remove unnecessary attributes from <link> tags

If set to true, method="get" attributes will be removed from <form> tags. Default is false. @param removeFormAttributes set true to remove method="get" attributes from <form> tags If set to true, type="text" attributes will be removed from <input> tags. Default is false. @param removeInputAttributes set true to remove type="text" attributes from <input> tags If set to true, any values of following bool attributes will be removed:

checked
selected
disabled
readonly

For example, <input readonly="readonly"> would become <input readonly>

Default is false.

@param simpleBooleanAttributes set true to simplify bool attributes If set to true, javascript: pseudo-protocol will be removed from inline event handlers.

For example, <a onclick="javascript:alert()"> would become <a onclick="alert()">

Default is false.

@param removeJavaScriptProtocol set true to remove javascript: pseudo-protocol from inline event handlers. If set to true, HTTP protocol will be removed from href, src, cite, and action tag attributes. URL without a protocol would make a browser use document's current protocol instead.

Tags marked with rel="external" will be skipped.

For example:

<a href="http://example.com"> <script src="http://google.com/js.js" rel="external">

would become:

<a href="//example.com"> <script src="http://google.com/js.js" rel="external">

Default is false.

@param removeHttpProtocol set true to remove HTTP protocol from tag attributes If set to true, HTTPS protocol will be removed from href, src, cite, and action tag attributes. URL without a protocol would make a browser use document's current protocol instead.

Tags marked with rel="external" will be skipped.

For example:

<a href="https://example.com"> <script src="https://google.com/js.js" rel="external">

would become:

<a href="//example.com"> <script src="https://google.com/js.js" rel="external">

Default is false.

@param removeHttpsProtocol set true to remove HTTP protocol from tag attributes Enables surrounding spaces removal around provided comma separated list of tags.

Besides custom defined lists, you can pass one of 3 predefined lists of tags: {@link #BLOCK_TAGS_MIN BLOCK_TAGS_MIN}, {@link #BLOCK_TAGS_MAX BLOCK_TAGS_MAX}, {@link #ALL_TAGS ALL_TAGS}.

@param tagList a comma separated list of tags around which spaces will be removed This method allows setting custom block preservation rules defined by regular expression patterns. Blocks that match provided patterns will be skipped during HTML compression.

Custom preservation rules have higher priority than default rules. Priority between custom rules are defined by their position in a list (beginning of a list has higher priority).

Besides custom patterns, you can use 3 predefined patterns: {@link #PHP_TAG_PATTERN PHP_TAG_PATTERN}, {@link #SERVER_SCRIPT_TAG_PATTERN SERVER_SCRIPT_TAG_PATTERN}, {@link #SERVER_SIDE_INCLUDE_PATTERN SERVER_SIDE_INCLUDE_PATTERN}.

@param preservePatterns List of Regex objects that will be used to skip matched blocks during compression If set to true, HTML compression statistics will be generated.

Important: Enabling statistics makes HTML compressor not thread safe.

Default is false.

@param generateStatistics set true to generate HTML compression statistics Returns {@link HtmlCompressorStatistics} object containing statistics of the last HTML compression, if enabled. Should be called after {@link #compress(string)} @return {@link HtmlCompressorStatistics} object containing last HTML compression statistics @see HtmlCompressorStatistics @see #setGenerateStatistics(bool) The main method that compresses given HTML source and returns compressed result. @param html HTML content to compress @return compressed content. Returns metrics of an uncompressed document @return metrics of an uncompressed document @see HtmlMetrics Returns metrics of a compressed document @return metrics of a compressed document @see HtmlMetrics Returns total compression time.

Please note that compression performance varies very significantly depending on whether it was a cold run or not (specifics of Java VM), so for accurate real world results it is recommended to take measurements accordingly.

@return the compression time, in milliseconds Returns total size of blocks that were skipped by the compressor (for example content inside <pre> tags or inside <script> tags with disabled javascript compression) @return the total size of blocks that were skipped by the compressor, in bytes Returns total filesize of a document @return total filesize of a document, in bytes Returns number of empty characters (spaces, tabs, end of lines) in a document @return number of empty characters in a document Returns total size of inline <script> tags @return total size of inline <script> tags, in bytes Returns total size of inline <style> tags @return total size of inline <style> tags, in bytes Returns total size of inline event handlers (onclick, etc) @return total size of inline event handlers, in bytes

Include a single file using absolute or module relative path, e.g  or /*file:single.txt*/  or /*file:/path/to/single.txt*/

Include files matching a glob pattern using absolute or module relative paths, e.g  or /*files:components/*.css*/  or /*files:/dir/*.css*/

Apply no file transformations

Default File Transformer options: .html: - removes line comments  - removes empty whitespace lines - minifies in !DebugMode with .js: - removes lines starting with: 'import ', 'declare ' - removes line comments /**: ... */ - removes empty whitespace lines - minifies in !DebugMode with .css: - removes line comments /**: ... */ - removes empty whitespace lines

Invoke gateway response and return result as JSON, e.g: /*gateway:window.ARG=MyRequest({arg:1})*/

When tags are not used, e.g. in File Transformers

Register a shared folder to easily import shared .html components or files  or /*shared:app.css*/

Simple, lightweight and high-performant HTML templating solution

Define literal tokens to be replaced with dynamic fragments, e.g: <base href=""> = ctx => $"<base href=\"{ctx.Request.ResolveAbsoluteUrl($"~{DirPath}/")}\">"

Define custom html handlers, e.g:   or /*file:/path/to/single.txt*/  or /*files:/dir/*.css*/

File Transformer to use when reading files

File Transformer options - defaults to FilesTransformer.Default - disable with FileTransformer.None

Whether to enable ETag HTTP Caching when not in DebugMode

Whether to enable cached compressed responses

The HTTP CacheControl Header to use (default: public, max-age=3600, must-revalidate)

Whether to include FilesTransformer["html"].LineTransformers in main index.html

Flush HtmlModules cache so it's output is recreated on next request

Resolve file from the Module configured VirtualFiles

Specify query string params that will disable caching to enable dynamic UI rendering per request

File resolver to use to read file contents

End a ServiceStack Request

End a HttpHandler Request

End an MQ Request

End a ServiceStack Request with no content

Gets string value from Items[name] then Cookies[name] if exists. Useful when *first* setting the users response cookie in the request filter. To access the value for this initial request you need to set it in Items[].

string value or null if it doesn't exist

Gets request parameter string value by looking in the following order: - QueryString[name] - FormData[name] - Cookies[name] - Items[name]

string value or null if it doesn't exist * Input: http://localhost:96/Cambia3/Temp/Test.aspx/path/info?q=item#fragment Some HttpRequest path and URL properties: Request.ApplicationPath: /Cambia3 Request.CurrentExecutionFilePath: /Cambia3/Temp/Test.aspx Request.FilePath: /Cambia3/Temp/Test.aspx Request.Path: /Cambia3/Temp/Test.aspx/path/info Request.PathInfo: /path/info Request.PhysicalApplicationPath: D:\Inetpub\wwwroot\CambiaWeb\Cambia3\ Request.QueryString: /Cambia3/Temp/Test.aspx/path/info?query=arg Request.Url.AbsolutePath: /Cambia3/Temp/Test.aspx/path/info Request.Url.AbsoluteUri: http://localhost:96/Cambia3/Temp/Test.aspx/path/info?query=arg Request.Url.Fragment: Request.Url.Host: localhost Request.Url.LocalPath: /Cambia3/Temp/Test.aspx/path/info Request.Url.PathAndQuery: /Cambia3/Temp/Test.aspx/path/info?query=arg Request.Url.Port: 96 Request.Url.Query: ?query=arg Request.Url.Scheme: http Request.Url.Segments: / Cambia3/ Temp/ Test.aspx/ path/ info *

Duplicate params have their values joined together in a comma-delimited string

Use this to treat Request.Items[] as a cache by returning pre-computed items to save calculating them multiple times.

Specify the View to render HTML error responses with

Get the View to render HTML error responses with

Sets a persistent cookie which never expires

Sets a session cookie which expires after the browser session closes

Sets a persistent cookie which expires after the given time

Sets a persistent cookie with an expiresAt date

Deletes a specified cookie by setting its value to empty and expiration to -1 days

Writes to response. Response headers are customizable by implementing IHasOptions an returning Dictionary of Http headers.

The response. Whether or not it was implicitly handled by ServiceStack's built-in handlers. The default action. The serialization context. Add prefix to response body if any Add suffix to response body if any

When HTTP Headers have already been written and only the Body can be written

Return a decorated HTTP Result to customize the HTTP Response

Respond with a 'Soft redirect' so smart clients (e.g. ajax) have access to the response and can decide whether or not they should redirect

Decorate the response with an additional client-side event to instruct participating smart clients (e.g. ajax) with hints to transparently invoke client-side functionality

Shortcut to get the ResponseDTO whether it's bare or inside a IHttpResult

Alias of AsDto

Shortcut to get the ResponseDTO whether it's bare or inside a IHttpResult

TResponse if found; otherwise null

Alias of AsDto

Whether the response is an IHttpError or Exception or ErrorResponse

rangeHeader should be of the format "bytes=0-" or "bytes=0-12345" or "bytes=123-456"

Adds 206 PartialContent Status, Content-Range and Content-Length headers

ASP.NET or HttpListener ServiceStack host

The base path ServiceStack is hosted on

The assemblies reflected to find api services provided in the AppHost constructor

AutoWired Registration of an interface with a concrete type in AppHost IOC on Startup.

Allows the clean up for executed autowired services and filters. Calls directly after services and filters are executed.

Called at the end of each request. Enables Request Scope.

Inferred Metadata available from existing services

Add Request Filters, to be applied before the dto is deserialized

Add Request Converter to convert Request DTO's

Add Response Converter to convert Response DTO's

Add Request Filters for HTTP Requests

Add Async Request Filters for HTTP Requests

Add Response Filters for HTTP Responses

Add Async Response Filters for HTTP Responses

Add Request Filters for MQ/TCP Requests

Add Async Request Filters for MQ/TCP Requests

Add Response Filters for MQ/TCP Responses

Add Async Response Filters for MQ/TCP Responses

Add Request Filter for a specific Request DTO Type

Add an Async Request Filter for a specific Request DTO Type

Add as a Typed Request Filter for a specific Request DTO Type

The DTO Type. The methods to resolve the .

Add as an Async Typed Request Filter for a specific Request DTO Type

The DTO Type. The methods to resolve the .

Add Request Filter for a specific Response DTO Type

Add an Async Request Filter for a specific Response DTO Type

Add as a Typed Request Filter for a specific Request DTO Type

The DTO Type. The methods to resolve the .

Add as an Async Typed Request Filter for a specific Request DTO Type

The DTO Type. The methods to resolve the .

Add Request Filter for a specific MQ Request DTO Type

Add Request Filter for a specific MQ Response DTO Type

Add Request Filter for Service Gateway Requests

Add Async Request Filter for Service Gateway Requests

Add Response Filter for Service Gateway Responses

Add Async Response Filter for Service Gateway Responses

Add alternative HTML View Engines

Provide an exception handler for unhandled exceptions

Provide an exception handler for unhandled exceptions (Async)

Provide an exception handler for un-caught exceptions

Provide an exception handler for un-caught exceptions (Async)

Provide an exception handler for Service Gateway Exceptions

Provide an exception handler for Service Gateway Exceptions (Async)

Skip the ServiceStack Request Pipeline and process the returned IHttpHandler instead

Provide a catch-all handler that doesn't match any routes

Provide a fallback handler for not found requests (last filter in Request Pipeline)

Use a fall-back Error Handler for handling global errors

Use a Custom Error Handler for handling specific error HttpStatusCodes

Provide a custom model minder for a specific Request DTO

The AppHost config

The AppHost AppSettings. Defaults to App or Web.config appSettings.

Allow specific configuration to be overridden at runtime in multi-tenancy Applications by overriding GetRuntimeConfig in your AppHost

List of pre-registered and user-defined plugins to be enabled in this AppHost

Apply plugins to this AppHost

Returns the Absolute File Path, relative from your AppHost's Project Path

Cascading number of file sources, inc. Embedded Resources, File System, In Memory, S3

Read/Write Virtual FileSystem. Defaults to FileSystemVirtualPathProvider

The WebRoot VFS Directory of the cascading VirtualFileSources

The ContentRoot VFS Directory of the read/write VirtualFiles Provider

Insert Virtual File Sources at the beginning so they take precedence over built-in sources

Add additional Virtual File Sources at the end after built-in Virtual File Sources

Create a service runner for IService actions

Resolve the absolute url for this request

Resolve localized text, returns itself by default. The Request is provided when exists.

Execute MQ Message in ServiceStack

Access Service Controller for ServiceStack

Publish Message to be processed by AppHost

Global #Script ScriptContext for AppHost. Returns SharpPagesFeature plugin or fallsback to DefaultScriptContext.

Evaluate Expressions in ServiceStack's ScriptContext. Can be overridden if you want to customize how different expressions are evaluated.

Evaluate a script value, `IScriptValue.Expression` results are cached globally. If `IRequest` is provided, results from the same `IScriptValue.Eval` are cached per request.

Run "no-touch" Startup logic before the ServiceController is created and Config is initialized Only classes in AppHost or Service Assemblies are discovered and run.

Run "no-touch" Startup logic before AppHost.Configure() is run. Only classes in AppHost or Service Assemblies are discovered and run.

Run "no-touch" Startup logic after the AppHost has been initialized

A convenient repository base class you can inherit from to reduce the boilerplate with accessing a managed IDbConnection

A convenient base class for your injected service dependencies that reduces the boilerplate with managed access to ServiceStack's built-in providers

Handler to manage in memory collection of images

Handler to manage persistent images

Callback for Plugins to register necessary handlers with ServiceStack

Callback to pre-configure any logic before IPlugin.Register() is fired

Callback to post-configure any logic after IPlugin.Register() is fired

Callback for AuthProviders to register callbacks with AuthFeature

Allow Auth Providers to initialize the AuthFeature plugin

Resolve an alternate Web Service from ServiceStack's IOC container.

Load the Lisp TCP Repl within this ScriptContext (falls back to SharpPagesFeature)

Whether to Require Config.AdminAuthSecret to Access REPL

Additional Script Methods you want to add to the ScriptContext when Lisp TCP Repl is running

Additional Script Blocks you want to add to the ScriptContext when Lisp TCP Repl is running

Scan Types and auto-register any Script Methods, Blocks and Code Pages

Scan Assemblies and auto-register any Script Methods, Blocks and Code Pages

Allow scripting of Types from specified Assemblies

Allow scripting of the specified Types

Lookup Namespaces for resolving Types in Scripts

Allow scripting of all Types in loaded Assemblies

Converts markdown contents to HTML using the configured MarkdownConfig.Transformer. If a variable name is specified the HTML output is captured and saved instead. Usages: {{#markdown}} ## The Heading {{/markdown}} {{#markdown content}} ## The Heading {{/markdown}} HTML: {{content}}

How many times to retry processing messages before moving them to the DLQ

Execute global transformation or custom logic before a request is processed. Must be thread-safe.

Execute global transformation or custom logic on the response. Must be thread-safe.

If you only want to enable priority queue handlers (and threads) for specific msg types

Create workers for priority queues

Disable Priority MQ's for Background MQ

Opt-in to only publish responses on this white list. Publishes all responses by default.

Don't publish any response messages

Opt-in to only publish .outq messages on this white list. Publishes all responses by default.

Don't publish any messages to .outq

Subscribe to messages sent to .outq

The max size of the Out MQ Collection in each Type (default 100)

Encapsulates creating a new message handler

Processes all messages in a Normal and Priority Queue. Expects to be called in 1 thread. i.e. Non Thread-Safe.

Changes the links for the servicestack/metadata page

Export built-in Types so they're available from /metadata/app

Helper to make Nullable Reference Type Annotations

Add Code to top of generated code

Add Code to bottom of generated code

Include Additional QueryString Params in Header Options

Emit code without Header Options

Add Code to top of generated code

Add Code to bottom of generated code

Additional Options in Header Options

Emit code without Header Options

Add Code to top of generated code

Add Code to bottom of generated code

Additional Options in Header Options

Emit code without Header Options

Can only export "Empty" Marker Interfaces

Add Code to top of generated code

Add Code to bottom of generated code

Additional Options in Header Options

Emit code without Header Options

Add Code to top of generated code

Add Code to bottom of generated code

Additional Options in Header Options

Emit code without Header Options

Add Code to top of generated code

Add Code to bottom of generated code

Include Additional QueryString Params in Header Options

Emit code without Header Options

Whether property should be marked optional

Helper to make Nullable properties

Add Code to top of generated code

Additional Options in Header Options

Emit code without Header Options

Add Code to bottom of generated code

Whether property should be marked optional

Customize how types are encoded & decoded with a Type Converter

Add Code to top of generated code

Add Code to bottom of generated code

Include Additional QueryString Params in Header Options

Emit code without Header Options

Decorate generation of type

Attribute (e.g. @propertyWrapper) to decorate the property with

Name of KeyedDecodingContainer extension method to call to decode the property value, e.g. convertIfPresent

Name of KeyedDecodingContainer extension method to call to decode the property value, e.g. encode

Split assignment expression into smaller batches to avoid "Uncaught RangeError: Maximum call stack size exceeded" in Chrome/Blink

Add Code to top of generated code

Add Code to bottom of generated code

Split assignment expression into smaller batches to avoid "Uncaught RangeError: Maximum call stack size exceeded" in Chrome/Blink

Add Code to top of generated code

Add Code to bottom of generated code

Add Code to top of generated code

Add Code to bottom of generated code

Include Additional QueryString Params in Header Options

Emit code without Header Options

Whether property should be marked optional

Helper to make Nullable properties

Add Code to top of generated code

Add Code to bottom of generated code

Include Additional QueryString Params in Header Options

Emit code without Header Options

Get the static Parse(string) method on the type supplied

Gets the constructor info for T(string) if exists.

Returns the value returned by the 'T.Parse(string)' method if exists otherwise 'new T(string)'. e.g. if T was a TimeSpan it will return TimeSpan.Parse(textValue). If there is no Parse Method it will attempt to create a new instance of the destined type

Determines whether the Config section identified by the sectionName exists.

Gets the connection string setting.

Provide a thread-safe CRUD wrapper around a collection of POCOs

Return next Id in sequence

Returns a shallow copy of all items

Create and return all items in a MemoryDataSource

Add an existing item. Use NextId() to populate Item with Unique Id Use Save() to Replace existing Item with same Id when it exists

Replace Item

Replace existing Item with same Id

true if an existing item was found and replaced otherwise false

Delete Item by Poco

true if an item was deleted otherwise false

Delete Item with same Id

true if an item was deleted otherwise false

Delete All Item with matching Ids

true if an item was deleted otherwise false

Add or Update existing Item if item with same Id exists

Postman 2 Feature

Only generate specified Verb entries for "ANY" routes

Handle async file uploads

Limit API access to users in role

Which features to Profile, default all

Size of circular buffer of profiled events

Don't log requests of these types. By default Profiling/Metadata requests are excluded

Don't log requests from these path infos prefixes

Turn On/Off Tracking of Responses per-request

Don't log request body's for services with sensitive information. By default Auth and Registration requests are hidden.

Don't log Response DTO Types

Turn On/Off Tracking of Responses per-request

Whether to include CallStack StackTrace

Attach custom data to request profiling summary fields

Label to show for custom tag

The properties displayed in Profiling UI results grid

Default take, if none is specified

Customize DiagnosticEntry that gets captured

Maximum char/byte length of string response body

Unique Id

Request Id

ServiceStack, OrmLite, Redis

Connection Open/Close, Command, Pool, Transaction

Human Message describing entry

Method name

Managed Thread Id

Error Info if any

INSERT/SELECT, GET/SET

SQL, Redis

Single Arg

Redis positional Args

OrmLite Args

Custom data that can be attached with ProfilingFeature.TagResolver

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized string similar to Container service is built-in and read-only..

Looks up a localized string similar to Service type {0} does not inherit or implement {1}..

Looks up a localized string similar to Required dependency of type {0} named '{1}' could not be resolved..

Looks up a localized string similar to Required dependency of type {0} could not be resolved..

Looks up a localized string similar to Unknown scope..

Transparently Proxy requests through to downstream HTTP Servers

Customize the HTTP Request Headers that are sent to downstream server

Customize the downstream HTTP Response Headers that are returned to client

Inspect or Transform the HTTP Request Body that's sent downstream

Inspect or Transform the downstream HTTP Response Body that's returned

Required filters to specify which requests to proxy and which url to use.

Specify which requests should be proxied Specify which downstream url to use

Service error logs are kept in 'urn:ServiceErrors:{ServiceName}'

Combined service error logs are maintained in 'urn:ServiceErrors:All'

Enable the Registration feature and configure the RegistrationService.

UI Layout for User Registration

Abstraction to provide a context per request. in aspnet.web its equivalent to System.Web.HttpContext.Current.Items falls back to CallContext

Tell ServiceStack to use ThreadStatic Items Collection for RequestScoped items. Warning: ThreadStatic Items aren't pinned to the same request in async services which callback on different threads.

Start a new Request context, everything deeper in Async pipeline will get this new RequestContext dictionary.

Gets a list of items for this request.

This list will be cleared on every request and is specific to the original thread that is handling the request. If a handler uses additional threads, this data will not be available on those threads.

Track any IDisposable's to dispose of at the end of the request in IAppHost.OnEndRequest()

Release currently registered dependencies for this request

true if any dependencies were released

Returns the optimized result for the IRequest. Does not use or store results in any cache.

Returning the most optimized result based on the MimeType and CompressionType from the IRequest.

Returning the most optimized result based on the MimeType and CompressionType from the IRequest. How long to cache for, null is no expiration

Store an entry in the IHttpRequest.Items Dictionary

Get an entry from the IHttpRequest.Items Dictionary

Duplicate Params are given a unique key by appending a #1 suffix

Base class to create request filter attributes only for specific HTTP methods (GET, POST...)

Creates a new

Defines when the filter should be executed

This method is only executed if the HTTP method matches the property.

The http request wrapper The http response wrapper The request DTO

Create a ShallowCopy of this instance.

Base class to create request filter attributes only for specific HTTP methods (GET, POST...)

Creates a new

Defines when the filter should be executed

This method is only executed if the HTTP method matches the property.

The http request wrapper The http response wrapper The request DTO

Create a ShallowCopy of this instance.

RequestLogs service Route, default is /requestlogs

Turn On/Off Session Tracking

Turn On/Off Logging of Raw Request Body, default is Off

Turn On/Off Raw Request Body Tracking per-request

Turn On/Off Tracking of Responses

Turn On/Off Tracking of Responses per-request

Turn On/Off Tracking of Exceptions

Don't log matching requests

Size of InMemoryRollingRequestLogger circular buffer

Limit API access to users in role

Change the RequestLogger provider. Default is InMemoryRollingRequestLogger

Don't log requests of these types. By default RequestLog's are excluded

Don't log request body's for services with sensitive information. By default Auth and Registration requests are hidden.

Don't log Response DTO Types

Limit logging to only Service Requests

Customize Request Log Entry

Ignore logging and serializing these Request DTOs

Use custom Ignore Request DTO predicate

Change what DateTime to use for the current Date (defaults to UtcNow)

Default take, if none is specified

Protect access to this API to only Authenticated Users with specified Claim

Protect access to this API to only Authenticated Users assigned with all specified Permissions

Check all session is in all supplied roles otherwise a 401 HttpError is thrown

Protect access to this API to only Authenticated Users assigned with all specified Roles

Check all session is in all supplied roles otherwise a 401 HttpError is thrown

Indicates that the request dto, which is associated with this attribute, can only execute, if the user has specific permissions.

Indicates that the request dto, which is associated with this attribute, can only execute, if the user has any of the specified roles.

Check all session is in any supplied roles otherwise a 401 HttpError is thrown

Base class to create response filter attributes only for specific HTTP methods (GET, POST...)

Creates a new

Defines when the filter should be executed

This method is only executed if the HTTP method matches the property.

The http request wrapper The http response wrapper The response DTO

Create a ShallowCopy of this instance.

Base class to create response filter attributes only for specific HTTP methods (GET, POST...)

Creates a new

Defines when the filter should be executed

This method is only executed if the HTTP method matches the property.

The http request wrapper The http response wrapper The response DTO

Create a ShallowCopy of this instance.

Allow every request to run as Admin User

Calls sync OnSubscribe if exists by default

Calls sync OnUnsubscribe if exists by default

Fired for both Sync/Async Notifications

Only fired for async notifications. Calls sync OnPublish if exists by default.

Fired when a subscription is updated

Replace the default ServiceStack.Text JSON Serializer with an alternative JSON Serializer

Invoked when a connection

Call IServerEvents.RemoveExpiredSubscriptions() after every count

How long to wait to obtain lock before force disposing subscription connection

Generic + Useful IService base class

Resolve

Resolve ServiceStack Services

Returns . cache is only persisted for this running app instance.

Cascading collection of virtual file sources, inc. Embedded Resources, File System, In Memory, S3

Read/Write Virtual FileSystem. Defaults to FileSystemVirtualPathProvider

Dynamic Session Bag

Typed UserSession

If user found in session for this request is authenticated.

Publish a MQ message over the implementation.

Disposes all created disposable properties of this service and executes disposing of all request s (warning, manually triggering this might lead to unwanted disposing of all request related objects and services.)

Scans the supplied Assemblies to infer REST paths and HTTP verbs.

The instance. The assemblies with REST services. The same instance; never .

Resolve ServiceStack Validator in external ServiceStack provider class like ServiceStackController

Typed UserSession

Dynamic Session Bag

Only return form input value if form submission was invalid

Configure ServiceStack to have ISession support

Create the active Session or Permanent Session Id cookie.

Create both Permanent and Session Id cookies and return the active sessionId

Creates a new Session without an Id

Creates a new Session with the specified sessionId otherwise it's populated with a new generated Session Id that's

A custom placeholder SharpPagesFeature plugin optimized to support for SPA and SSG features

Role Required to call Templates Admin Service (/script/admin), Default is Admin. If null Templates Admin Service will not be registered.

Role Required to call Metadata Debug Service (/metadata/debug). If null Metadata Debug Service will only be registered in DebugMode.

Whether to auto populate scoped args with Request.FormData[] and Request.QueryString[] params (default false). Recommendation is to instead use `form.name` or `query.name` (or `qs.name`) to explicitly reference user input values.

Resolve Page-based Routing page from /path/info

Render static Sitemaps to specified path

Optimized code to find if GZIP is supported from: - http://dotnetperls.com/gzip-request Other resources for GZip, deflate resources: - http://www.west-wind.com/Weblog/posts/10564.aspx - http://www.west-wind.com/WebLog/posts/102969.aspx - ICSharpCode

This class intercepts 401 requests and changes them to 402 errors. When this happens the FormAuthentication module will no longer hijack it and redirect back to login because it is a 402 error, not a 401. When the request ends, this class sets the status code back to 401 and everything works as it should. PathToSuppress is the path inside your website where the above swap should happen. If you can build for .net 4.5, you do not have to do this swap. You can take advantage of a new flag (SuppressFormsAuthenticationRedirect) that tells the FormAuthenticationModule to not redirect, which also means you will not need the EndRequest code.

RequestLogs service Route, default is /metadata/svg

Custom Validation for SVG Metadata Page, return false to deny access, e.g. only allow in DebugMode with: ValidateFn = req => HostContext.DebugMode

Load Embedded Resource Templates in ServiceStack. To get ServiceStack to use your own instead just add a copy of one or more of the following to your Web Root: ~/Templates/IndexOperations.html ~/Templates/OperationControl.html ~/Templates/HtmlFormat.html

Links to make available to users in different roles (e.g. in built-in UIs)

Only Attributes used in built-in UIs are returned in /metadata/app.json

Creates a new instance of the RulesetValidatorSelector.

Determines whether or not a rule should execute.

The rule Property path (eg Customer.Address.Line1) Contextual information Whether or not the validator can execute.

Specify default ErrorCodes to use when custom validation conditions are invalid

Specify default Error Messages to use when Validators with these ErrorCode's are invalid

Activate the validation mechanism, so every request DTO with an existing validator will be validated.

The app host

Override to provide additional/less context about the Service Exception. By default the request is serialized and appended to the ResponseStatus StackTrace.

Auto-scans the provided assemblies for a and registers it in the provided IoC container.

The IoC container The assemblies to scan for a validator

Converts the validation result to an error result which will be serialized by ServiceStack in a clean and human-readable way.

The validation result

Converts the validation result to an error exception which will be serialized by ServiceStack in a clean and human-readable way if the returned exception is thrown.

The validation result

Main container class for components, supporting container hierarchies and lifetime management of instances.

Name of dependency

Alias for RegisterAutoWiredAs

Auto-wires an existing instance, ie all public properties are tried to be resolved.

Generates a function which creates and auto-wires TService.

Auto-wires an existing instance of a specific type. The auto-wiring progress is also cached to be faster when calling next time with the same type.

Initializes a new empty container.

Default owner for new registrations. by default.

Default reuse scope for new registrations. by default.

Creates a child container of the current one, which exposes its current service registration to the new child container.

Disposes the container and all instances owned by it (see ), as well as all child containers created through .

Registers a service instance with the container. This instance will have and behavior.

Service instance to use.

Registers a named service instance with the container. This instance will have and behavior.

Name of the service to register.Service instance to use.

Retrieves a function that can be used to lazily resolve an instance of the service when needed.

Type of the service to retrieve.The function that can resolve to the service instance when invoked.The requested service has not been registered previously.

Retrieves a function that can be used to lazily resolve an instance of the service with the given name when needed.

Type of the service to retrieve.Name of the service to retrieve.The function that can resolve to the service instance with the given name when invoked.The requested service with the given name has not been registered previously.

Retrieves a function that can be used to lazily resolve an instance of the service of the given type, name and service constructor arguments when needed.

Name of the service to retrieve.The function that can resolve to the service instance with the given and service constructor arguments name when invoked.The requested service with the given name and constructor arguments has not been registered previously.

Retrieves a function that can be used to lazily resolve an instance of the service of the given type, name and service constructor arguments when needed.

Registers the given service by providing a factory delegate to instantiate it.

The service type to register.The factory delegate to initialize new instances of the service when needed.The registration object to perform further configuration via its fluent interface.

Registers the given service by providing a factory delegate that receives arguments to instantiate it.

The service type to register.First argument that should be passed to the factory delegate to create the instace.The factory delegate to initialize new instances of the service when needed.The registration object to perform further configuration via its fluent interface.

Registers the given service by providing a factory delegate that receives arguments to instantiate it.

The service type to register.First argument that should be passed to the factory delegate to create the instace.Second argument that should be passed to the factory delegate to create the instace.The factory delegate to initialize new instances of the service when needed.The registration object to perform further configuration via its fluent interface.

Registers the given service by providing a factory delegate that receives arguments to instantiate it.

The service type to register.First argument that should be passed to the factory delegate to create the instace.Second argument that should be passed to the factory delegate to create the instace.Third argument that should be passed to the factory delegate to create the instace.Fourth argument that should be passed to the factory delegate to create the instace.The factory delegate to initialize new instances of the service when needed.The registration object to perform further configuration via its fluent interface.

Registers the given service by providing a factory delegate that receives arguments to instantiate it.

The service type to register.First argument that should be passed to the factory delegate to create the instace.Second argument that should be passed to the factory delegate to create the instace.Third argument that should be passed to the factory delegate to create the instace.Fourth argument that should be passed to the factory delegate to create the instace.Fifth argument that should be passed to the factory delegate to create the instace.The factory delegate to initialize new instances of the service when needed.The registration object to perform further configuration via its fluent interface.

Registers the given service by providing a factory delegate that receives arguments to instantiate it.

The service type to register.First argument that should be passed to the factory delegate to create the instace.Second argument that should be passed to the factory delegate to create the instace.Third argument that should be passed to the factory delegate to create the instace.Fourth argument that should be passed to the factory delegate to create the instace.Fifth argument that should be passed to the factory delegate to create the instace.Sixth argument that should be passed to the factory delegate to create the instace.The factory delegate to initialize new instances of the service when needed.The registration object to perform further configuration via its fluent interface.

Registers the given named service by providing a factory delegate to instantiate it.

The service type to register.A name used to differenciate this service registration.The factory delegate to initialize new instances of the service when needed.The registration object to perform further configuration via its fluent interface.

Registers the given named service by providing a factory delegate that receives arguments to instantiate it.

The service type to register.First argument that should be passed to the factory delegate to create the instace.A name used to differenciate this service registration.The factory delegate to initialize new instances of the service when needed.The registration object to perform further configuration via its fluent interface.

Registers the given named service by providing a factory delegate that receives arguments to instantiate it.

The service type to register.First argument that should be passed to the factory delegate to create the instace.Second argument that should be passed to the factory delegate to create the instace.A name used to differenciate this service registration.The factory delegate to initialize new instances of the service when needed.The registration object to perform further configuration via its fluent interface.

Registers the given named service by providing a factory delegate that receives arguments to instantiate it.

The service type to register.First argument that should be passed to the factory delegate to create the instace.Second argument that should be passed to the factory delegate to create the instace.Third argument that should be passed to the factory delegate to create the instace.Fourth argument that should be passed to the factory delegate to create the instace.A name used to differenciate this service registration.The factory delegate to initialize new instances of the service when needed.The registration object to perform further configuration via its fluent interface.

Registers the given named service by providing a factory delegate that receives arguments to instantiate it.

The service type to register.First argument that should be passed to the factory delegate to create the instace.Second argument that should be passed to the factory delegate to create the instace.Third argument that should be passed to the factory delegate to create the instace.Fourth argument that should be passed to the factory delegate to create the instace.Fifth argument that should be passed to the factory delegate to create the instace.A name used to differenciate this service registration.The factory delegate to initialize new instances of the service when needed.The registration object to perform further configuration via its fluent interface.

Registers the given named service by providing a factory delegate that receives arguments to instantiate it.

The service type to register.First argument that should be passed to the factory delegate to create the instace.Second argument that should be passed to the factory delegate to create the instace.Third argument that should be passed to the factory delegate to create the instace.Fourth argument that should be passed to the factory delegate to create the instace.Fifth argument that should be passed to the factory delegate to create the instace.Sixth argument that should be passed to the factory delegate to create the instace.A name used to differenciate this service registration.The factory delegate to initialize new instances of the service when needed.The registration object to perform further configuration via its fluent interface.

Resolves the given service by type, without passing any arguments for its construction.

Type of the service to retrieve.The resolved service instance.The given service could not be resolved.

Resolves the given service by type, passing the given arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.The resolved service instance.The given service could not be resolved.

Resolves the given service by type, passing the given arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.Second argument to pass to the factory delegate that may create the instace.Third argument to pass to the factory delegate that may create the instace.Fourth argument to pass to the factory delegate that may create the instace.The resolved service instance.The given service could not be resolved.

Resolves the given service by type, passing the given arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.Second argument to pass to the factory delegate that may create the instace.Third argument to pass to the factory delegate that may create the instace.Fourth argument to pass to the factory delegate that may create the instace.Fifth argument to pass to the factory delegate that may create the instace.The resolved service instance.The given service could not be resolved.

Resolves the given service by type, passing the given arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.Second argument to pass to the factory delegate that may create the instace.Third argument to pass to the factory delegate that may create the instace.Fourth argument to pass to the factory delegate that may create the instace.Fifth argument to pass to the factory delegate that may create the instace.Sixth argument to pass to the factory delegate that may create the instace.The resolved service instance.The given service could not be resolved.

Resolves the given service by type and name, without passing arguments for its initialization.

Type of the service to retrieve.The resolved service instance.The given service could not be resolved.

Resolves the given service by type and name, passing the given arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.The resolved service instance.The given service could not be resolved.

Resolves the given service by type and name, passing the given arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.Second argument to pass to the factory delegate that may create the instace.Third argument to pass to the factory delegate that may create the instace.Fourth argument to pass to the factory delegate that may create the instace.Fifth argument to pass to the factory delegate that may create the instace.The resolved service instance.The given service could not be resolved.

Resolves the given service by type and name, passing the given arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.Second argument to pass to the factory delegate that may create the instace.Third argument to pass to the factory delegate that may create the instace.Fourth argument to pass to the factory delegate that may create the instace.Fifth argument to pass to the factory delegate that may create the instace.Sixth argument to pass to the factory delegate that may create the instace.The resolved service instance.The given service could not be resolved.

Attempts to resolve the given service by type, without passing arguments for its initialization.

Type of the service to retrieve. The resolved service instance or if it cannot be resolved.

Attempts to resolve the given service by type, passing the given arguments arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace. The resolved service instance or if it cannot be resolved.

Attempts to resolve the given service by type, passing the given arguments arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.Second argument to pass to the factory delegate that may create the instace.Third argument to pass to the factory delegate that may create the instace.Fourth argument to pass to the factory delegate that may create the instace. The resolved service instance or if it cannot be resolved.

Attempts to resolve the given service by type, passing the given arguments arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.Second argument to pass to the factory delegate that may create the instace.Third argument to pass to the factory delegate that may create the instace.Fourth argument to pass to the factory delegate that may create the instace.Fifth argument to pass to the factory delegate that may create the instace. The resolved service instance or if it cannot be resolved.

Attempts to resolve the given service by type, passing the given arguments arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.Second argument to pass to the factory delegate that may create the instace.Third argument to pass to the factory delegate that may create the instace.Fourth argument to pass to the factory delegate that may create the instace.Fifth argument to pass to the factory delegate that may create the instace.Sixth argument to pass to the factory delegate that may create the instace. The resolved service instance or if it cannot be resolved.

Attempts to resolve the given service by type and name, without passing arguments arguments for its initialization.

Type of the service to retrieve. The resolved service instance or if it cannot be resolved.

Attempts to resolve the given service by type and name, passing the given arguments arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace. The resolved service instance or if it cannot be resolved.

Attempts to resolve the given service by type and name, passing the given arguments arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.Second argument to pass to the factory delegate that may create the instace.Third argument to pass to the factory delegate that may create the instace.Fourth argument to pass to the factory delegate that may create the instace. The resolved service instance or if it cannot be resolved.

Attempts to resolve the given service by type and name, passing the given arguments arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.Second argument to pass to the factory delegate that may create the instace.Third argument to pass to the factory delegate that may create the instace.Fourth argument to pass to the factory delegate that may create the instace.Fifth argument to pass to the factory delegate that may create the instace. The resolved service instance or if it cannot be resolved.

Attempts to resolve the given service by type and name, passing the given arguments arguments for its initialization.

Type of the service to retrieve.First argument to pass to the factory delegate that may create the instace.Second argument to pass to the factory delegate that may create the instace.Third argument to pass to the factory delegate that may create the instace.Fourth argument to pass to the factory delegate that may create the instace.Fifth argument to pass to the factory delegate that may create the instace.Sixth argument to pass to the factory delegate that may create the instace. The resolved service instance or if it cannot be resolved.

Makes this collection read-only.

After the collection is marked as read-only, any further attempt to modify it throws an .

Encapsulates a method that has five parameters and returns a value of the type specified by the parameter.

Encapsulates a method that has six parameters and returns a value of the type specified by the parameter.

Encapsulates a method that has seven parameters and returns a value of the type specified by the parameter.

Helper interface used to hide the base members from the fluent API to make for much cleaner Visual Studio intellisense experience.

Funqlets are a set of components provided as a package to an existing container (like a module).

Configure the given container with the registrations provided by the funqlet.

Container to register.

Interface used by plugins to contribute registrations to an existing container.

Determines who is responsible for disposing instances registered with a container.

Container should dispose provided instances when it is disposed. This is the default.

Container does not dispose provided instances.

Default owner, which equals .

Exception thrown by the container when a service cannot be resolved.

Initializes the exception with the service that could not be resolved.

Initializes the exception with the service (and its name) that could not be resolved.

Initializes the exception with an arbitrary message.

Determines visibility and reuse of instances provided by the container.

Instances are reused within a container hierarchy. Instances are created (if necessary) in the container where the registration was performed, and are reused by all descendent containers.

Instances are reused only at the given container. Descendent containers do not reuse parent container instances and get a new instance at their level.

Each request to resolve the dependency will result in a new instance being returned.

Instances are reused within the given request

Default scope, which equals .

Ownership setting for the service.

Reuse scope setting for the service.

The container where the entry was registered.

Specifies the owner for instances, which determines how they will be disposed.

Specifies the scope for instances, which determines visibility of instances across containers and hierarchies.

The Func delegate that creates instances of the service.

The cached service instance if the scope is or .

The Func delegate that initializes the object after creation.

Clones the service entry assigning the to the . Does not copy the .

Fluent API for customizing the registration of a service.

Fluent API that allows registering an initializer for the service.

Specifies an initializer that should be invoked after the service instance has been created by the factory.

Fluent API that exposes both and owner ().

Fluent API that allows specifying the reuse instances.

Specifies how instances are reused within a container or hierarchy. Default scope is .

Fluent API that allows specifying the owner of instances created from a registration.

Specifies the owner of instances created from this registration. Default owner is .