RepositoryException Class

Assembly: CodeEffects.Rule.Repository.dll
Namespace: CodeEffects.Rule.Repository

Summary

The exception that the Rule Repository throws when it cannot complete a request, a source sync, or a reindex.

Syntax

public class RepositoryException : CodeEffects.Rule.Common.RuleException

Remarks

You never create this exception. Context.GetResponse(..) and Context.GetRequestToken(..) throw it when a request fails, Context.SyncSources(..) when one or more source definitions fail, and Context.Reindex(..) when one or more source objects fail. The Message of the exception is safe to show to a user. The underlying failure, a database error included, is the InnerException. Log it on the server and never send it to the browser.

The repository has no logging of its own. Errors reach your application the way every other .NET error does, so the error handling and logging that your application already has see them. Warnings are not errors. A missing permission, a record that someone else has changed, and a failed validation are returned in the response and are never thrown. The one exception is a refusal for a missing permission, which RepositoryPermissionException reports so that you can log it.

A host that wants its users to see a friendly message with a control number, instead of a failed HTTP call, catches this exception around Context.GetResponse(..), logs it, and returns the ResponseJson property as the result of its endpoint. Catch RepositoryPermissionException first, because it derives from this class. When the failure of the database is the reason, ResponseJson carries a general message and the control number, never the text of the database error.

Any other exception that occurs while GetResponse(..) handles a request is wrapped in a RepositoryException, so the call throws this exception or RepositoryPermissionException and nothing else. SyncSources(..) and Reindex(..) throw a RuleException instead when you pass them a null argument.

Inherited Properties

• ControlNumber
  

  Type: System.String

  Gets the support control number of this exception, inherited from RuleException. Use it when you contact Code Effects Software for technical support.

Example

using CodeEffects.Rule.Repository;

try
{
	return Context.GetResponse(config, dbProvider, requestJson);
}
catch (RepositoryPermissionException ex)
{
	logger.LogWarning("Refused {Action}: {Message}", ex.Action, ex.Message);
	return ex.ResponseJson;
}
catch (RepositoryException ex)
{
	// Log everything on the server; the browser gets the general message and the control number only.
	logger.LogError(ex, "Request failed: {ControlNumber}", ex.ControlNumber);
	return ex.ResponseJson;
}

Inheritance

• System.Object
  • System.Exception
    • CodeEffects.Rule.Common.RuleException
      • CodeEffects.Rule.Repository.RepositoryException
        • CodeEffects.Rule.Repository.RepositoryPermissionException