org.pac4j.core.io

Interface Resource

All Known Subinterfaces:

WritableResource

All Known Implementing Classes:

SpringResourceWrapper, SpringWritableResourceWrapper

public interface Resource

Interface for a resource descriptor that abstracts from the actual type of underlying resource, such as a file or class path resource.

An InputStream can be opened for every resource if it exists in physical form, but a URL or File handle can just be returned for certain resources. The actual behavior is implementation-specific.

This is based originally off spring abstraction.

Since:

1.9.0

Author:

Keith Garry Boyce

Method Summary

Modifier and Type	Method and Description
boolean	exists() Return whether this resource actually exists in physical form.
File	getFile() Gets file.
String	getFilename() Determine a filename for this resource, i.e. typically the last part of the path: for example, "myfile.txt".
InputStream	getInputStream() Return an InputStream.

Method Detail

exists

boolean exists()

Return whether this resource actually exists in physical form.

This method performs a definitive existence check, whereas the existence of a Resource handle only guarantees a valid descriptor handle.

Returns:

whether this resource actually exists in physical form

getFilename

String getFilename()

Determine a filename for this resource, i.e. typically the last part of the path: for example, "myfile.txt".

Returns null if this type of resource does not have a filename.

Returns:

a filename for this resource, i.e. typically the last

getInputStream

InputStream getInputStream()
                    throws IOException

Return an InputStream.

Caller is responsible for closing the stream

Returns:

the input stream for the underlying resource (must not be null)

Throws:

IOException - if the stream could not be opened

getFile

File getFile()

Gets file.

Returns:

the file