scalaxb

scalaxb 1.12.5

Thu, 03 Sep 2026 04:58:01 +0000

updates

fix: Parse named xs:anyType elements by name by @thijsnissen in #718

scalaxb 1.12.4

Sat, 11 Oct 2025 05:38:43 +0000

bug fixes

fix: Fixes generated code on Scala 3 by @mrdziuban in #697
fix: Adds the ability to specify --jaxb-package that was missing for mvn-scalaxb by @lciolecki in #699

scalaxb 1.12.3

Mon, 08 Sep 2025 03:54:54 +0000

sbt 2.x migration

sbt-scalaxb 1.12.3 is cross published to sbt 1.x and 2.x.

Cross build to sbt 2.0.0-M4 by @eed3si9nin #686
Cross build to sbt 2.0.0-RC3 by @xuwei-k in #691
Cross build to sbt 2.0.0-RC4 by @eed3si9n in #693
refactor: Use new wildcard syntax by @xuwei-k in #687

updates

deps: Update Log4j from 1.2.17 to 2.24.3 by @urwithsumit in #681
fix: Fixes Dispatch 2.x support by @urwithsumit in #682

scalaxb 1.12.2

Thu, 06 Feb 2025 04:49:30 +0000

scalaxb 1.12.2 is released

updates

scalaxb 1.12.2 adds support for Dispatch 2.x, contributed by @urwithsumit in #677

scalaxb 1.12.1

Sun, 25 Aug 2024 03:46:12 +0000

scalaxb 1.12.1 is released.

Scala 3 compatibility improvements

Continuing the theme from scalaxb 1.12.0, scalaxb 1.12.1 improves the code generation for Scala 3. In #654 Matt Dziuban contributed a fix to stop passing in an implicit parameter explicitly, which started to fail to compile on Scala 3.5.0 without using marker.

In #661 @eed3si9n further improved the Scala 3 compatibility enough to pass -Xfatal-warnings with basic usages on LTS Scala 3.3.3 and non-LTS Scala 3.5.0:

Passing sequence to a vararg was changed from xs: _* to xs*
Self type with refinement was changed from self: A with B => to self: A & B =>
Added indentations where there were an offside “Line is indented too far to the left” warning
Rewrote some infix usages like value startsWith "{" to Java-style value.startsWith("{") notation
Variable initialization was changed from _ to Java-style null
Wildcard type argument was changed from _ to ?

Full release note is at https://github.com/eed3si9n/scalaxb/releases/tag/v1.12.1

scalaxb 1.12.0

Sat, 02 Dec 2023 04:22:21 +0000

scalaxbJaxbPackage

scalaxb 1.12.0 supports choosing javax or jakarta for jaxb package name

Compile / scalaxbJaxbPackage := JaxbPackage.Jakarta

This was contributed by @mrdziuban in #613

updates

Updates Monocle by @xuwei-k in #612
Adds Scala 3 build setting by @xuwei-k in #623
Uses ClassTag instead of Manifest by @xuwei-k in #608

new contributors

@xuwei-k made their first contribution in #612

scalaxb 1.11.1

Sat, 24 Jun 2023 23:51:38 +0000

updates

Fixes soap12_tagless template for Scala 3 by @zarthross in #600
Fixes soap11_tagless template for Scala 3 by @ebar in #602
Adds support for http4s 0.22.x client generation - httpclients_http4s_0_22.scala.template by @kevin-lee in #601

new contributors

@kevin-lee made their first contribution in #601
@ebar made their first contribution in #602

Full Changelog: https://github.com/eed3si9n/scalaxb/compare/v1.11.0...v1.11.1

scalaxb 1.11.0

Sun, 26 Feb 2023 19:09:23 +0000

http4s client + tagless final style

scalaxb 1.11.0 adds support for http4s client generation.

ThisBuild / organization  := "com.example"
ThisBuild / version := "0.1.0-SNAPSHOT"
ThisBuild / scalaVersion := "2.13.10"
ThisBuild / scalaxbPackageName := "generated"
ThisBuild / scalaxbGenerateDispatchClient := false
ThisBuild / scalaxbGenerateHttp4sClient := true

lazy val scalaXml = "org.scala-lang.modules" %% "scala-xml" % "2.1.0"
lazy val scalaParser = "org.scala-lang.modules" %% "scala-parser-combinators" % "2.2.0"
lazy val jaxbApi = "javax.xml.bind" % "jaxb-api" % "2.3.0"
lazy val emberClient= "org.http4s" %% "http4s-ember-client" % "0.23.18"

lazy val root = (project in file("."))
  .enablePlugins(ScalaxbPlugin)
  .settings(
    name := "soap",
    libraryDependencies ++= Seq(scalaXml, scalaParser, jaxbApi, emberClient),
  )

This was contributed by Darren Gibson (@zarthross) in #596.

scalaxb 1.9.1

Sat, 11 Feb 2023 19:17:04 +0000

updates

Adds Scala 3 support by enumerating transitive self types in the generated code by @fthomas in #595

new contributors

@danielchen2 made their first contribution in #594
@fthomas made their first contribution in #595

Full Changelog: https://github.com/eed3si9n/scalaxb/compare/v1.9.0...v1.9.1

scalaxb 1.9.0

Fri, 11 Nov 2022 21:27:20 +0000

updates

Updates scala-xml to 2.x, and scala-parser-combinators to 2.x on Scala 2.13 #589 by @mrdziuban
Fixes type mismatch in scalaxb.scala #584 by @bodduv

quick start

$ sbt new eed3si9n/scalaxb.g8

scalaxb 1.8.3

Sun, 02 Jan 2022 05:24:14 +0000

Fixes handling of complexType named package by @eed3si9n in #581
Adds Coursier instructions by @chadselph in #571
Fixes some easy warnings by @eed3si9n in #582

scalaxb 1.8.2

Sat, 25 Sep 2021 22:40:19 +0000

scalaxb 1.8.1

Sun, 07 Mar 2021 01:24:59 +0000

scalaxb 1.8.0

Fri, 04 Sep 2020 13:35:41 +0000

scalaxb 1.7.5

Sun, 28 Jun 2020 04:58:17 +0000

Populates xsi:type attribute on toXML(...) #518 by @abestel
Adds scalaxbUseLists setting to generate List[A] instead of Seq[A] #526 by @pgrandjean
Fixes code generation to avoid multi-arg infix syntax #531 by @margussipria
Splits generated fromString method for big enums that would otherwise not compile #517 by @LolHens

scalaxb 1.7.3

Sun, 22 Sep 2019 04:41:39 +0000

enhancement

Scala 2.13 support #514 by @jtjeferreira

bug fix

Fixes the handling of attributes declared as sequences #512 by @abestel

scalaxb 1.7.2

Mon, 26 Aug 2019 08:52:42 +0000

bug fix

Fixes big decimal formatting in toXML according to XML Schema #505 by @tOverney

scalaxb 1.7.1

Sat, 16 Mar 2019 18:05:37 +0000

bug fixes

Fixes big decimal formatting according to XML Schema #483 by @danslapman
Fixes equals called on a String and Option[String] #485 by @lespea
Fixes one-way SOAP call #493 by @danslapman

scalaxb 1.7.0

Sun, 09 Sep 2018 11:12:06 +0000

breaking changes

ExecutionContext parameter is added to all methods returning Future[A], instead of hardcoding a execution context. #482 inspired by #407.

Starting scalaxb 1.7.0, an explicit import of ExecutionContext would be required as follows:

import scala.concurrent.ExecutionContext.Implicits._

symbol encoding strategy and capitalization

scalaxb 1.7.0 adds option to encode symbols.

  lazy val scalaxbCapitalizeWords  = settingKey[Boolean]("Attempts to capitalize class and attribute names to match the CamelCase convention")
  lazy val scalaxbSymbolEncodingStrategy = settingKey[SymbolEncodingStrategy.Value]("Specifies the strategy to encode non-identifier characters in generated class names")

  object SymbolEncodingStrategy extends Enumeration {
    val Discard = Value("discard")
    val SymbolName = Value("symbol-name")
    val UnicodePoint = Value("unicode-point")
    val DecimalAscii = Value("decimal-ascii")
    val Legacy151 = Value("legacy-1.5.1")
  }

#461 by @hosamaly

other enhancements

Handle multiple faults #438 by @SupraFii
Adds support for enum values list #446 by @bbarker
Supports Dispatch versions from 0.11.4 to 0.14.x #468 by @margussipria
Generates a default value for class parameters of anyAttribute #470 by @hosamaly
scala-xml 1.1.0 and scala-parser-combinators 1.1.0 #476 by @sullis
Uses sealed traits for enums #479 by @mrdziuban
Adds config option for setting scalaxbEnumNameMaxLength for enum name length #480 by @mrdziuban

