| java.lang.Object
 com.sun.portal.util.ResourceLoader
| ResourceLoader | | public class ResourceLoader (Code) | | A utility class that makes it possible to load the configuration files as
property objects.
There are also some utility methods that allow loading of resources
as streams and also make it possible to get the URL of a resource in either
the portal configuration directory or the software configuration directory
|
| Method Summary | |
| public static ResourceLoader | getInstance(Properties p)
Creates an instance of the ResourceLoader object. | | public static synchronized ResourceLoader | getInstance(String portalId, String instanceId)
Creates an instance of the ResourceLoader. | | public static synchronized ResourceLoader | getInstance(String portalId)
Creates an instance of the ResourceLoader. | | public static synchronized ResourceLoader | getInstance()
Creates an instance of the ResourceLoader. | | public String | getInstanceId()
Getter for the Portal Server Instance Identifier value. | | public String | getPortalId()
Getter for the Portal Identifier value. | | public synchronized Properties | getProperties(String propsFileName)
Gets a property object representing a property file in either the portal
configuration directory or the software configuration directory common
to all the portals
Parameters:
propsFileName - The name of the property file as a String
throws:
FileNotFoundException - If a property file does not exist with thisname in the portal configuration or the portal software configurationdirectory
throws:
java.io.IOException - If the property file cannot be loaded asa property object. | | public InputStream | getResourceAsStream(String resourceName)
| | public URL | getResourceUrl(String resourceName)
This method gets the URL of a given resource that is located
either in the Configuration directory, Portal specific
configuration directory or the instance specific configuration
directory
Parameters:
resourceName - The name of the Resource as a String A URL to the resource that is being lookedup. |
| getInstance | | public static ResourceLoader getInstance(Properties p)(Code) | | Creates an instance of the ResourceLoader object.
This method grabs the values for portal, and instance ID
from the given properties object, according to the key names
defined in this class.
If the Java system properties contain the keys, pass
System.getProperties() to this method.
ResourceLoader object
Parameters:
p - the properties object containing theportal and instance IDs. |
| getInstance | | public static synchronized ResourceLoader getInstance(String portalId, String instanceId)(Code) | | Creates an instance of the ResourceLoader.
Null values are allowed in the arguments, with some restrictions:
- if the portal ID is non-null, the domain ID must not be null
- if the instance ID is non-null, the portal Id must not be null
ResourceLoader object
Parameters:
portalId - The Domain Identifier as a String
Parameters:
portalId - The Portal Identifier as a String
Parameters:
portalId - The Instance Identifier as a String |
| getInstance | | public static synchronized ResourceLoader getInstance(String portalId)(Code) | | Creates an instance of the ResourceLoader.
This method calls getInstance(portalId, null), and will therefore
not consider instance specific paths.
ResourceLoader object
Parameters:
portalId - The Portal Identifier as a String |
| getInstance | | public static synchronized ResourceLoader getInstance()(Code) | | Creates an instance of the ResourceLoader.
This method calls getInstance(null, null) and will therefore
only consider software configuration paths.
ResourceLoader object |
| getInstanceId | | public String getInstanceId()(Code) | | Getter for the Portal Server Instance Identifier value.
May return null.
The Portal Server Instance Id as a String |
| getPortalId | | public String getPortalId()(Code) | | Getter for the Portal Identifier value.
May return null.
The portal Id as a String |
| getProperties | | public synchronized Properties getProperties(String propsFileName) throws FileNotFoundException, IOException(Code) | | Gets a property object representing a property file in either the portal
configuration directory or the software configuration directory common
to all the portals
Parameters:
propsFileName - The name of the property file as a String
throws:
FileNotFoundException - If a property file does not exist with thisname in the portal configuration or the portal software configurationdirectory
throws:
java.io.IOException - If the property file cannot be loaded asa property object. a Property object |
| getResourceAsStream | | public InputStream getResourceAsStream(String resourceName) throws FileNotFoundException, IOException(Code) | | Gets and input stream object associated with a resource thats available
to the resource loader
Parameters:
resourceName - A string representing the name of the resource.This string can be an absolute or a relative path.
throws:
java.io.FileNotFoundException - If the resource is not found in the classpath
throws:
java.io.IOException - If a stream cannot be opened for this resource An InputStream representing the resource |
| getResourceUrl | | public URL getResourceUrl(String resourceName)(Code) | | This method gets the URL of a given resource that is located
either in the Configuration directory, Portal specific
configuration directory or the instance specific configuration
directory
Parameters:
resourceName - The name of the Resource as a String A URL to the resource that is being lookedup. A null is returnedif the resource is not found |
|
|