com.nimbusds.common.servlet

Class ResourceRetriever

java.lang.Object

com.nimbusds.common.servlet.ResourceRetriever

public class ResourceRetriever
extends Object

Servlet resource retriever. Can be used to retrieve the content of a configuration file, as java.io.InputStream, String or java.util.Properties.

Method Summary

Methods

Modifier and Type	Method and Description
static Properties	getProperties(javax.servlet.ServletContext servletCtx, String paramName, org.apache.log4j.Logger log) Gets the java.util.Properties stored in the text file which location is specified in a web.xml context parameter.
static InputStream	getStream(javax.servlet.ServletContext servletCtx, String paramName, org.apache.log4j.Logger log) Gets the resource stored in the text file which location is specified in a web.xml context parameter.
static String	getString(javax.servlet.ServletContext servletCtx, String paramName, org.apache.log4j.Logger log) Gets the resource stored in the text file which location is specified in a web.xml context parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getStream

public static InputStream getStream(javax.servlet.ServletContext servletCtx,
                    String paramName,
                    org.apache.log4j.Logger log)
                             throws Exception

Gets the resource stored in the text file which location is specified in a web.xml context parameter.

Parameters:

servletCtx - The servlet context. Must not be null.

paramName - The name of the servlet context init parameter specifying the properties file location (relative to the web app root). For example, /WEB-INF/authService.properties. Must not be null.

log - To log exceptions at ERROR level. Must not be null.

Returns:

The resource as an input stream.

Throws:

Exception - On a missing servlet context parameter or a missing resource.

getString

public static String getString(javax.servlet.ServletContext servletCtx,
               String paramName,
               org.apache.log4j.Logger log)
                        throws Exception

Gets the resource stored in the text file which location is specified in a web.xml context parameter.

Parameters:

servletCtx - The servlet context. Must not be null.

paramName - The name of the servlet context init parameter specifying the properties file location (relative to the web app root). For example, /WEB-INF/authService.properties. Must not be null.

log - To log exceptions at ERROR level. Must not be null.

Returns:

The resource as a string.

Throws:

Exception - On a missing servlet context parameter, missing or bad resource file.

getProperties

public static Properties getProperties(javax.servlet.ServletContext servletCtx,
                       String paramName,
                       org.apache.log4j.Logger log)
                                throws Exception

Gets the java.util.Properties stored in the text file which location is specified in a web.xml context parameter.

Parameters:

servletCtx - The servlet context. Must not be null.

paramName - The name of the servlet context init parameter specifying the properties file location (relative to the web app root). For example, /WEB-INF/authService.properties. Must not be null.

log - To log exceptions at ERROR level. Must not be null.

Returns:

The properties.

Throws:

Exception - On a missing servlet context parameter, missing or bad properties file.