bug fixes

Don’t throw exception on http status code != 200 to allow Fault parsing #444 by @alexdupre
Fixes Soap11Fault bug when empty detail #450 by @dportabella

scalaxb 1.5.2

Tue, 04 Jul 2017 04:59:30 +0000

enhancements

Adds support for Gigahorse 0.3 and different backends (OkHttp and AHC) #428 by @alexdupre

bug fixes

Splits fromAnySchemaType into smaller chunks to work around JVM code size limit. #429 by @fltt

scalaxb 1.5.1

Fri, 10 Mar 2017 02:48:52 +0000

bug fixes

Replaces trailing underscore with "u93". #415 by @varnerac
Fixes BigDecimal formatting. #417 by @coutoPL

enhancements

Adds Gigahorse support. #413 by @alexdupre
Adds Scala 2.12 cross building. #413/#419 by @alexdupre and @dwijnand

sbt-scalaxb 1.4.x

Mon, 31 Oct 2016 17:32:36 +0000

This page describes adding scalaxb task to your sbt project. (The page describing sbt-scalaxb for sbt 0.7 is moved)

automate using `g8`

The following steps has been scripted into a giter8 template called eed3si9n/scalaxb.g8. For a quick project, run the following after installing giter8.

$ g8 eed3si9n/scalaxb

After asking you for a project name, the above sets up a nearly empty sbt project with sbt-scalaxb pre-installed. A convenient method to start using scalaxb.

scalaxb 1.5.0

Mon, 31 Oct 2016 04:38:05 +0000

breaking changes

Fixes name clashes in typeclass intance by prefixing full package name. #385 by @anatoliykmetyuk
The default value for using varargs is set to false.
sbt-scalaxb is now an auto plugin. See below.

bug fixes

Fixes SOAP operations which use multiple implicit headers. #380 by @joshlreese
Fixes SOAP header values composition. #381 by @coutoPL
Fixes SOAP header parts code generation. #400 by @jankeesvanandel
Fixes enum name conflicts. #386 by @anatoliykmetyuk
Fixes enum parsing, for example 00 in xsd:byte. #388 by @anatoliykmetyuk

enhancements

Adds --mutable option to generate mutable case classes. See below.
Uses type attribute to convert xs:any. #389 by @anatoliykmetyuk
Adds --autopackages option to pick package names automatically. #391 by @anatoliykmetyuk
Adds --visitor option to generate a Visitor for traversing over the generated case classes. #392 by @anatoliykmetyuk

sbt-scalaxb changes

sbt-scalaxb for scalaxb 1.5.0 is changed to an auto plugin. Instead of adding scalaxbSettings and defining sourceGenerators in Compile, enable ScalaxbPlugin instead. All other setting/task keys will be prefixed with “scalaxb”. For example, packageName will now be called scalaxbPackageName.

Before:

import ScalaxbKeys._
lazy val root = (project in file(".")).
  settings(
    name := "foo-project").
  settings(scalaxbSettings).
  settings(
    sourceGenerators in Compile += (scalaxb in Compile).taskValue,
    packageName in (Compile, scalaxb) := "generated"
    // packageNames in (Compile, scalaxb) := Map(uri("http://something/") -> "something"),
    // logLevel in (Compile, scalaxb) := Level.Debug
  )

After:

lazy val root = (project in file(".")).
  enablePlugins(ScalaxbPlugin).
  settings(
    name := "foo-project",
    scalaxbPackageName in (Compile, scalaxb) := "generated"
    // scalaxbAutoPackages in (Compile, scalaxb) := true
  )

#405 by @eed3si9n

mutable case class

scalaxb 1.5.0 adds an option to generate mutable case classes.

case class Address(var name: String,
  var street: String,
  var city: String)

In sbt-scalaxb, this can be enabled as:

lazy val root = (project in file(".")).
  enablePlugins(ScalaxbPlugin).
  settings(
    name := "foo-project",
    scalaxbPackageName in (Compile, scalaxb) := "generated",
    scalaxbGenerateMutable in (Compile, scalaxb) := true
  )

#390 by @AndreVanDelft

contributors

Huge thanks to everyone who has helped to improve scalaxb by sending pull requests and reporting bugs!

According to git shortlog -sn --no-merges 1.4.1..release/1.5.0, the following people contributed to this release: Anatoliy Kmetyuk (@anatoliykmetyuk), Eugene Yokota (@eed3si9n), Andre Van Delft (@AndreVanDelft), Jan-Kees van Andel (@jankeesvanandel), Joshua Reese (@joshlreese), and Mateusz Kołodziejczyk (@coutoPL).

scalaxb 1.4.1

Sun, 17 Jul 2016 22:37:00 +0000

breaking changes

Adds Dispatch 0.11.3 support, and defaultDispatchVersion is bumped up to it. #352 by @DustinChaloupka

fixes

Fixes handling of implicit and explicit SOAP headers. #366 by @coutoPL

who is using scalaxb?

Mon, 20 Jul 2015 06:44:09 +0000

Here’s a list of users who are using scalaxb, or have at some point.

Banno

scalaxb preso

Non-blocking SOAP feature was also contributed by @hoff2 from Banno.

Klout

Scoozie: Creating Big Data Workflows at Klout

Additionally, we would like to provide a shout-out to a great open-source project, scalaxb, an sbt plugin that takes .xsd files and creates matching Scala case classes. Scoozie populates these case classes, which are then automatically converted to XML by scalaxb. This plugin saved a lot of headache in the actual process of conversion to XML.

Novus

Dispatch forms the foundation of an in-house SOAP client at Novus together with scalaxb. Thanks to these tools our standard response to “Can you do SOAP?” is “Bring it on!” instead of “Ew, what’s this on my shoe?!”

VMWare vCloud

Using Salat with scalaxb generated classes:

scalaxb generates Scala case classes from XSDs and generates supporting helpers for going back and forth from case class to XML. Salat provides an interface to MongoDB based on case classes.

There are a couple hurdles, but both project owners have taken our suggestions seriously, and have smoothed out quite a few bumps.

scalaxb 1.4.0

Mon, 20 Jul 2015 05:32:04 +0000

SOAP/REST changes

Adds requestTimeout and connectionTimeout to DispatchHttpClients. #304 by @eed3si9n
Adds --no-dispatch-client option (generateDispatchClient := false). #322 by @liff
Adds --dispatch-as option (generateDispatchAs := true) for Dispatch’s Http(request > as.scalaxb[A]) support. #332 by @arkadius

other enhancements

Adds --ignore-unknown option (ignoreUnknown := true) to ignore unknown XML elements, as well as order in which they are arrived. #310 by @jet-black
Adds --no-varargs option to use Seq instead of the varargs. #292/#309 by @lbruand and @Erwan56
Improves handling of duplicate enumeration values. #308 by @donderom
Refactors configuration into a sequence of case classes. #342 by @eed3si9n

bug fixes

Fixes namespace duplication. #310/#291/#298 by @jet-black
Fixes Windows filename and path handling for the CompilerMatcher. #307 by @joescii

compiler warnings

The code generated by scalaxb 1.4.0 should no longer generate compiler warnings.

Adds SIP-18 imports to the generated code. #294 by @carl297r
Removes “adapting argument list” and other compiler warnings from the generetad code. #321 by @liff
Removes compiler warnings from the scalaxb code. #335 by @justjoheinz
Removes postfix usages in the generated code.
Adds -Xfatal-warnings during the integration tests. #343 by @eed3si9n

contributors

A huge thanks to everyone who has helped to improve scalaxb by reporting bugs and sending pull requests!

According to git shortlog -sn --no-merges 1.3.0..release/1.4.0 ten people contributed to this release: Eugene Yokota (@eed3si9n), @jet-black, Olli Helenius (@liff), Lucas Bruand (@lbruand), Markus Klink (@justjoheinz), Carl Livermore (@carl297r), Arek Burdach (@arkadius), Joe Barnes (@joescii), @Erwan56, Roman Parykin (@donderom).

scalaxb 1.3.0

Fri, 07 Nov 2014 06:02:40 +0000

breaking changes

Dropping SOAP RPC/encoded support.
Makes SOAP faultactor a String. #268 by @rubbish
Generates >22 case classes by default. #280
Generates attributes field to handle all attributes. #286

SOAP changes

Fixes the handling of message parts involving headers. #285 by @plaflamme
Fixes nillable fault support. #284
Makes http instances lazy. #279 by @rubbish
Implements toString methods for faults. #278

case class >22 and attributes change

Starting scalaxb 1.3.0, the generated code will be >22 by default. In addition, all attributes will be handled via attributes field.

