pip_services4_commons library

Classes

AnyValue

Cross-language implementation of dynamic object what can hold value of any type. The stored value can be converted to different types using variety of accessor methods.

AnyValueArray

Cross-language implementation of dynamic object array what can hold values of any type. The stored values can be converted to different types using variety of accessor methods.

AnyValueMap

Cross-language implementation of dynamic object map (dictionary) what can hold values of any type. The stored values can be converted to different types using variety of accessor methods.

ApplicationExceptionFactory

Factory to recreate exceptions from ErrorDescription values passed through the wire.

ArrayConverter

Converts arbitrary values into array objects.

BooleanConverter

Converts arbitrary values to boolean values using extended conversion rules:

DateTimeConverter

Converts arbitrary values into Date values using extended conversion rules:

DoubleConverter

Converts arbitrary values into double using extended conversion rules:

DurationConverter

Converts arbitrary values into Date values using extended conversion rules:

ErrorCategory

Defines standard error categories to application exceptions supported by PipServices toolkit.

ErrorDescription

Serializeable error description. It is use to pass information about errors between microservices implemented in different languages. On the receiving side ErrorDescription is used to recreate exception object close to its original type without missing additional details.

ErrorDescriptionFactory

Factory to create serializeable ErrorDescription from ApplicationException or from arbitrary errors.

FloatConverter

Converts arbitrary values into float using extended conversion rules:

ICloneable

Interface for data objects that are able to create their full binary copy.

IntegerConverter

Converts arbitrary values into integers using extended conversion rules:

IValueWrapper

Helper class to wrap value.

JsonConverter

Converts arbitrary values from and to JSON (JavaScript Object Notation) strings.

LongConverter

Converts arbitrary values into longs using extended conversion rules:

MapConverter

Converts arbitrary values into map objects using extended conversion rules:

MethodReflector

Helper class to perform method introspection and dynamic invocation.

ObjectReader

Helper class to perform property introspection and dynamic reading.

ObjectWriter

Helper class to perform property introspection and dynamic writing.

PropertyReflector

Helper class to perform property introspection and dynamic reading and writing.

RecursiveMapConverter

Converts arbitrary values into map objects using extended conversion rules. This class is similar to MapConverter, but is recursively converts all values stored in objects and arrays.

RecursiveObjectReader

Helper class to perform property introspection and dynamic reading.

RecursiveObjectWriter

Helper class to perform property introspection and dynamic writing.

StringConverter

Converts arbitrary values into strings using extended conversion rules:

StringValueMap

Cross-language implementation of a map (dictionary) where all keys and values are strings. The stored values can be converted to different types using variety of accessor methods.

TypeConverter

Converts arbitrary values into objects specific by TypeCodes. For each TypeCode this class calls corresponding converter which applies extended conversion rules to convert the values.

TypeDescriptor

Descriptor that points to specific object type by it's name and optional library (or module) where this type is defined.

TypeMatcher

Helper class matches value types for equality.

TypeReflector

Helper class to perform object type introspection and object instantiation.

Enums

TypeCode

Codes for the data types that can be converted using TypeConverter.

Exceptions / Errors

ApplicationException

Defines a base class to defive various application exceptions.

BadRequestException

Errors due to improper user requests.

ConfigException

Errors related to mistakes in the microservice's user-defined configurations.

ConflictException

Errors raised by conflicts between object versions that were posted by the user and those that are stored on the server.

ConnectionException

Errors that occur during connections to remote services. They can be related to misconfiguration, network issues, or the remote service itself.

FileException

Errors in read/write local disk operations.

InternalException

Errors caused by programming mistakes.

InvalidStateException

Errors related to calling operations, which require the component to be in a specific state.

InvocationException

Errors returned by remote services or by the network during call attempts.

NotFoundException

Errors caused by attempts to access missing objects.

UnauthorizedException

Access errors caused by missing user identity (authentication error) or incorrect security permissions (authorization error).

UnknownException

Unknown or unexpected errors.

UnsupportedException

Errors caused by calls to unsupported or not yet implemented functionality.