RelRegistry.java

/**
 * Copyright (c) 2013-2016, The SeedStack authors <http://seedstack.org>
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package org.seedstack.seed.rest;

import org.seedstack.seed.rest.hal.HalBuilder;
import org.seedstack.seed.rest.hal.Link;

/**
 * A registry which can provide href or HAL link associated to a given relation type.
 * It avoids you to duplicate href over the application.
 *
 * @see HalBuilder
 */
public interface RelRegistry {

    /**
     * Provides the href associated with the given rel.
     * The href can be templated or not.
     *
     * @param rel the relation type
     * @return the href
     */
    String href(String rel);

    /**
     * Finds the link representation associated to a rel. Rel are found by scanning the class for the
     * {@link Rel} annotation
     *
     * @param rel the relation type
     * @return a link or null if the rel is not found
     */
    Link uri(String rel);
}