001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.runtime.model;
020
021import java.io.IOException;
022import java.io.InputStream;
023import java.net.URL;
024
025/**
026 * A named stream used to be able to deploy new components without referring to them via URLs.
027 *
028 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
029 */
030public interface StreamRef {
031
032    /**
033     * Get an unique identifier for this stream.
034     */
035    String getId();
036
037    /**
038     * Get the stream content.
039     *
040     * @return
041     */
042    InputStream getStream() throws IOException;
043
044    /**
045     * Get an URL to that stream. May return null if no URL is available.
046     *
047     * @return
048     */
049    URL asURL();
050}