To bring back the older behavior:

contentsSizeLimit in (Compile, scalaxb) := 20

namedAttributes in (Compile, scalaxb) := true

Related, 1.3.0 fixes attribute’s default value handling #288.

scalaxb with Scala 2.11

Thu, 14 Aug 2014 19:56:26 +0000

Starting scalaxb 1.2.0 it supports Scala 2.11.x. Since Scala 2.11 modularizes XML and parser combinators, it requires additional setup on your part. Here’s using sbt 0.13’s multi-project build.sbt syntax:

import ScalaxbKeys._

lazy val scalaXml = "org.scala-lang.modules" %% "scala-xml" % "1.0.2"
lazy val scalaParser = "org.scala-lang.modules" %% "scala-parser-combinators" % "1.0.1"
lazy val dispatchV = "0.11.2" // change this to appropriate dispatch version
lazy val dispatch = "net.databinder.dispatch" %% "dispatch-core" % dispatchV

lazy val root = (project in file(".")).
  settings(scalaxbSettings: _*).
  settings(
    name := "hello",
    organization := "com.example",
    scalaVersion := "2.11.1",
    libraryDependencies ++= Seq(scalaXml, scalaParser, dispatch),
    packageName in (Compile, scalaxb) := "com.paperstreet",
    packageNames in (Compile, scalaxb) := Map(uri("http://schemas.microsoft.com/2003/10/Serialization/") -> "microsoft.serialization"),
    dispatchVersion in (Compile, scalaxb) := dispatchV,
    async in (Compile, scalaxb) := true,
    sourceGenerators in Compile <+= scalaxb in Compile
    // logLevel in (Compile, scalaxb) := Level.Debug    
  )

scalaxb 1.2.1

Sun, 06 Jul 2014 01:44:54 +0000

This is a bug fix release focused on fixing the SOAP code generation. See using SOAP for more details.

SOAP bug fixes

Fixes xs:AnyType handling. #265
Fixes asFault not Throwable error. #264 reported by @romainreuillon
Fixes the generated code for multipart SOAP message. #267 reported by @tomhaigh
Fixes the definition of HttpClientsAsync to use concurrent.Future. #269 reported by @hedefalk
Adds --blocking command line option to generate blocking SOAP client.

minor enhancements

Masks scalaxb package that’s used internally to generate code.

scalaxb 1.2.0

Sun, 15 Jun 2014 01:14:57 +0000

non-blocking SOAP

scalaxb 1.2.0 generates non-blocking SOAP code by default. Instead of Either[X, A], the SOAP call returns Future[A] and the fault, if any, is thrown as Future’s failure semantics.

// default
def getQuote(symbol: Option[String]): Future[stockquote.GetQuoteResponse]

// async in (Compile, scalaxb) := false
def getQuote(symbol: Option[String]): Either[scalaxb.Fault[Any], stockquote.GetQuoteResponse]

This feature was contributed by @jlavallee and @hoff2 as #213/#259. See using soap for more details.

SOAP bug fixes

Escapes reserve words appearing as a parameter in SOAP. #252/#256 contributed by @romainreuillon
Escapes reserve words appearing as an operation name in SOAP. #241 reported by @rcgoodfellow
Fixes handling of nillable elements appearing in SOAP. #229 reported by @barnesjd
Fixes string encoding problems while posting SOAP. #231 reported by @hedefalk
Supports Dispatch 0.11.1.
Fixes response parsing for literal RPC style. #260 reported by @romainreuillon

bug fixes and minor enhancements

Drops Scala 2.9.0 and removing deprecated warnings.
Caches DatatypeFactory instance to ThreadLocal. #243 contributed by @malaporte
Fixes handing of zero-length prefix. #253/#255 contributed by @romainreuillon
Fixes mixed attribute not being inherited when extending a complex type. #228 reported by @choffmeister
Fixes non-terminating parser when unbounded is nested. #230 reported by @FranklinChen
Fixes handling of xs:element with default with minOccurs = 1. #245 reported by @alboko
Fixes handling of very long xs:enumeration value. #247 reported by @jcranky
Fixes handling of xs:element names with symbols when --class-prefix is passed. #251 reported by @romangarcia
Fixes xs:group parser getting inherited twice. #238 reported by @choeger

scalaxb 1.1.2

Mon, 26 Aug 2013 00:28:08 +0000

bug fixes and minor enhancements

Fixes blank xs:enumeration value generating broken case object. #220 reported by @FranklinChen and others.
Fixes generated field for an attribute named value conflicting with the value field for xs:simpleContent. #221 reported by @lyle-janrain

scalaxb 1.1.1

Wed, 17 Jul 2013 03:24:04 +0000

breaking change to commandline

scalaxb cli used -p and --package to specify both the default package name and namespace-specific package names. scalaxb 1.1.1 uses -p and --default-package for the default package; and --package for namespace-specific package names.

bug fixes and minor enhancements

Avoids type names that only differs in case. #215 reported by @drdozer
Fixes handling of xs:all with minOccurs=0 and nillable. #216 reported by @minettiandrea
Fixes xsi:nil="1" not parsed as nil. #217 reported by @aoprisan
Improves handling of chameleon schema. #102
Configures dispatchVersion to 0.10.1 by default.
Updates sbt-scalaxb for sbt 0.13.

scalaxb 1.1.0

Tue, 30 Apr 2013 05:59:04 +0000

breaking changes

scalaxb now generates sys.error, so the generated code will no longer be compilable under Scala 2.8. #115 reported by @idot and others.

dispatchVersion

A new key dispatchVersion was added to generate Dispatch 0.10.x compatible code #210:

dispatchVersion in scalaxb in Compile := "0.10.0"

libraryDependencies <+=(dispatchVersion in scalaxb in Compile) { dv =>
  "net.databinder.dispatch" %% "dispatch-core" % dv
}

bug fixes and minor enhancements

Includes offending data in ParserFailure message. #206 requested by @caoilte
Fixes handling of QName enums. #208
sbt-scalaxb sorts *.xsd to avoid platform variance. #207 reported by @caoilte
sbt-scalaxb generates code only when the xsd files are modified. #199 requested by @fommil

scalaxb 1.0.2

Mon, 25 Mar 2013 01:56:33 +0000

bug fixes

Fixes handling of large groups. #188 reported by @workingDog
Fixes handling of xs:any with namespace constraints. #189
Removes upper limit on duplicate name resolution. #190
Fixes handling of enum values that are symbols. #191
Fixes xs:group references naming conflict. #192
Fixes handling of xs:choice that’s made up of a foreign type. #193
Fixes handling of split xs:sequence whose only item is nillable and unbounded. #194
Fixes handling of xs:choice that includes a substitution group. #195
Fixes handling of complex types containing foreign xs:sequence. #196
Fixes handling of xs:group or a mixed complex type that includes an optional substitution group. #197
Fixes handling of complex types that directly or indirectly derives from xs:anySimpleType. #200/#203 reported by @sagarcjoshi
Fixes handling of mixed complex type that extends simple type. #205
Fixes DispatchHttpClients not handling non-200 results. reported and fixed by @dportabella in #204

scalaxb 1.0.1

Thu, 24 Jan 2013 03:55:11 +0000

bug fixes and minor enhancements

Trims URIs. #185 contributed by @colinrgodsey

scalaxb 1.0.0

Fri, 21 Dec 2012 05:34:17 +0000

This is the first stable release of scalaxb. Thanks to many people who tried it out, reported bugs, and contributed ideas and code.

breaking changes since 0.7

Some changes were made to adapt to Scala 2.10.0.

To avoid implicit conflict, the scalaxb package object no longer extends XMLStandardTypes.
scalaxb.XMLStandardTypes object was added to support explicitly importing implicits.
HexBinary class and Base64Binary class’s toIndexedSeq method is now a field named vector.
The default http client for SOAP binding is upgraded to Dispatch 0.9.5.

bug fixes and minor enhancements

Fixes typo in element form check (“qualified”) #168. Fixed by @mprihoda
More lenient handling of base64Binary encoding #173. Requested by @nmccready
Fixes generated code for named groups containing nillable choices #162. Reported by @rajish
Fixes attribute merging across namespace #174. Reporetd by @sbrownyarris
Fixes handling of chameleon schemas #176. Reported by @Marza
Fixes grandchildren types missing from generated XMLFormat of traits #178. Reported by @kidasoft
Fixes xs:boolean parsing #179. Fixed by @rssh

scalaxb 1.0.0-RC3

Mon, 10 Dec 2012 05:39:22 +0000

bug fixes and minor enhancements

