001/*
002 * nimbus-jose-jwt
003 *
004 * Copyright 2012-2016, Connect2id Ltd.
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
007 * this file except in compliance with the License. You may obtain a copy of the
008 * License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software distributed
013 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
014 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
015 * specific language governing permissions and limitations under the License.
016 */
017
018package com.nimbusds.jose.util;
019
020
021import java.io.IOException;
022import java.net.URL;
023
024
025/**
026 * Retriever of resources specified by URL.
027 */
028public interface ResourceRetriever {
029
030
031        /**
032         * Retrieves the resource from the specified HTTP(S) URL.
033         *
034         * @param url The URL of the resource. Its scheme must be HTTP or
035         *            HTTPS. Must not be {@code null}.
036         *
037         * @return The retrieved resource.
038         *
039         * @throws IOException If the HTTP connection to the specified URL
040         *                     failed or the resource couldn't be retrieved.
041         */
042        Resource retrieveResource(final URL url)
043                throws IOException;
044}