com.github.jasminb.jsonapi.RelationshipResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsonapi-converter Show documentation

JSONAPI-Converter is a library that provides means for integrating with services using JSON API specification.

There is a newer version: 0.14

package com.github.jasminb.jsonapi;

/**
 * Relationship resolver contract. 

 * Implementors of this class should provide means for invoking API using relationship URL without any
 * context awareness. Usually relationship should be resolved by simply invoking HTTP GET using provided URL.
 *
 * @author jbegic
 */
public interface RelationshipResolver {

	/**
	 * Resolve relationship data.
	 * @param relationshipURL URL. eg. users/1 or https://api.myhost.com/uers/1
	 * @return raw response returned by the server (should be JSONAPI spec document.
	 */
	byte [] resolve(String relationshipURL);
}