org.apache.sling.api.resource.external

Interface ExternalizableInputStream

public interface ExternalizableInputStream

This interface is normally used to extend an InputStream to indicate that it has a URI form that could be used in place of the InputStream if desired. It is used in situations where the internal of a ResourceProvider wants to offload IO to channels that do not pass through the JVM. The URI that is returned may have restrictions imposed on it requiring it to be used immediately. Do not store the URI for later usage as it will, in most cases, have expired.

Method Summary

Modifier and Type	Method and Description
@NotNull java.net.URI	getURI() Get a URI that is specific to the current session, and may be used in any context internal or external.

Method Detail

getURI

@NotNull
@NotNull java.net.URI getURI()

Get a URI that is specific to the current session, and may be used in any context internal or external. The URI must not be stored and must not be shared between clients. For a wider range of URIs the caller should use the URIProvider class directly and not this interface.

Returns:

a URI intended for any network context.