|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.car.CarResources
Provides access to resources stored in channel archive files or CARs for short.
Field Summary | |
static java.lang.String |
CAR_RESOURCE_PARM
|
static java.lang.String |
CAR_WORKER_ID
|
static java.lang.String |
RCS_ID
|
Method Summary | |
boolean |
containsResource(java.lang.String resource)
Returns true if the indicated resource is available, false otherwise. |
java.net.URL |
findResource(java.lang.String entry)
Returns a URL to the requested entry if found in one of the installed CARs or null if not found. |
java.lang.ClassLoader |
getClassLoader()
Return the single instance of CarClassLoader. |
java.lang.String |
getContainingCarPath(java.lang.String entry)
Returns the path of the CAR containing the indicated resource. |
static CarResources |
getInstance()
Return the single instance of CarResources. |
java.io.InputStream |
getResourceAsStream(java.lang.String resource)
Return an input stream for reading the raw bytes making up the resource contained in one of the installed CARs. |
long |
getResourceSize(java.lang.String resource)
Return the size of the indicated resource or -1 if the resource is not found or its size is unknown. |
void |
getServices(org.xml.sax.ContentHandler contentHandler)
Push into the passed in content handler events for any services declared in any component archive's deployment descriptor. |
void |
getWorkers(java.util.Properties workers)
Push into the passed in properties object workers defined in any component archive's deployment descriptor. |
boolean |
hasDescriptors()
Returns true if any archive included a deployment descriptor. |
java.lang.String[] |
listAllResources()
Returns an enumeration of String objects each containing the path of a resource available from the installed CARs. |
java.lang.String[] |
listCarResources(java.lang.String carPath)
Returns a list of resources available in the car identified by the passed in relative car file path name. |
java.lang.String[] |
listCars()
Returns a String array of car file paths relative to the car directory specified via the property in portal.properties. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String RCS_ID
public static final java.lang.String CAR_WORKER_ID
public static final java.lang.String CAR_RESOURCE_PARM
Method Detail |
public static CarResources getInstance()
public java.lang.ClassLoader getClassLoader()
public void getWorkers(java.util.Properties workers)
public boolean hasDescriptors()
public void getServices(org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
org.xml.sax.SAXException
public java.io.InputStream getResourceAsStream(java.lang.String resource) throws PortalException
PortalException
public long getResourceSize(java.lang.String resource)
public java.net.URL findResource(java.lang.String entry)
public java.lang.String getContainingCarPath(java.lang.String entry)
public boolean containsResource(java.lang.String resource)
public java.lang.String[] listCars()
public java.lang.String[] listCarResources(java.lang.String carPath)
public java.lang.String[] listAllResources()
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |