XRoadLib


XRoadLib

XRoadLib Namespace

TypeDescription
IServiceManager

Handles service oriented tasks based on specific schema definition.

NamespaceConstants

Collection of predefined namespaces used by X-Road message protocol.

PrefixConstants
ServiceDescriptionBuilder

Extracts contract information from given assembly and presents it as service description XML document.

ServiceExecutionOptions
ServiceManager<'THeader>

Manages available services and provides their definitions and serialization details.

XRoadException
XRoadHelper
XRoadWebRequest

Helper methods to initialize X-Road web requests.

XmlTypeConstants

Predefined XML types.

XRoadLib.Attributes Namespace

TypeDescription
XRoadAddContractAttribute
XRoadMergeContentAttribute
XRoadNotesAttribute

Description of the service (for displaying to users).

XRoadRemoveContractAttribute
XRoadServiceAttribute

Defines operation method.

XRoadTechNotesAttribute

Description of the service (for developers).

XRoadTitleAttribute

Title of the service (for displaying to users)

XRoadXmlArrayAttribute

Specifies that the serializer must serialize a particular class member as an array of XML elements.

XRoadXmlArrayItemAttribute

Represents an attribute that specifies the derived types that the serializer can place in a serialized array.

XRoadXmlElementAttribute

Indicates that a public field or property represents an XML element when the serializer serializes or deserializes the object that contains it.

XRoadLib.Events Namespace

TypeDescription
BeforeDeserializationEventArgs

Allows to customize XML reader before deserialization of the X-Road message begins.

XRoadRequestEventArgs

Wraps WebRequest object to be used in event handler.

XRoadResponseEventArgs

Wraps WebResponse object to be used in event handler.

XRoadLib.Extensions Namespace

TypeDescription
AssemblyExtensions
GetValueMethod
ServiceDescriptionExtensions
ServiceMapExtensions

Extension methods for IServiceMap.

SetValueMethod
TypeExtensions
XRoadMessageExtensions

Extension methods for XRoadMessage class.

XRoadRequestExtensions
XmlReaderExtensions

Extension methods for XmlReader class.

XmlWriterExtensions

Extension methods for XmlWriter type.

XRoadLib.Extensions.AspNet Namespace

TypeDescription
ServiceDescriptionHandlerBase
ServiceHandlerBase

Base handler of various X-Road operations.

ServiceRequestHandlerBase
XRoadContext

X-Road context of classical ASP.NET applications.

XRoadMessageExtensions
XRoadRequestExtensions

XRoadLib.Extensions.ProtoBuf.Attributes Namespace

TypeDescription
XRoadProtoBufServiceAttribute

XRoadLib.Extensions.ProtoBuf.Serialization.Mapping Namespace

TypeDescription
ProtoBufServiceMap

Provides protocol buffers serialization/deserialization interface for X-Road operations.

XRoadLib.Headers Namespace

TypeDescription
IXRoadHeader

Describes X-Road message SOAP header elements.

IXRoadHeader<'THeader>
IXRoadHeader20

X-Road message protocol version 2.0 SOAP header elements.

IXRoadHeader31

X-Road message protocol version 3.1 SOAP header elements.

IXRoadHeader40

X-Road message protocol version 4.0 SOAP header elements.

IXRoadIdentifier

Globally unique identifier in the XRoad system. Identifier consists of object type specifier and list of hierarchical codes (starting with code that identifiers the XRoad instance).

XRoadCentralServiceIdentifier

X-Road central service identifier.

XRoadClientIdentifier

X-Road service client identifier.

XRoadCommonHeader
XRoadHeader20

Details of X-Road message protocol version 2.0 header.

XRoadHeader31

Details of X-Road message protocol version 3.1 header.

XRoadHeader40

Implements default X-Road message protocol version 4.0 SOAP header.

XRoadObjectType

Enumeration for XRoad identifier types.

XRoadRepresentedParty

X-Road header extension for represented party messages.

XRoadRequestHash

For responses, this field contains a Base64 encoded hash of the request SOAP message. This field is automatically filled in by the service provider's security server.

XRoadServiceIdentifier

X-Road service identifier.

XRoadLib.Schema Namespace

