org.glassfish.jersey.linking

Annotation Type ProvideLink

@Target(value={METHOD,TYPE})
 @Repeatable(value=ProvideLinks.class)
 @Retention(value=RUNTIME)
 @Beta
public @interface ProvideLink

Use this on resource methods to contribute links to a representation. It is the inverse of InjectLink instead of annotating the target you annotate the source of the links. The added benefit is that since you annotate the method you don't need to specify the path to it.

 @ProvideLink(value = Order.class, rel = "self", bindings = @Binding(name = "orderId", value = "${instance.id}"))
 @ProvideLink(value = PaymentConfirmation.class, rel = "order",
                  bindings = @Binding(name = "orderId", value = "${instance.orderId}"))
 public Response get(@PathParam("orderId") String orderId) { ...
 

It can also be used as a meta annotation, see the Javadoc of ProvideLink.InheritFromAnnotation for details.

Author:

Leonard Brünings

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>[]	value Provide links for representation classes listed here.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	anchor Specifies the anchor
Binding[]	bindings Specifies the bindings for embedded URI template parameters.
String	condition Specifies a boolean EL expression whose value determines whether a Ref is set (true) or not (false).
InjectLink.Extension[]	extensions Specifies extension parameters as name-value pairs.
String	hreflang Specifies the lang of the referenced resource
String	media Specifies the media
String	rel Specifies the relationship.
String	rev Specifies the reverse relationship.
InjectLink.Style	style The style of URI to inject
String	title Specifies the title.
String	type Specifies the media type.

Element Detail

value

public abstract Class<?>[] value

Provide links for representation classes listed here. May use ProvideLink.InheritFromAnnotation for Meta-Annotations

style

public abstract InjectLink.Style style

The style of URI to inject

Default:

org.glassfish.jersey.linking.InjectLink.Style.ABSOLUTE_PATH

bindings

public abstract Binding[] bindings

Specifies the bindings for embedded URI template parameters.

See Also:

Binding

Default:

{}

condition

public abstract String condition

Specifies a boolean EL expression whose value determines whether a Ref is set (true) or not (false). Omission of a condition will always insert a ref.

Default:

""

rel

public abstract String rel

Specifies the relationship.

Default:

""

rev

public abstract String rev

Specifies the reverse relationship.

Default:

""

type

public abstract String type

Specifies the media type.

Default:

""

title

public abstract String title

Specifies the title.

Default:

""

anchor

public abstract String anchor

Specifies the anchor

Default:

""

media

public abstract String media

Specifies the media

Default:

""

hreflang

public abstract String hreflang

Specifies the lang of the referenced resource

Default:

""

extensions

public abstract InjectLink.Extension[] extensions

Specifies extension parameters as name-value pairs.

Default:

{}