org.sda.commons.server.jackson.hal

Class HalLinkProvider

java.lang.Object

org.sda.commons.server.jackson.hal.HalLinkProvider

All Implemented Interfaces:

javax.ws.rs.core.Feature

Deprecated.

this package has been created by mistake. The HalLinkProvider moved to HalLinkProvider, please update the imports.

@Deprecated
public class HalLinkProvider
extends java.lang.Object
implements javax.ws.rs.core.Feature

Helper utility which is registered as singleton instance in the jersey environment via the JacksonConfigurationBundle. It provides the context-based HALLink for a JAX-RS interface using the PathParam and QueryParam annotations.

Usage:

 @Path("")
 interface TestApi {
  @Path("/testPath/{testArg}")
  @GET
  String testMethod(@PathParam("testArg") String testArg, @QueryParam("query") query);
 }

 // Get the generated HALLink
 HALLink HalLink = linkTo(methodOn(TestApi.class).testMethod("ResourceID", "detailed")).asHalLink();
 // Get the generated URI
 URI Uri = linkTo(methodOn(TestApi.class).testMethod("ResourceID", "detailed")).asURI();
 

The example would create the following URI: "baseUri/testPath/ResourceID?query=detailed"

The builder will use the `UriInfo` of the current request context to create absolute URIs. If no request context is available, it will fall back to a simple path without host that does not include any configured root or context path.

Constructor Summary

Constructors

Constructor and Description
HalLinkProvider() Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	configure(javax.ws.rs.core.FeatureContext context) Deprecated.
static LinkResult	linkTo(java.lang.Object invocation) Deprecated. use HalLinkProvider.linkTo(Object) instead
static <T> T	methodOn(java.lang.Class<T> type) Deprecated. use HalLinkProvider.linkTo(Object) instead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HalLinkProvider

public HalLinkProvider()

Deprecated.

Method Detail

linkTo

@Deprecated
public static LinkResult linkTo(java.lang.Object invocation)

Deprecated. use HalLinkProvider.linkTo(Object) instead

methodOn

@Deprecated
public static <T> T methodOn(java.lang.Class<T> type)

Deprecated. use HalLinkProvider.linkTo(Object) instead

configure

public boolean configure(javax.ws.rs.core.FeatureContext context)

Deprecated.

Specified by:

configure in interface javax.ws.rs.core.Feature