TypeDescription
AbstractSchemaExporter
ArrayContentDefiniton
ArrayItemDefinition
BinaryMode
CollectionDefinition
ContentDefinition
ContractViolationException
DefaultSchemaExporter

Default schema exporter of X-Road message protocol version 4.0. Generates schema description and serialization logic according to default settings.

Definition
DefinitionState
DocumentationDefinition
EmptyContentDefinition
FaultDefinition

Configuration options for customizing non-technical faults.

HeaderDefinition

Configuration options of X-Road header.

IHeaderDefinitionBuilder<'THeader>

Allows to fluently configure headers mandatory elements.

ISchemaExporter

Provides configuration hooks for customizing contract serialization and definitions.

OperationDefinition

Configurable part of operation.

ParameterRequiredException
ParticleDefinition
PropertyComparer
PropertyDefinition
ProtocolDefinition

Global configuration options for the schema.

RequestDefinition

Specification for individual X-Road message request part.

ResponseDefinition

Configuration options for customizing response elements.

SchemaDefinitionException
SchemaDefinitionProvider

Extracts serialization/definition details from runtime types and methods.

SchemaExporterXRoad20
SchemaExporterXRoad31

Schema exporter for X-Road message protocol version 3.1.

SchemaExporterXRoadLegacy
SingularContentDefinition
TypeDefinition
UnexpectedElementException
UnexpectedValueException
UnknownOperationException
UnknownPropertyException
UnknownTypeException
UnsupportedContentTransferEncodingException
XRoadFaultPresentation

XRoadLib.Serialization Namespace

TypeDescription
CustomSerialization
IAttachmentManager
ICustomSerialization
ISerializer

Handles runtime operations for schema definition.

IXRoadFault
IXRoadFilterMap
IXRoadSerializable
IXRoadXmlSerializable
InvalidQueryException

Describes everything that is wrong with current X-Road request message.

Serializer
StringSerializationMode

Specifies how string values with special characters should be handled.

XRoadAttachment

Binary content of X-Road messages.

XRoadEncoding
XRoadFaultException
XRoadFilterMap<'T>
XRoadMessage

Deserialized content of X-Road message (input or output).

XRoadMessageWriter
XRoadSerializable

XRoadLib.Serialization.Mapping Namespace

TypeDescription
AbstractTypeMap
AllTypeMap<'T>
ArrayTypeMap<'T>
BooleanTypeMap
CompositeTypeMap<'T>
ContentTypeMap
DateTimeTypeMap
DateTypeMap
DecimalTypeMap
DoubleTypeMap
EnumTypeMap
IAbstractTypeMap
IArrayTypeMap
ICompositeTypeMap
IContentTypeMap
IPropertyMap
IServiceMap

Provides serialization/deserialization interface for X-Road operations.

ITypeMap
Int16TypeMap
Int32TypeMap
Int64TypeMap
IntegerTypeMap
ListMethodsServiceMap
OptimizedContentTypeMap
PropertyMap
SequenceTypeMap<'T>
ServiceMap
SingleTypeMap
StringTypeMap

Serialization/deserialization details of string type.

TestSystemServiceMap
TypeMap

XRoadLib.Serialization.Template Namespace

TypeDescription
IXmlTemplate
IXmlTemplateNode
XRoadXmlSchemaTemplate
XRoadXmlTemplate

XRoadLib.Soap Namespace

TypeDescription
ClientFaultCode
FaultCode
ISoapFault
ServerFaultCode
SoapFaultException
SoapMessageHelper

XRoadLib.Styles Namespace

TypeDescription
DocLiteralStyle
RpcEncodedStyle
Style

X-Road message serialization style.

XRoadLib.Wsdl Namespace

TypeDescription
Binding
DocumentableItem
InputBinding
Message
MessageBinding
MessagePart
MimeContentBinding
MimeMultipartRelatedBinding
MimePart
NamedItem
Operation
OperationBinding
OperationInput
OperationMessage
OperationOutput
OutputBinding
Port
PortType
Service
ServiceDescription
ServiceDescriptionFormatExtension
SoapAddressBinding
SoapBinding
SoapBindingStyle
SoapBindingUse
SoapBodyBinding
SoapHeaderBinding
SoapOperationBinding
Types
XRoadAddressBinding
XRoadOperationVersionBinding
XRoadTitleBinding
Fork me on GitHub