org.cloudfoundry.identity.uaa.cache.UrlContentCache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloudfoundry-identity-server Show documentation

The newest version!

/*******************************************************************************
 *     Cloud Foundry
 *     Copyright (c) [2009-2017] Pivotal Software, Inc. All Rights Reserved.
 *
 *     This product is licensed to you under the Apache License, Version 2.0 (the "License").
 *     You may not use this product except in compliance with the License.
 *
 *     This product includes a number of subcomponents with
 *     separate copyright notices and license terms. Your use of these
 *     subcomponents is subject to the terms and conditions of the
 *     subcomponent's license, as noted in the LICENSE file.
 *******************************************************************************/
package org.cloudfoundry.identity.uaa.cache;


import org.springframework.web.client.RestTemplate;

import java.net.URI;

public interface UrlContentCache {

    /**
     * Retrieves and caches the content for a given URI by invoking
     * {@link org.springframework.web.client.RestTemplate#getForObject(URI, Class)} method.
     * The template may throw {@link org.springframework.web.client.RestClientException} to indicate content not available
     * @param uri - must be a valid URI
     * @param template - RestTemplate used for content retrieval
     * @return byte[] for the content or null if a content retrieval error happened ({@link org.springframework.web.client.RestClientException})
     * @throws IllegalArgumentException if uri is not valid {@link URI}
     */
    byte[] getUrlContent(String uri, RestTemplate template);

    /**
     * Clears the cache unconditionally
     */
    void clear();

    /**
     * Returns the current number of entries in the cache
     * @return the number of entries in the cache
     */
    long size();
}