Package se.curity.identityserver.sdk.haapi

Interface Links

All Known Subinterfaces:

AuthenticationStepConfigurator, ConsentorStepConfigurator, PendingPollingConfigurator, ProblemConfigurator, ProblemInvalidInputConfigurator, RegistrationStepConfigurator

public interface Links

Builder interface allowing the addition of links to the representation being built.

A link represents a relationship between two resources, as defined by RFC 8288: Web Linking.

Since:

5.4.0

Method Summary

Modifier and Type	Method	Description
default void	addLink(URI href, LinkRelation rel)	Adds a link to the representation.
default void	addLink(URI href, LinkRelation rel, Message label)	Adds a link to the representation.
void	addLink(URI href, LinkRelation rel, Message label, MediaType type)	Adds a link to the representation.
default void	addLink(URI href, LinkRelation rel, MediaType type)	Adds a link to the representation.

Method Details

addLink

default void addLink(URI href,
 LinkRelation rel)

Adds a link to the representation.

Parameters:

href - The link target URI.

rel - The link relation.

addLink

default void addLink(URI href,
 LinkRelation rel,
 MediaType type)

Adds a link to the representation.

Parameters:

href - The link target URI.

rel - The link relation.

type - The media type of the resource being linked.

addLink

default void addLink(URI href,
 LinkRelation rel,
 Message label)

Adds a link to the representation.

Parameters:

href - the link target URI.

rel - the link relation.

label - the link title or label (a user readable message).

addLink

void addLink(URI href,
 LinkRelation rel,
 Message label,
 MediaType type)

Adds a link to the representation.

Parameters:

href - the link target URI.

rel - the link relation.

label - the link title or label (a user readable message).

type - The media type of the resource being linked.