org.everit.json.schema.loader.SchemaClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.everit.json.schema Show documentation

Implementation of the JSON Schema Core Draft v4 specification built with the org.json API

The newest version!

/*
 * Copyright (C) 2011 Everit Kft. (http://www.everit.org)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.everit.json.schema.loader;

import java.io.InputStream;
import java.util.function.Function;

/**
 * This interface is used by {@link SchemaLoader} to fetch the contents denoted by remote JSON
 * pointer.
 * 
 * 

 * Implementations are expected to support the HTTP/1.1 protocol, the support of other protocols is
 * optional.
 * 
 */
@FunctionalInterface
public interface SchemaClient extends Function {

    @Override
    default InputStream apply(final String url) {
        return get(url);
    }

    /**
     * Returns a stream to be used for reading the remote content (response body) of the URL. In the
     * case of a HTTP URL, implementations are expected send HTTP GET requests and the response is
     * expected to be represented in UTF-8 character set.
     *
     * @param url the URL of the remote resource
     * @return the input stream of the response
     * @throws java.io.UncheckedIOException if an IO error occurs.
     */
    InputStream get(String url);

}