HalBuilder Core
Java
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src Always strip nulls with default object mapper settings. Jul 23, 2016
.gitignore
LICENSE-2.0.txt
README.md
checkstyle-supressions.xml
pom.xml

README.md

Halbuilder is a simple Java API for generating and consuming HAL documents conforming to the HAL Specification.

Generating Local Resources

RepresentationFactory representationFactory = new StandardRepresentationFactory();

Representation owner = representationFactory.newRepresentation("http://example.com/mike")
  .withLink("td:friend", "http://example.com/mamund")
  .withProperty("name", "Mike")
  .withProperty("age", "36");

Representation halResource = representationFactory.newRepresentation("http://example.com/todo-list")
  .withNamespace("td", "http://example.com/todoapp/rels/{rel}")
  .withLink("td:search", "/todo-list/search;{searchterm}")
  .withLink("td:description", "/todo-list/description")
  .withProperty("created_at", "2010-01-16")
  .withProperty("updated_at", "2010-02-21")
  .withProperty("summary", "An example list")
  .withRepresentation("td:owner", owner);

String xml = halResource.toString(RepresentationFactory.HAL_XML);
String json = halResource.toString(RepresentationFactory.HAL_JSON);

Reading Local Resources

RepresentationFactory representationFactory = new RepresentationFactory();

Representation representation = representationFactory.readRepresentation(
                  new InputStreamReader(Some.class.getResourceAsStream("/test.xml")));

Apache Maven

HalBuilder is deployed to Apache Maven Central under the following coordinates:

<dependency>
  <groupId>com.theoryinpractise</groupId>
  <artifactId>halbuilder-standard</artifactId>
  <version>3.0.1</version>
</dependency>

Website

More documentation is available from the main website at gotohal.net.

Development Forum

Email support and discussion is available on the development forum.

curl -v -F r=releases -F hasPom=false -F e=jar -F g=com.test -F a=project -F v=1.0 -F p=jar -F file=@project-1.0.jar -u admin:admin123 http://localhost:8081/nexus/service/local/artifact/maven/content

curl -v -F r=releases -F hasPom=true -F e=jar -F file=@pom.xml -F file=@project-1.0.jar -u admin:admin123 http://localhost:8081/nexus/service/local/artifact/maven/content

No pom

nexus_upload(
  name="sonatype_snapshot",
  extension="jar",
  groupId="com.test",
  artifactId="project",
  version="1.0",
  packaging="jar")

nexus_upload_jar(
  name="sonatype_snapshot",
  pomFile="halbuilder.pom.xml",
  artifact="//:halbuilder5")