Fixes generated code for named groups containing nillable choices. #162 reported by @rajish
Fixes attribute merging across namespace. #174 reporetd by @sbrownyarris
Fixes handling of chameleon schemas. #176 reported by @Marza
Fixes grandchildren types missing from generated XMLFormat of traits. #178 reported by @kidasoft

scalaxb 1.0.0-RC2

Sun, 11 Nov 2012 20:58:51 +0000

bug fixes and minor enhancements

More lenient handling of base64Binary encoding. #173. Requested by @nmccready

scalaxb 1.0.0-RC1

Tue, 23 Oct 2012 00:18:04 +0000

This is a release candidate for the first stable release of scalaxb.

breaking changes since 0.7

Some changes were made to adapt to Scala 2.10.0-RC1.

To avoid implicit conflict, the scalaxb package object no longer extends XMLStandardTypes.
scalaxb.XMLStandardTypes object was added to support explicitly importing implicits.
HexBinary class and Base64Binary class’s toIndexedSeq method is now a field named vector.
The default http client for SOAP binding is upgraded to Dispatch 0.9.2.

bug fixes and minor enhancements

Fixes typo in element form check (“qualified”) #168. Fixed by @mprihoda

scalaxb 0.7.3

Wed, 15 Aug 2012 04:37:20 +0000

bug fixes

Fixes logger formatting #166. reported by @psnively

scalaxb 0.7.2

Thu, 26 Jul 2012 05:24:53 +0000

new logger

@martiell contributed a log4j wrapper that replaces logula. #161. The main change is that our resolver is down to Sonatype:

resolvers += "sonatype-public" at "https://oss.sonatype.org/content/groups/public"

bug fixes and minor enhancements

Adds support for resolving SOAP encoding hrefs. #160. reported by @greenrd
Fixes xsi:type attribute wiping out other attributes due to SI-5843 #159. reported by @psnively
Fixes reserve word escaping when names contain trailing whitespaces. #163. reported by @dohzya

scalaxb 0.7.1

Fri, 18 May 2012 05:31:34 +0000

bug fixes and minor enhancements

Fixes RPC style soap. #153
Fixes generated code for imported groups. #156

scalaxb 0.7.0

Mon, 26 Mar 2012 01:16:55 +0000

Additional resolvers required

The logger is changed to logula. For sbt-scalaxb, additional resolvers are now required:

resolvers ++= Seq(
  "sonatype-public" at "https://oss.sonatype.org/content/groups/public",
  "repo.codahale.com" at "http://repo.codahale.com")

addSbtPlugin("org.scalaxb" % "sbt-scalaxb" % "0.7.0")

bug fixes and minor enhancements

Fixes inner simple types being detected as duplicates. #136 reported by @bampoosa
Adds a few missing settings to sbt-scalaxb. #144 reported by @devinus
Fixes xs:any namespace attribute not defaulting to ##any. #147 reported by @champloo
Fixes soap 1.2 output wrapper. #143
Fixes handling of wsdl with mixed complex type. #149 reported by @jcranky
Fixes handling of wsdl with header outputs. #150 reported by @jcranky

mvn-scalaxb

mvn-scalaxb was updated by @martiell
Updated for deployment to Sonatype open source repository hosting.
M2E 1.1 compatible: no longer requires an m2e connector plugin or lifecycle mapping metadata in the pom.xml when used with m2eclipse 1.1.
Don’t swallow stack traces when propagating exceptions from scalaxb.

multiple configs

Tue, 06 Mar 2012 05:00:46 +0000

A few people have asked me on how to configure a sbt build so scalaxb can be used multiple times, so let’s take a look. Here’s the code:

$ git clone -b multipleconfigs git://github.com/eed3si9n/scalaxb-sample.git
$ cd scalaxb-sample/multipleconfigs/

Now open the directory using your favorite editor.

In src/ we have main/scala/main.scala, main/xsd/ipo.xsd, and main/xsd/w.xsd.

when to go multiple configs?

With the single config approach, the xmlprotocol.scala contains the typeclass instances for all schemas. It’s currently necessary to compile all referenced schemas together, so normally that’s the route you should take.

scalaxb 0.6.8

Wed, 01 Feb 2012 06:48:01 +0000

bug fixes and minor enhancements

Fixes handling of cross-namespace extension. #135 reported by @psnively
Fixes parsing to reject extra elements at the end. #124
Relaxes wsdl parsing to handle out-of-order wsdls. #87
wsdl generates baseAddress as a def. #134 by @hedefalk

scalaxb 0.6.7

Thu, 22 Dec 2011 02:17:34 +0000

bug fixes and minor enhancements

Adds support for merging duplicate simple types. #116 reported by @OlegYch
Fixes substitution group parsing. #119 reported by @bmjsmith and #133 reported by @psnively
Fixes DataRecord equality. #120 reported by @deanhiller
Fixes package name of wsdl generated file. #117 reported by @hedefalk and @OlegYch
Fixes handling of empty input messages in wsdl. #122 reported by @hedefalk
Fixes handling of varg parameters in wsdl generated file. #125 reported by @hedefalk
Fixes simultaneous use of soap 1.1 and soap 1.2. #130 reported by @ben-manes
Fixes wsdl protocol package name.

issue reporting guideline

Sat, 12 Nov 2011 07:20:26 +0000

Effective bug reports are more likely to be fixed. These guidelines explain how to write such reports.

preliminaries

Make sure your software is up to date.
Search github issues to see whether your bug has already been reported.
Open one case for each problem.
Proceed to the next steps for details.

where to file a bug report

For most of the issues you encounter using scalaxb, use GitHub issues to report bugs.
If it’s more of an open question, enhancement idea, or an interesting issue, bring it up to GitHub Discussions or Google Group.
If it’s sensitive material, send me a email (eed3si9n at gmail) clearly stating that it’s a sensitive material.

Google Group is for general discussions and announcements concerning scalaxb.

scalaxb 0.6.6

Sat, 12 Nov 2011 01:19:31 +0000

bug fixes and minor enhancements

scalaxb changes were made by @eed3si9n
Fixes generated default scope by adding back the default namespace. #91 reported by @martiell
Fixes toXML handling of xs:anyAttribute. #95 reported by @deanhiller
Fixes generated defaultScope when the schema is unqualified. #97 reported by @deanhiller
Fixes xs:any repeating namespace bindings by merging them. #98 reported by @deanhiller
Fixes handling of xs:any with namespace="##local". #101 reported by @deanhiller
Adds --lax-any to ignore xs:any’s namespace constraint. #103 requested by @deanhiller
Adds --version to display help message. #106 requested by @deanhiller
Adds --attribute-prefix to prefix parameters mapping an attribute. #92 reported by ido
Adds handling of xs:include without targetNamespace. #102 reported by @berntan
Adds handling of locally declared namespace binding. #105 reporetd by gerri
Fixes round trip of parsed QName. #114
Adds default argument to optional, multiple, and nillable params. #113 requested by @OlegYch

Fixes handling of wsdl when soap bindings is not the first element. #104
Adds handling of soap messages with attributes. #99 reported by @berntan
Adds handling of soap messages with soap headers. #100 reported by @berntan
sbt-scalaxb and mvn-scalaxb processes wsdl first.
Fixes handling of wsdl with empty messages. #93 reported by @mbroue
Fixes handling of rpc-style return message on soap 1.1. #94 reported by @dkhenry

mvn-scalaxb

mvn-scalaxb was updated by @martiell
Fixes processing order. #110 reported by @hedefalk
Fixes package mappings. #111 reporetd by @hedefalk

sbt-scalaxb

Sun, 09 Oct 2011 09:00:00 +0000

This page describes sbt-scalaxb for scalaxb 1.5.0 and above. See the following for older versions:

automate using `sbt new`

The following steps has been scripted into a giter8 template called eed3si9n/scalaxb.g8. For a quick project, run the following after installing sbt 0.13.13+.

$ sbt new eed3si9n/scalaxb.g8

After asking you for a project name, the above sets up a nearly empty sbt project with sbt-scalaxb pre-installed. A convenient method to start using scalaxb.

scalaxb 0.6.5

Sat, 08 Oct 2011 22:21:35 +0000

breaking changes

In an effort to solve namespace conflicts and to increase consistency among the plugins, sbt plugins best practices was created. Here are the changes based on its recommendations:

keys are under `ScalaxbKeys` object

Keys provided by sbt-scalaxb now resides in ScalaxbKeys object. Place the following at the top of your build.sbt:

import ScalaxbKeys._

Scala identifiers for the keys remain the same (e.g. packageName), but key names accessible from the shell are now prefixed with scalaxb- (e.g. scalaxb-package-name).

settings are scoped under `scalaxb` task

scalaxb-specific settings are now scoped under scalaxb task. The default settings scalaxbSettings is scoped additionally by Compile configuration (no moreScalaxb configuration!).

