Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

oracle.jdeveloper.jsp.libraries
Class JspLibraryUtils

java.lang.Object
  extended by oracle.jdeveloper.jsp.libraries.JspLibraryUtils

public class JspLibraryUtils
extends java.lang.Object


Nested Class Summary
static class JspLibraryUtils.JspLibraryComparator
           
static class JspLibraryUtils.JspLibraryNameComparator
          the names and versions are kept in declining order
static class JspLibraryUtils.JspLibraryUriComparator
          the URIs and versions are kept in declining order
 
Method Summary
 void addTagLibrary(JspLibrary library, Project project)
           
static java.net.URL[] getDeployedJarFiles(Project project)
          Returns list of file URLs of all JAR files that are deployed to project's WEB-INF/lib folder as part of JSP Tag Library installations.
static java.util.Collection<java.net.URL> getLibraryUrls(JspLibrary lib, Project project)
          Gets the URLs of all library JARs the tag library depends on, including the JAR containing the TLD file.
static java.util.List<JspLibrary> getPackagedLibraries(Project project)
          Gets all JspLibraries whose corresponding TLD file is packaged in a JAR file.
static java.util.List<java.lang.String> getPackagedLibrariesJarPaths(Project project)
          Gets URL paths of all JAR files in the project that contain JspLibrary TLDs.
static java.util.List<java.net.URL> getPackagedLibrariesJarURLs(Project project)
          Gets URLs of all JAR files in the project that contain JspLibrary TLDs.
static java.util.List<java.net.URL> getPackagedLibrariesURLs(Project project)
          Gets URLs of all TLD files inside JARs of the project's JspLibraries.
static java.net.URL getTaglibJarFileURL(java.net.URL tldLocation)
           
static java.net.URL getTaglibJarURL(java.net.URL tldLocation)
           
static java.util.List<JspLibrary> getTagLibraries(Project project)
          Gets all JspLibraries available in the project.
static java.util.List<JspLibrary> getTagLibraries(java.lang.String uri, Project project)
           
static JspLibrary getTagLibrary(java.lang.String uri, Project project)
           
static JspLibrary getTagLibrary(java.net.URL tldURL, Project project)
           
static java.net.URL getTaglibURL(java.lang.String tldURL)
          Returns a URL pointing to the TLD file given by the tldURL.
static java.util.List<JspLibrary> getTldLibraries(Project project)
          Gets all JspLibraries available in the project defined by TLD files.
static URLPath removeDeployedJars(URLPath urlPath, Project project)
          Removes JAR file entries from the given URL path that have already been deployed to project's WEB-INF/lib folder.
static void removeTagLibrary(JspLibrary library, Project project)
          Removing the tag library reference will not remove underlining resource.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getLibraryUrls

public static java.util.Collection<java.net.URL> getLibraryUrls(JspLibrary lib,
                                                                Project project)
Gets the URLs of all library JARs the tag library depends on, including the JAR containing the TLD file. JSP Runtime classes are not added to the list.

Parameters:
lib -
project - Can be null.
Returns:

removeDeployedJars

public static URLPath removeDeployedJars(URLPath urlPath,
                                         Project project)
Removes JAR file entries from the given URL path that have already been deployed to project's WEB-INF/lib folder.

Parameters:
urlPath -
project -
Returns:

getDeployedJarFiles

public static java.net.URL[] getDeployedJarFiles(Project project)
Returns list of file URLs of all JAR files that are deployed to project's WEB-INF/lib folder as part of JSP Tag Library installations. URLs are of the original location

Parameters:
project -
Returns:

getPackagedLibrariesJarPaths

public static java.util.List<java.lang.String> getPackagedLibrariesJarPaths(Project project)
Gets URL paths of all JAR files in the project that contain JspLibrary TLDs. Note: this will not scan Java library JARs.

Parameters:
project -
Returns:

getPackagedLibrariesJarURLs

public static java.util.List<java.net.URL> getPackagedLibrariesJarURLs(Project project)
Gets URLs of all JAR files in the project that contain JspLibrary TLDs. Note: this will not scan Java library JARs.

Parameters:
project -
Returns:

getPackagedLibrariesURLs

public static java.util.List<java.net.URL> getPackagedLibrariesURLs(Project project)
Gets URLs of all TLD files inside JARs of the project's JspLibraries. Note: this will not scan Java library JARs.

Parameters:
project -
Returns:

getPackagedLibraries

public static java.util.List<JspLibrary> getPackagedLibraries(Project project)
Gets all JspLibraries whose corresponding TLD file is packaged in a JAR file.

Parameters:
project -
Returns:

getTldLibraries

public static java.util.List<JspLibrary> getTldLibraries(Project project)
Gets all JspLibraries available in the project defined by TLD files. This excludes any "implicit" libraries that correspond to tag file folders.

Parameters:
project -
Returns:

getTagLibraries

public static java.util.List<JspLibrary> getTagLibraries(Project project)
Gets all JspLibraries available in the project. This includes all "implicit" libraries that correspond to tag file folders.

Parameters:
project -
Returns:

getTagLibrary

public static JspLibrary getTagLibrary(java.lang.String uri,
                                       Project project)

getTagLibraries

public static java.util.List<JspLibrary> getTagLibraries(java.lang.String uri,
                                                         Project project)

getTagLibrary

public static JspLibrary getTagLibrary(java.net.URL tldURL,
                                       Project project)

addTagLibrary

public void addTagLibrary(JspLibrary library,
                          Project project)

removeTagLibrary

public static void removeTagLibrary(JspLibrary library,
                                    Project project)
Removing the tag library reference will not remove underlining resource. For example: removing implicit library for .tag files will not delete the .tag files. Same is true for JAR packaged TLD files, and local TLD files.

Parameters:
library -
project -

getTaglibURL

public static java.net.URL getTaglibURL(java.lang.String tldURL)
Returns a URL pointing to the TLD file given by the tldURL. URL can be an entry inside an archive or a TLD file.


getTaglibJarURL

public static java.net.URL getTaglibJarURL(java.net.URL tldLocation)
Parameters:
tldLocation -
Returns:
JAR URL with the jar: protocol

getTaglibJarFileURL

public static java.net.URL getTaglibJarFileURL(java.net.URL tldLocation)
Parameters:
tldLocation -
Returns:
jar file URL with the file: protocol

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

Copyright © 1997, 2011, Oracle. All rights reserved.