Package org.apache.shiro.io
Class ResourceUtils
- java.lang.Object
-
- org.apache.shiro.io.ResourceUtils
-
public class ResourceUtils extends Object
Static helper methods for loadingStream
-backed resources.- Since:
- 0.2
- See Also:
getInputStreamForPath(String)
-
-
Field Summary
Fields Modifier and Type Field Description static String
CLASSPATH_PREFIX
Resource path prefix that specifies to load from a classpath location, value isclasspath:
static String
FILE_PREFIX
Resource path prefix that specifies to load from a file location, value isfile:
static String
URL_PREFIX
Resource path prefix that specifies to load from a url location, value isurl:
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static void
close(InputStream is)
Convenience method that closes the specifiedInputStream
, logging anyIOException
that might occur.static InputStream
getInputStreamForPath(String resourcePath)
Returns the InputStream for the resource represented by the specified path, supporting scheme prefixes that direct how to acquire the input stream (CLASSPATH_PREFIX
,URL_PREFIX
, orFILE_PREFIX
).static boolean
hasResourcePrefix(String resourcePath)
Returnstrue
if the resource path is not null and starts with one of the recognized resource prefixes (CLASSPATH_PREFIX
,URL_PREFIX
, orFILE_PREFIX
),false
otherwise.static boolean
resourceExists(String resourcePath)
Returnstrue
if the resource at the specified path exists,false
otherwise.
-
-
-
Field Detail
-
CLASSPATH_PREFIX
public static final String CLASSPATH_PREFIX
Resource path prefix that specifies to load from a classpath location, value isclasspath:
- See Also:
- Constant Field Values
-
URL_PREFIX
public static final String URL_PREFIX
Resource path prefix that specifies to load from a url location, value isurl:
- See Also:
- Constant Field Values
-
FILE_PREFIX
public static final String FILE_PREFIX
Resource path prefix that specifies to load from a file location, value isfile:
- See Also:
- Constant Field Values
-
-
Method Detail
-
hasResourcePrefix
public static boolean hasResourcePrefix(String resourcePath)
Returnstrue
if the resource path is not null and starts with one of the recognized resource prefixes (CLASSPATH_PREFIX
,URL_PREFIX
, orFILE_PREFIX
),false
otherwise.- Parameters:
resourcePath
- the resource path to check- Returns:
true
if the resource path is not null and starts with one of the recognized resource prefixes,false
otherwise.- Since:
- 0.9
-
resourceExists
public static boolean resourceExists(String resourcePath)
Returnstrue
if the resource at the specified path exists,false
otherwise. This method supports scheme prefixes on the path as defined ingetInputStreamForPath(String)
.- Parameters:
resourcePath
- the path of the resource to check.- Returns:
true
if the resource at the specified path exists,false
otherwise.- Since:
- 0.9
-
getInputStreamForPath
public static InputStream getInputStreamForPath(String resourcePath) throws IOException
Returns the InputStream for the resource represented by the specified path, supporting scheme prefixes that direct how to acquire the input stream (CLASSPATH_PREFIX
,URL_PREFIX
, orFILE_PREFIX
). If the path is not prefixed by one of these schemes, the path is assumed to be a file-based path that can be loaded with aFileInputStream
.- Parameters:
resourcePath
- the String path representing the resource to obtain.- Returns:
- the InputStream for the specified resource.
- Throws:
IOException
- if there is a problem acquiring the resource at the specified path.
-
close
public static void close(InputStream is)
Convenience method that closes the specifiedInputStream
, logging anyIOException
that might occur. If theInputStream
argument isnull
, this method does nothing. It returns quietly in all cases.- Parameters:
is
- theInputStream
to close, logging anyIOException
that might occur.
-
-