seq(scalaxbSettings: _*)

packageName in scalaxb in Compile := "ipo"

sourceGenerators in Compile <+= scalaxb in Compile

If you wish to use scalaxb task multiple times in a project, you can do so by creating custom configurations in build.scala.

val Xsd = config("xsd") extend(Compile)
val Wsdl = config("wsdl") extend(Compile)
lazy val appSettings = buildSettings ++
  inConfig(Xsd)(baseScalaxbSettings ++ inTask(scalaxb)(customScalaxbSettings("xmlschema"))) ++
  inConfig(Wsdl)(baseScalaxbSettings ++ inTask(scalaxb)(customScalaxbSettings("wsdl11")))

def customScalaxbSettings(base: String): Seq[Project.Setting[_]] = Seq(
  sources <<= xsdSource map { xsd => Seq(xsd / (base + ".xsd")) },
  packageName := base,
)

bug fixes and minor enhancements

Fixes namespace binding conflict. #84 reported and fixed by jxstanford
Fixes anyType support in wsdl. #88 reported by radirk
Fixes SOAPAction header in wsdl.
Fixes Fault handling in wsdl.
Uses Logback internally for logging.

scalaxb 0.6.4

Mon, 12 Sep 2011 07:33:25 +0000

bug fixes and minor enhancements

Fixes sbt-scalaxb. #83
Fixes QName parsing to resolve URI. #82

scalaxb 0.6.3

Tue, 06 Sep 2011 02:45:14 +0000

bug fixes and minor enhancements

Fixes xs:gMonthDay support. #74
Fixes substitution group parsing. #79 reported by @jxstanford
Fixes SOAP 1.2 Content-Type HTTP header. #80
Adds RPC-style SOAP message support. #77
Changes the default protocol file name to xmlprotocol.scala.
Adds --protocol-file and --protocol-package option. #76
Duplicated types are now ignored. #78 requested by @timperrett

scalaxb 0.6.2

Thu, 28 Jul 2011 07:27:41 +0000

sbt-scalaxb for sbt 0.10.1

To call scalaxb from sbt 0.10.1, put this in your project/plugins/build.sbt:

libraryDependencies <+= (sbtVersion) { sv => "org.scalaxb" %% "sbt-scalaxb" % ("sbt" + sv + "_0.6.2") }

and this in build.sbt:

seq(sbtscalaxb.Plugin.scalaxbSettings: _*)

sourceGenerators in Compile <+= scalaxb.identity

bug fixes and minor enhancements

Adds --contents-limit option to set the limit of long sequence.
Adds --prepend-family option to prepend family name to classes generated from child elements (#69 reported by @devinus).
Adds soap 1.1 support (#66 reported by @s_m_stewart and @meglio)
All modules built using sbt 0.10.1.

wsdl feature the beginning

Wed, 27 Jul 2011 04:27:45 +0000

I wanted to share Tim’s latest blog article Using SOAP with Scala with you guys.

It seems I have inadvertently become “that guy who does SOAP with Scala”.

Also wanted to share a bit of the background. I’d known SOAP was doable because majority of the WSDL is actually XSD, and also @max4f has implemented it. But originally, I was going to wait a while till I implement WSDL/SOAP support. What got me moving quicker was @timperrett’s tweet on 4/26:

Has anyone ever built some kind of monadic abstraction on SOAP? If so, i want to hear your thoughts!

scalaxb 0.6.1

Wed, 22 Jun 2011 06:21:48 +0000

goodbye sbaz, hello conscript

sbaz allowed quick installation of scalaxb, but it also had its share of problems like scala version dependencies and contaminating the REPL classpath. Starting 0.6.1, scalaxb will no longer be supporting sbaz and recommend all users to switch to conscript for installing scalaxb.

$ sudo sbaz remove scalaxb
$ cs eed3si9n/scalaxb

no `Array`

xs:base64Binary now maps to scalaxb.Base64Binary instead of Array[Byte].
Both scalaxb.HexBinary and scalaxb.Base64Binary are backed by Vector[Byte] internally.
Other built-in types that previously mapped to Array[String] now maps to Seq[String].

mvn-scalaxb

scalaxb plugin for Maven was contributed by @martiell.

sbt-scalaxb for sbt 0.10

To call scalaxb from sbt 0.10, put this in your project/plugins/build.sbt:

libraryDependencies += "org.scalaxb" %% "sbt-scalaxb" % "0.6.1"

and this in your build.sbt:

sourceGenerators in Compile <+= scalaxb.identity

bug fixes and minor enhancements

Fixes list derived types (#54 reported by @ikwzm).
Fixes handling of empty sequences (#55).
Fixes naming of local elements with duplicate name and structure (#56).
Adds @implicitNotFound attributes on fromXML etc.
Adds --no-runtime option to skip generating scalaxb.scala (#45 requested by @martiell).
Implements camel casing of wsdl operation name (#52 requested by @timperrett).
Removes X prefix on wsdl message case classes (#51 requested by @timperrett).
Adds --chunk-size option to handle 200+ parameters (#58 reported by @ecin).

mvn-scalaxb: Running scalaxb from Maven

Sat, 18 Jun 2011 21:24:23 +0000

Running scalaxb from Maven

The scalaxb-maven-plugin is provided to allow scalaxb to be run as part of a maven build.

The guide below gives a quick overview.
Plugin documentation is also available (external link).

vmware uses scalaxb and Salat

Sun, 12 Jun 2011 03:07:56 +0000

John Stanford talking about using scalaxb and Salat to persist case classes into MongoDB:

Using Salat with scalaxb generated classes

He was also the first to post on the new scalaxb Google Group. Join us, and contribute your ideas.

scalaxb 0.6.0

Sun, 29 May 2011 16:06:59 +0000

new feature

Experimental support of wsdl 1.1.

bug fixes and other minor enhancements

XML bindings are generated as foo_xmlprotocol.scala.
Uses Scala 2.9.0-1.
Web API uses Unfiltered 0.3.3.
Adds default argument for xs:anyAttribute.
Adds support for xs:anySimpleType. (#34 reported by @psnively)
Fixes xs:any naming. (#35 reported by @psnively)
Adds typeclass instance for DataRecord. (#40 reported by @psnively)
Fixes DataRecord round trip. (#43)
Fixes mapping of xs:choice of xs:anyType. (#44 reported by @psnively)

wsdl 1.1 support

Sun, 29 May 2011 08:34:13 +0000

During the .com boom, everyone has written a SOAP service or two, which were typically cataloged using WSDL. If you study a WSDL document, you’ll discover that a good portion of the document is actually embedded XML Schema document describing the layout of the messages sent back and forth. The rest are details. Since scalaxb is handling the XML Schema, it was only matter of time to extend this into supporting WSDL.

scalaxb 0.5.4

Fri, 15 Apr 2011 03:11:14 +0000

Added sbt-scalaxb plugin by @max4f.
Added --package-dir, which generates package directory structure.
scalaxb is now available via conscript: cs eed3si9n/scalaxb.
Fixes generated code for cross-package choices (GH-33).

sbt-scalaxb is in the house

Wed, 02 Mar 2011 07:10:42 +0000

A big thanks to Max (@max4f) for writing a scalaxb plugin for sbt, and letting me pull it into the project. If you’re not using simple build tool, why?

Here are the steps to compile-xsd task from sbt.

step 1. `Plugins.scala`

Add the following to your project/plugins/Plugins.scala.

import sbt._

class Plugins(info: ProjectInfo) extends PluginDefinition(info) {
  val scalaxb = "org.scalaxb" % "sbt-scalaxb" % "0.6.0"
  
  val scalaToolsNexusSnapshots = "Scala Tools Nexus Snapshots" at "http://nexus.scala-tools.org/content/repositories/snapshots/"
  val scalaToolsNexusReleases  = "Scala Tools Nexus Releases" at "http://nexus.scala-tools.org/content/repositories/releases/"
}

scalaxb 0.5.3

Tue, 22 Feb 2011 07:54:44 +0000

breaking changes (no `import`)

Moved helper functions from Scalaxb object into scalaxb package object.
Moved default typeclass instances from DefaultXMLProtocol trait to the package object of the generated class. (inspired by @jsuereth at #nescala)

Before:

import scalaxb._
import Scalaxb._
import ipo._
import DefaultXMLProtocol._
val shipTo = fromXML[Address](subject)

After:

val shipTo = scalaxb.fromXML[ipo.Address](subject)

bug fixes and minor enhancements

Maps xs:integer, etc. to BigInt.
Fixed substitution group parsing (GH-25 reported by @dbolene)
Implements attributeFormDefault, elementFormDefault, and form support. (GH-26 reported by @dbolene)
Fixed parsing long sequence. (GH-29 reported by E-Fir)
Implements UTF-8 and UTF-16 BOM handling. (GH-31 reported by @fredferrao)
Prints version number. (GH-24 requested by @dbolene)
Prints better parser error message. (GH-27 reported by @dbolene)

scalaxb 0.5.2

Sat, 15 Jan 2011 19:24:19 +0000

Fixes <xs:sequence> handling. (GH-19)
Fixes <xs:attributeGroup> handling. (GH-21)
Improves error message when a referenced schema or referenced component is missing.
Searches for missing schema in the current directory. (GH-23)

multiple schema files

Sat, 15 Jan 2011 05:54:19 +0000

This page explains a single execution of scalaxb that involves multiple schema files. For multiple runs of scalaxb, see multiple configs.

`<xs:include>` and `<xs:import>`

In XML Schema, schema components for a single target namespace can be assembled from multiple schema definition documents using <xs:include>. For example XML Schema translation of MathML 3’s mathml3-content.xsd contains the following:

<xs:include schemaLocation="mathml3-strict-content.xsd"/>

The above includes the file mathml3-strict-content.xsd into the schema as if it is part of it.

navigating XML Schema

Tue, 11 Jan 2011 00:34:53 +0000

This is a memo to navigate around the case classes for XML Schema. Besides the derivation by extension that programming languages have as inheritance, XML Schema also allows derivation by restriction. Since Scala I don’t think expresses this easily, some types are wider than how they are specified in the schema.

XElement

known subclasses: XTopLevelElement, XLocalElementable, XNarrowMaxMin, XLocalElement
value member: xelementoption : Option[DataRecord[XElementOption]]
- known subclasses: XLocalSimpleType, XLocalComplexType
value member: name: Option[String]
value member: ref : Option[QName]
value member: typeValue : Option[QName]

XSimpleType

known subclasses: XTopLevelSimpleType, XLocalSimpleType
value member: arg1 : DataRecord[XSimpleDerivationOption]
- known subclasses: XUnion, XRestriction, XList
XUnion
- value member: simpleType : Seq[XLocalSimpleType]
- value member: memberTypes : Option[Seq[QName]]
XRestriction
- value member: arg1 : XSimpleRestrictionModelSequence
- XSimpleRestrictionModelSequence
- - value member: simpleType : Option[XLocalSimpleType]
- - value member: arg2 : Seq[DataRecord[XFacetsOption]]
- - - known subclasses: XFacetable, XWhiteSpace, XNumFacetable, XTotalDigits, XNoFixedFacetable, XPattern, XNumFacet, XNoFixedFacet, XFacet. At runtime, XNoFixedFacetable will be parsed as XNoFixedFacet.

running scalaxb

Wed, 08 Dec 2010 13:31:49 +0000

This page describes how to use scalaxb once you have installed it on your machine. (See setup)

running

You need a XML Schema definition file, or .xsd file for short. Suppose you have usaddress.xsd:

<xs:schema targetNamespace="http://www.example.com/IPO"
        elementFormDefault="qualified"
        xmlns="http://www.example.com/IPO"
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:ipo="http://www.example.com/IPO">
  <xs:complexType name="Address">
    <xs:sequence>
      <xs:element name="name"   type="xs:string"/>
      <xs:element name="street" type="xs:string"/>
      <xs:element name="city"   type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="USAddress">
    <xs:complexContent>
      <xs:extension base="ipo:Address">
        <xs:sequence>
          <xs:element name="state" type="xs:string"/>
          <xs:element name="zip"   type="xs:positiveInteger"/>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
</xs:schema>

You then run the following:

$ scalaxb usaddress.xsd -p ipo

-p ipo specifies the package name. scalaxb should generate three sources. First is usaddress.scala that contains case classes that represents the complex types:

try it online

Wed, 08 Dec 2010 04:33:30 +0000

This is a web interface to scalaxb-heroku REST API.

setup

Wed, 08 Dec 2010 04:07:25 +0000

variations of scalaxb

scalaxb is an XML data-binding tool that supports xsd and wsdl, and as output it generates scala source files. There are currently four ways of running scalaxb.

command line app scalaxb
sbt plugin sbt-scalaxb
maven plugin mvn-scalaxb
web API scalaxb-heroku hosted on heroku

They are all functionally equivalent: Takes your schema files and generates scala sources. Because the project started with the command line application, so I used to use it mostly, but today I use sbt-scalaxb together with giter8 template. With the web API, all you need is a browser to try scalaxb. My recommended approach is to use sbt-scalaxb if you’re comfortable with sbt, and also get command line app scalaxb if you want to play around.

typeclass-based XML data binding

Tue, 07 Dec 2010 07:26:00 +0000

Ultimately, the users of scalaxb are interested the real problems that the entity objects express, not how they persist into XML. That’s why I knew I eventually had to vacate the singleton/companion object of the case class to implement the data binding. Until recently it has been generating the data binding implementation as follows:

object Address extends rt.ElemNameParser[Address] {
  val targetNamespace = "http://www.example.com/IPO"
 
  def parser(node: scala.xml.Node): Parser[Address] =
    ...
 
  def toXML(__obj: Address, __namespace: String, __elementLabel: String, __scope: scala.xml.NamespaceBinding): scala.xml.NodeSeq =
    ...
}

Now scalaxb has hijacked the prime real estate for the purpose of XML data binding, which has little to with Address.

scalaxb 0.5.1

Tue, 07 Dec 2010 03:36:51 +0000

Command line program uses Scala 2.8.1.
Fixes accessors to compositors by using type name as the param name. (GH-18)
Fixes generated type of nillable varargs. (also GH-18)

slides for 2010-11-29 ny-scala

Tue, 30 Nov 2010 05:36:29 +0000

I presented a 5-min lightening talk at 2010-11-29 New York Scala Enthusiasts meetup with 8 others. Here’s the pdf of the slides. The presentation fell apart in the middle because the sample code text was too dark over the black background (corrected in pdf). Nonetheless it was inspiring to get live feedback and see what other hackers are up to.

scalaxb 0.5.0

Sun, 28 Nov 2010 23:39:50 +0000

Generates typeclass-based XML data binding code in a separate file xmlprotocol.scala.
Renames runtime package name from org.scalaxb.rt to scalaxb and the helper file to scalaxb.scala.
Fixes handling of <xs:all> containing >22 items (GH-10).
Fixes handling of <xs:complexType> containing >22 attribtues (GH-11).
Fixes handling of <xs:complexType> with <xs:simpleContent>, which restricts a mixed <xs:complexContent> (GH-12).
Fixes output instability (GH-13).
Fixes handling of circular <xs:import> by consolidating the XML databinding code into a single trait (GH-14).
Adds warning when <xs:include> item is missing from compilation (GH-15).

I’d like to thank everyone who gave me feedback and reported issues. Special thanks go to Debasish Ghosh for his inspirational articles and Andreas Sewe for reporting all of the above bugs.

scalaxb 0.4.0

Sun, 17 Oct 2010 03:24:40 +0000

Improves code generation for mixed contents by using parser combinators.
Improves data binding for <any> when the values are XML Schema built-in simple types.
Improves code generation for <choice> when all options can be narrowed down to a single type or a trait.
--class-prefix and --param-prefix option to customize code generation.
Includes scala-library into jar to avoid deployment issues.

proguard

Sun, 17 Oct 2010 02:31:22 +0000

Since I’ve heard several issues installing scalaxb via sbaz, which I think is attributed to Scala version incompatibility, I’ve decided to include scala-library into scalaxb.jar using sbt-proguard-plugin.

--class-prefix and --param-prefix

Sat, 16 Oct 2010 23:12:18 +0000

I added two command line options --class-prefix and --param-prefix to add prefixes to the generated code. It shouldn’t be needed if the schema uses lower case for element names like many of the well-known schemas (slap me if you catch me say schemata or octopodes). This is because scalaxb capitalizes the class name, but leaves the params alone, so you’d end up with code like the following:

case class USAddress(name: String,
  street: String,
  city: String,
  usstate: USState,
  zip: Int) extends Addressable

Suppose the element names were also capitalized in the schema, then it would produce something like this:

narrower

Fri, 15 Oct 2010 04:30:05 +0000

rt.DataRecord came out of the necessity to fulfill two requirements. The first is to convert XML document into a native object so it could be consumed easier (also known as data binding); the second is to retain the ability to convert the native object back into the XML document (also known as round trip). The two requirements are sometimes not aligned with each other. For example, if I am just worried about getting the round trip done, I can just hold on to the scala.xml.Node and use that to write XML out, but it’s not very useful from the data binding perspective.

The first goal of the scalaxb was to cover the full range of XML Schema and implementing the round trip. Now that the goal is mostly fulfilled, my recent updates were aimed to improve the usability of generated code while still maintaining the roundtripability. One area where the pendulum has shifted too much towards round trip is the code generated for <choice>. I’d like to review the history of code generation for <choice> and propose a new solution at the end.

revisited

Sat, 09 Oct 2010 20:08:04 +0000

In order for a DataRecord to not lose the freight during the round trip of <any>, I’ve been storing the scala.xml.Elem object within it. This is convenient for the round trip, but not for consuming the DataRecord. The problem with <any> is that it could be anything, and I wouldn’t know how to parse them. At least when they are not built-in types.

Now that mixed contents have been cleaned up, it seemed like a good time to start parsing XSD built-in types too. Here’s how it looks like:

mixed content revisited

Sat, 02 Oct 2010 07:50:10 +0000

scalaxb added support for mixed contents a while back. When <xs:complexType mixed="true">, text nodes are placed in conjunction with the subelements of the complex type, like XHTML. Since I implemented it, it’s been bothering me that the generated case class is not DRY.

For example,

<xs:element name="mixedTest">
  <xs:complexType mixed="true">
    <xs:choice maxOccurs="unbounded">
      <xs:element name="billTo" type="Address"/>
      <xs:any namespace="##other" processContents="lax" />
    </xs:choice>
  </xs:complexType>
</xs:element>

would generate case class Element3(arg1: Seq[rt.DataRecord[Any]], mixed: Seq[rt.DataRecord[Any]]). The first parameter arg1 contains the subelements; and the second mixed contains both the subelements and the text node. In order for the case class to round trip back to XML, it needed to store both text node and subelements in order in mixed; however because parsing was performed only for subelements, only arg1 would contain Address case class and mixed would contain unparsed scala.xml.Elem instance. Not very nice. All this was partially due to the fact the parsing logic was not very sophisticated.

scalaxb 0.3.0

Tue, 07 Sep 2010 14:01:00 +0000

Implements support for <enumeration>.
Implements support for substitution groups.
Works around 22-parameter limitation by splitting up long sequences into chunks.

working around Tuple22 limitation

Mon, 06 Sep 2010 19:06:28 +0000

Earlier this year I wrote about hitting some scala limitations:

Scala supports only up to Tuple22.

This means that Scala can define case classes only up to 22 parameters. I’ve implemented workarounds to use schema that includes complex types that has more than 22 particles within the sequence.

First, when a sequence contains more than MaxParticleSize (20) particles, it will split up the sequence into chunks of ChunkParticleSize (10). For example, a sequence that has 30 elements would be split into three chunks of 10 elements:

substitution group

Mon, 06 Sep 2010 04:26:29 +0000

XML Schema Part 0: Primer:

XML Schema provides a mechanism, called substitution groups, that allows elements to be substituted for other elements. More specifically, elements can be assigned to a special group of elements that are said to be substitutable for a particular named element called the head element. (Note that the head element as well as the substitutable elementsmust be declared as global elements.)

The following demonstrates substitution group:

Mon, 06 Sep 2010 03:17:10 +0000

XML Schema Part 0: Primer:

The enumeration facet limits a simple type to a set of distinct values. For example, we can use the enumeration facet to define a new simple type called USState, derived from string, whose value must be one of the standard US state abbreviations:

<xsd:simpleType name="USState">
  <xsd:restriction base="xsd:string">
    <xsd:enumeration value="AK"/>
    <xsd:enumeration value="AL"/>
    <xsd:enumeration value="AR"/>
    <!-- and so on ... -->
  </xsd:restriction>
</xsd:simpleType>

We can use case objects to express these restrictions. Here’s what scalaxb generates:

scalaxb-appengine

Tue, 27 Jul 2010 13:09:38 +0000

scalaxb-appengine is a RESTful API to run scalaxb over the web. It’s implemented using n8han/Unfiltered and the full source is available on eed3si9n/scalaxb.

compile

URL:

http://scalaxb.appspot.com/compile/_{output}.{format}_

Formats:

scala, zip

HTTP method:

POST

HTTP encoding:

multipart/form-data

Parameters:

arg: Optional, multiple allowed. URL of the schema file.

argf: Optional, multiple allowed. Uploaded schema file.
defaultPackageName: Optional. Name of the target package.
namespaceURI: Optional, multiple allowed. URI of namespace to be packaged.
packageName: Optional, multiple allowed. Name of the target package for the namespaceURI.
classPrefix: Optional. Prefixes generated class names.
paramPrefix: Optional. Prefixes generated parameter names.
wrapContents: Optional, multiple allowed. Wraps inner contents into a seperate case class.

Notes:

At least one arg or argf must be present.

The n-th packageName specifies the target package for the n-th namespaceURI.

scalaxb 0.2.0

Thu, 15 Jul 2010 04:46:32 +0000

Implements support for <group>, <attributeGroup>, and <all>.
Fixed round trip of complex types containing sequences.
Generates toXML into the companion objects to simplify the case class.

For example,

<xs:complexType name="Address">
  <xs:sequence>
    <xs:element name="name"   type="xs:string"/>
    <xs:element name="street" type="xs:string"/>
    <xs:element name="city"   type="xs:string"/>
  </xs:sequence>
</xs:complexType>

turns to

case class Address(name: String,
  street: String,
  city: String)

and

Mon, 12 Jul 2010 06:25:13 +0000

From XML Schema Part 1:

The XML representation for a model group definition schema component is a <group> element information item. It provides for naming a model group for use by reference in the XML representation of complex type definitions and model groups.

The <group> construct allows the schema designers to reuse part of the content model without resorting to type derivation. This comes in handy when dealing with complicated schema. Suppose we have a group named head.misc and an element named head.

scalaxb 0.1.0

Tue, 22 Jun 2010 10:03:26 +0000

Implements parsing of content models using parser combinators.
Implements support for xsi:nillable (#3).

The following code is an example of a generated parser:

object Address extends rt.ElemNameParser[Address] {
  val targetNamespace = "http://www.example.com/IPO"

  def parser(node: scala.xml.Node): Parser[Address] =
    (rt.ElemName(targetNamespace, "name")) ~
      (rt.ElemName(targetNamespace, "street")) ~
      (rt.ElemName(targetNamespace, "city")) ^^
        { case p1 ~
      p2 ~
      p3 => Address(p1.text,
      p2.text,
      p3.text) }
}

xsi:nillable

Sat, 19 Jun 2010 08:52:20 +0000

In XML, one can omit an element to express lack of value or use an empty element.

Sometimes it is desirable to represent an unshipped item, unknown information, or inapplicable information explicitly with an element, rather than by an absent element.

The trouble with using an empty element <foo></foo> is that the emptiness would no longer matches the specified type like xs:positiveInteger. It is possible to form a xs:union of xs:positiveInteger and an xs:enumeration with only empty string in it to allow either poistive integers or empty string. However, technically speaking, an empty string is different from pure emptiness. In terms of code, it’s the difference between null and "", or in Scala, None and Some("").

XML Schema resolves this issue by introducing a special attribute called xsi:nil. By writing

<price xsi:nil="true" />

parsing with parser combinators

Sun, 13 Jun 2010 21:35:43 +0000

I’ve known the limitation of hand parsing for a while. Parsing that relies on token positions quickly gets out of hand when there are more complex grammars like repetitions, options, and choices of sequences. At some point, I decided to use scala’s parser combinators to do the parsing of content types, but it’s been a long way to implement it.

First let’s look at a real-life example of such complex structure:

scalaxb 0.0.3

Thu, 01 Apr 2010 23:50:11 +0000

Implements options to pick different package names for namespaces.
Implements support for <any>, <anyAttribute>, and mixed content.
Implements round trip from XML document to case class object, and back to XML document.

The following code demonstrates a round trip:

val subject = <foo xmlns="urn:example:ipo"
  xmlns:ipo="urn:example:ipo">
    foo<Choice2>2</Choice2>bar</foo>
val obj = Element3.fromXML(subject)
val document = obj.toXML(null, "foo", subject.scope)

mixed content

Thu, 01 Apr 2010 03:35:30 +0000

Added support for mixed contents. in which text nodes are placed in conjunction with subelements within an element. Similar to the way I handled <any>, text nodes are placed in DataRecord[String] object along with other DataRecord objects under a member value called mixed.

Suppose we have a schema that looks like this:

<element name="Element3">
  <complexType mixed="true">
    <choice maxOccurs="unbounded">
      <element ref="ipo:Choice1"/>
      <element ref="ipo:Choice2"/>
      <any namespace="##other" processContents="lax" />
    </choice>
  </complexType>
</element>

The usage code from the unit test looks like this:

and

Mon, 29 Mar 2010 00:02:05 +0000

Last time I wrote:

Next goal is to handle <any> without ignoring it completely using this generic container. I can probably store the scala.xml.Elem object “as is” in a collection. The user of round trip probably would expect that I don’t lose luggage during the flight.

That’s pretty much what I did for two usages of <any> handled by scalaxb. First pattern is that it could appear as part of the sequence.

round trip

Thu, 25 Mar 2010 03:38:21 +0000

I started implementation of round trip: xml document -> scala object -> back to xml document. Currently done with elements and attributes tracked in the case class. Suppose you have the following document:

val subject = <shipTo xmlns="http://www.example.com/IPO"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:ipo="http://www.example.com/IPO"
    xsi:type="ipo:USAddress">
  <name>Foo</name>
  <street>1537 Paper Street</street>
  <city>Wilmington</city>
  <state>DE</state>
  <zip>19808</zip>
</shipTo>

I can turn this into object by calling fromXML():

val obj = Addressable.fromXML(subject)

Then turn it back into xml document by calling toXML():

per-namespace package name

Fri, 19 Mar 2010 08:58:23 +0000

You can now generate classes under different packages per-namespace.

  -p:<namespaceURI>=<package> | --package:<namespaceURI>=<package>
        specifies the target package for <namespaceURI>

For example XML Signature and SAML 2.0 assertion probably should be under different package name:

$ scalaxb -p:http://www.w3.org/2000/09/xmldsig#=org.w3.xmldsig -p:http://www.w3.org/2001/04/xmlenc#=org.w3.xmlenc -p:urn:oasis:names:tc:SAML:2.0:assertion=org.xml.saml2.assertion -p:urn:oasis:names:tc:SAML:2.0:metadata=org.xml.saml2.metadata saml-schema-metadata-2.0.xsd saml-schema-assertion-2.0.xsd xenc-schema.xsd xmldsig-core-schema.xsd 
generated ./xmldsig-core-schema.scala
generated ./xenc-schema.scala
generated ./saml-schema-assertion-2.scala
generated ./saml-schema-metadata-2.scala
$ scalac xmldsig-core-schema.scala xenc-schema.scala saml-schema-assertion-2.scala saml-schema-metadata-2.scala Helper.scala

I’ve been thinking about this feature for a while. At least a week, since I implemented keyValueOpt in scopt a week ago. With this change, Helper object is now pushed out to its own namespace org.scalaxb.rt and file Helper.scala.

attributes and namespaces in xml

Fri, 19 Mar 2010 04:28:32 +0000

, , and simple types

Sat, 13 Mar 2010 21:16:25 +0000

xml namespace

Thu, 11 Mar 2010 13:42:03 +0000

I’ve been working on Issue 1 submitted by Tsuresh Kumar for a while now. The idea is to compile the schema for SAML Metadata, which is saml-schema-metadata-2.0.xsd. I need to implement a few things so scalaxb can handle the schema.

The biggest issue is the handling of multiple schema documents. Real life schema like SAML Metadata defines the schema on top of existing schema documents/namespaces. The current implementation of scalaxb assumes that the given schema contains everything, and thus the namespace handling was sloppy. Now that it needs to handle multiple namespaces other than the targetNamespace and XSD namespace, I cleaned up the code to convert the prefixes into URI and keep them around in the ElemRef and AttributeRef object.

scala, maven, and netbeans

Mon, 08 Mar 2010 03:06:27 +0000

I’ve been coding scala using TextMate with ant or simple-build-tool, but I’d like to give NetBeans a try again. Coding without IDE wasn’t as bad, since the compiler and tests can catch undefined symbols and typos while making code changes; however, that’s not to say it was perfect. I had to go back and forth between the scaladoc and TextMate in situation I could have just let IDE autocompletion look things up. Also navigating between error messages and the code has been slow, especially since I moved to sbt, which is not integrated with TextMate.

parsing parameter using scopt

Sun, 07 Mar 2010 00:44:52 +0000

Of three command line parameter parsing libraries that I found in Scala, I found jstrachan/scopt to be the best one out there: lightweight and easy to use. The new feature I will be working on, however required -x:key=value option, which was not supported by scopt. The great thing about opensource is that I can just add the new feature if I want to, and github makes it so easy to fork and add a few things in.

simple-build-tool (sbt) and scala bazaar system (sbaz)

Thu, 04 Mar 2010 08:45:22 +0000

Now that I could compile files and evaluate thing from specs, I wanted to create a sbaz package to completely replace Ant.

These Ant tasks are implemented in compiler jar as scala code, so all I had to do was port them over to sbt task. Ant scalascript task generates a shell script that runs you application, which became ScalaScriptTask.scala. Ant sbaz task generates sbaz package, which is a zip file with description in it as an xml file, which became ScalaBazaarTask.scala.

simple-build-tool (sbt) and specs

Wed, 03 Mar 2010 03:59:43 +0000

somewhat updated

Some people land on this page searching for “sbt specs” on Google, so I feel somewhat obligated to update the info on this page.

First of all, as of 2011, the specs signature in Project file looks like:

    val specsVersion = crossScalaVersionString match {
      case "2.8.0" => "1.6.5"
      case _ => "1.6.6"
    }
    val specs = "org.scala-tools.testing" % ("specs_" + crossScalaVersionString) % specsVersion % "test"

Next, I was fitting integration test into specs, but it really should be used for writing BDD style test like the following:

scalaxb

Sat, 27 Feb 2010 03:50:34 +0000

scalaxb is an XML data-binding tool for Scala that supports W3C XML Schema (xsd) and Web Services Description Language (wsdl) as the input file.

Many things still may not work. I’d appreciate if you could run it against your favorite xsd file and let me know the result.

hitting some scala limitations

Thu, 25 Feb 2010 10:48:18 +0000

Fixing salaxb so it can compile Footprint XML Specification.

First I had to account for the fact that in XML Schema, you could legally have elements having the same name as long as they are not at the top level. This required me to change the parsing a little bit. Next, I was fixing the simple content handling, I ran into the following error message by Scala compiler:

[scalac] tests/tmp/footprint.scala:255: error: value Tuple23 is not a member of package scala 
   [scalac] case class VolunteerOpportunity(volunteerOpportunityID: Option[String],
   [scalac]            ^
   [scalac] one error found

This is because Scala supports only up to Tuple22.

understanding xml schema complex types

Fri, 05 Feb 2010 05:50:01 +0000

There’s a great article about XML Schema called Understanding W3C Schema Complex Types by Donald Smith. I wish I’ve read this earlier. The author summarizes the complex types into four simple points:

derivation (restriction, extension, list, and union) is the basis of connection between types in the type hierarchy.
the initial branching of the hierarchy is into simple and complex types.
while both forms of complex type allow attributes, only those with complex content allow child elements; those with simple content only allow character content.
the default syntax for complex types is complex content that restricts anyType.

scalaxb

scalaxb 1.12.5

updates

scalaxb 1.12.4

bug fixes

scalaxb 1.12.3

sbt 2.x migration

updates

scalaxb 1.12.2

updates

scalaxb 1.12.1

Scala 3 compatibility improvements

scalaxb 1.12.0

scalaxbJaxbPackage

updates

new contributors

scalaxb 1.11.1

updates

new contributors

scalaxb 1.11.0

http4s client + tagless final style

scalaxb 1.9.1

updates

new contributors

scalaxb 1.9.0

updates

quick start

scalaxb 1.8.3

scalaxb 1.8.2

scalaxb 1.8.1

scalaxb 1.8.0

scalaxb 1.7.5

scalaxb 1.7.3

enhancement

bug fix

scalaxb 1.7.2

bug fix

scalaxb 1.7.1

bug fixes

scalaxb 1.7.0

breaking changes

symbol encoding strategy and capitalization

other enhancements

bug fixes

scalaxb 1.5.2

enhancements

bug fixes

scalaxb 1.5.1

bug fixes

enhancements

sbt-scalaxb 1.4.x

automate using g8

scalaxb 1.5.0

breaking changes

bug fixes

enhancements

sbt-scalaxb changes

mutable case class

contributors

scalaxb 1.4.1

breaking changes

fixes

who is using scalaxb?

Banno

Klout

Novus

VMWare vCloud

scalaxb 1.4.0

SOAP/REST changes

other enhancements

bug fixes

compiler warnings

contributors

scalaxb 1.3.0

breaking changes

SOAP changes

case class >22 and attributes change

sponsors

scalaxb with Scala 2.11

scalaxb 1.2.1

automate using `g8`

automate using `sbt new`

keys are under `ScalaxbKeys` object

settings are scoped under `scalaxb` task