oracle.jdeveloper.jsp.libraries
Class JspLibraryManager

java.lang.Object
  oracle.jdeveloper.webapp.libraries.TagLibraryManager<JspLibrary>
      oracle.jdeveloper.jsp.libraries.JspLibraryManager

public final class JspLibraryManager
extends TagLibraryManager<JspLibrary>

Restrictions imposed by the library manager:

1. Basic library manager rules are defined by TagLibraryManager
2. TLD file has to be located in one of the following places:
   • Outside of any archive. In this case file name can not be the same as the file name for existing library with different name.
     If the file name is the same, it would mean that those two tag libraries can not be used at the same time in the same web application project.
   • Inside an archive as entry /META-INF/taglib.tld, or /taglib.tld with or without specified URI. In this case archive name can not be the same as the archive name for existing library with different name.
     If it would be the same, it would mean that those two tag libraries can not be used at the same time in the same web application project.
     This rule is consistent with the rule that two tag libraries has to have the same name if they have the same URI.
   • Inside an archive as entry /META-INF/{?/}?.tld with specified URI.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.jdeveloper.webapp.libraries.TagLibraryManager

TagLibraryManager.RegistrationInfo

Field Summary

static java.lang.String

LIBRARY_SETTINGS_FILE_NAME

Fields inherited from class oracle.jdeveloper.webapp.libraries.TagLibraryManager

history

Method Summary

void	addJspLibraryEventListener(JspLibraryEventListener listener) Add a TEventListener to the library manager.
void	addJspLibraryListener(JspLibraryListener listener) Add a listener to the library manager.
void	addJspLibraryURLClassesProvider(JspLibraryURLClassesProvider urlProvider)
JspLibraryManager	getCopy()
static java.util.Collection<java.net.URL>	getIndexingMetadata()
static JspLibraryManager	getInstance() Retrieve the current instance of the JspLibraryManager
java.util.Collection<JspLibraryURLClassesProvider>	getJspLibraryURLClassesProviders() Deprecated. use TagLibraryManager.getTagLibraryURLClassesProviders() instead.
static java.util.Collection<java.net.URL>	getKnownLibraryAnnotations(JspLibrary library)
static java.net.URL	getKnownLibrarySchema(JspLibrary library)
protected java.net.URL	getLibraryFileLocation()
static java.net.URL	getLibraryIndexingMetadata(java.lang.String tagLibUri)
static java.net.URL	getLibrarySettingsFileLocation() Returns settings file location in the current jdev.
protected TagLibraryManager	getSingletonInstance()
protected void	initFromHistoryFile() Loads jsp-libraries.xml file from the extension System Directory
protected void	loadExtensionLibraries()
protected void	loadExtensionLibrariesExtraInfo()
protected void	loadMigratedLibraries()
protected void	loadTagLibraryURLClassesProviders() Do whatever is necessary to load the URL providers.
protected TagLibraryManager	newInstance()
protected JspLibrary	newTagLibrary(JspLibrary library)
protected JspLibraryChangeEvent	newTagLibraryChangeEvent(java.lang.Object source, JspLibrary library, int event)
protected JspLibraryChangeEvent	newTagLibraryChangeEvent(java.lang.Object source, JspLibrary library, java.util.List events)
protected java.util.Comparator<JspLibrary>	newTagLibraryNameComparator()
protected java.util.Comparator<JspLibrary>	newTagLibraryUriComparator()
void	notifyObserversJspLibraryCreateEvents(oracle.jdevimpl.webapp.jsp.libraries.model.JspLibraryListWrapper jspLibraryListWrapper, JspLibrary library) If library is created, notification is sent to Observers before its added
static void	registerKnownLibraryAnnotations(java.lang.String tagLibUri, java.lang.String libVersion, java.net.URL url)
static void	registerKnownLibraryAnnotations(java.lang.String tagLibUri, java.net.URL url) Registers location of the standalone metadata annotation file that contains metadata for tag library identified by the URI.
static void	registerKnownLibrarySchema(java.lang.String tagLibUri, java.lang.String libVersion, java.net.URL url)
static void	registerKnownLibrarySchema(java.lang.String tagLibUri, java.net.URL url) Registers location of the schema file that contains grammar definition for tag library identified by the URI.
static void	registerLibraryIndexingMetadata(java.lang.String tagLibUri, java.net.URL url)
void	removedJspLibraryURLClassesProvider(JspLibraryURLClassesProvider urlProvider)
void	removeJspLibraryEventListener(JspLibraryEventListener listener) Remove a library event listener from the library manager.
void	removeJspLibraryListener(JspLibraryListener listener) Remove a listener from the library manager.
protected void	saveToFile()
protected void	saveToHistory(JspLibrary library)
protected boolean	validateTaglibURL(JspLibrary library) Checks that tldURL points to the TLD file located or packaged in a way that it can work with the JSP version library says it is compatible with.
protected boolean	validateURI(JspLibrary library) Checks that if libraries URI is already mapped the library name is same, and that if the URI is a resource path to the TLD file (i.e.

Methods inherited from class oracle.jdeveloper.webapp.libraries.TagLibraryManager

activateLibraries, activateLibrary, addActivatableLibrary, addActivatableLibrary, addLibrary, addLibrary, addLibrary, addRegistrationInfo, addTagLibraryListener, addTagLibraryURLClassesProvider, containsLibrary, copyTo, getAllLibraries, getFirstLibraryFromPrefix, getHistory, getLatestLibraryVersions, getLibraries, getLibrariesFromPrefix, getLibrariesFromURI, getLibrariesToSave, getLibrary, getLibrary, getLibraryFromURI, getLibraryFromURI, getOwnerExtensionId, getPackagedLibraries, getPrefixFromURI, getRegistrationInfo, getTagLibraryURLClassesProviders, getUnpackagedLibrary, getUserLibraries, initLibrariesHistory, isEditable, loadAllLibraries, notifyObservers, notifyObservers, removeLibrary, removeLibrary, removeTagLibraryListener, removeTagLibraryURLClassesProvider, setUserLibraries

Methods inherited from class java.lang.Object

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

Field Detail

LIBRARY_SETTINGS_FILE_NAME

public static final java.lang.String LIBRARY_SETTINGS_FILE_NAME

See Also:

Constant Field Values

Method Detail

getJspLibraryURLClassesProviders

@Deprecated
public java.util.Collection<JspLibraryURLClassesProvider> getJspLibraryURLClassesProviders()

Deprecated. use TagLibraryManager.getTagLibraryURLClassesProviders() instead.

Get library url class providers.

Returns:

addJspLibraryURLClassesProvider

public void addJspLibraryURLClassesProvider(JspLibraryURLClassesProvider urlProvider)

removedJspLibraryURLClassesProvider

public void removedJspLibraryURLClassesProvider(JspLibraryURLClassesProvider urlProvider)

getInstance

public static JspLibraryManager getInstance()

Retrieve the current instance of the JspLibraryManager

Returns:

the current JspLibraryManager

getCopy

public JspLibraryManager getCopy()

Overrides:

getCopy in class TagLibraryManager<JspLibrary>

getIndexingMetadata

public static java.util.Collection<java.net.URL> getIndexingMetadata()

newTagLibraryChangeEvent

protected JspLibraryChangeEvent newTagLibraryChangeEvent(java.lang.Object source,
                                                         JspLibrary library,
                                                         int event)

Specified by:

newTagLibraryChangeEvent in class TagLibraryManager<JspLibrary>

newTagLibraryChangeEvent

protected JspLibraryChangeEvent newTagLibraryChangeEvent(java.lang.Object source,
                                                         JspLibrary library,
                                                         java.util.List events)

Specified by:

newTagLibraryChangeEvent in class TagLibraryManager<JspLibrary>

newInstance

protected TagLibraryManager newInstance()

Specified by:

newInstance in class TagLibraryManager<JspLibrary>

saveToHistory

protected void saveToHistory(JspLibrary library)

Specified by:

saveToHistory in class TagLibraryManager<JspLibrary>

newTagLibrary

protected JspLibrary newTagLibrary(JspLibrary library)

Specified by:

newTagLibrary in class TagLibraryManager<JspLibrary>

saveToFile

protected void saveToFile()
                   throws java.io.IOException

Specified by:

saveToFile in class TagLibraryManager<JspLibrary>

Throws:

java.io.IOException

validateTaglibURL

protected boolean validateTaglibURL(JspLibrary library)

Checks that tldURL points to the TLD file located or packaged in a way that it can work with the JSP version library says it is compatible with.

Specified by:

validateTaglibURL in class TagLibraryManager<JspLibrary>

validateURI

protected boolean validateURI(JspLibrary library)

Checks that if libraries URI is already mapped the library name is same, and that if the URI is a resource path to the TLD file (i.e. /WEB-INF/foo.tld or /WEB-INF/bar.jar) it matches the resource name and ....

Specified by:

validateURI in class TagLibraryManager<JspLibrary>

getKnownLibraryAnnotations

public static java.util.Collection<java.net.URL> getKnownLibraryAnnotations(JspLibrary library)

getKnownLibrarySchema

public static java.net.URL getKnownLibrarySchema(JspLibrary library)

getSingletonInstance

protected TagLibraryManager getSingletonInstance()

Specified by:

getSingletonInstance in class TagLibraryManager<JspLibrary>

getLibraryFileLocation

protected final java.net.URL getLibraryFileLocation()

Specified by:

getLibraryFileLocation in class TagLibraryManager<JspLibrary>

getLibrarySettingsFileLocation

public static java.net.URL getLibrarySettingsFileLocation()

Returns settings file location in the current jdev.

Returns:

file location url

loadTagLibraryURLClassesProviders

protected void loadTagLibraryURLClassesProviders()

Description copied from class: TagLibraryManager

Do whatever is necessary to load the URL providers. This function is called only once per instance.

Specified by:

loadTagLibraryURLClassesProviders in class TagLibraryManager<JspLibrary>

addJspLibraryListener

public void addJspLibraryListener(JspLibraryListener listener)

Add a listener to the library manager.

Parameters:

listener - the listener to add.

loadMigratedLibraries

protected void loadMigratedLibraries()

Specified by:

loadMigratedLibraries in class TagLibraryManager<JspLibrary>

loadExtensionLibraries

protected void loadExtensionLibraries()

Specified by:

loadExtensionLibraries in class TagLibraryManager<JspLibrary>

loadExtensionLibrariesExtraInfo

protected void loadExtensionLibrariesExtraInfo()

Specified by:

loadExtensionLibrariesExtraInfo in class TagLibraryManager<JspLibrary>

initFromHistoryFile

protected void initFromHistoryFile()

Loads jsp-libraries.xml file from the extension System Directory

Specified by:

initFromHistoryFile in class TagLibraryManager<JspLibrary>

addJspLibraryEventListener

public void addJspLibraryEventListener(JspLibraryEventListener listener)

Add a TEventListener to the library manager.

Parameters:

listener - the listener to add.

notifyObserversJspLibraryCreateEvents

public void notifyObserversJspLibraryCreateEvents(oracle.jdevimpl.webapp.jsp.libraries.model.JspLibraryListWrapper jspLibraryListWrapper,
                                                  JspLibrary library)

If library is created, notification is sent to Observers before its added

removeJspLibraryEventListener

public void removeJspLibraryEventListener(JspLibraryEventListener listener)

Remove a library event listener from the library manager.

Parameters:

listener - the listener to remove.

removeJspLibraryListener

public void removeJspLibraryListener(JspLibraryListener listener)

Remove a listener from the library manager.

Parameters:

listener - the listener to remove.

getLibraryIndexingMetadata

public static java.net.URL getLibraryIndexingMetadata(java.lang.String tagLibUri)

registerLibraryIndexingMetadata

public static void registerLibraryIndexingMetadata(java.lang.String tagLibUri,
                                                   java.net.URL url)

registerKnownLibraryAnnotations

public static void registerKnownLibraryAnnotations(java.lang.String tagLibUri,
                                                   java.net.URL url)

Registers location of the standalone metadata annotation file that contains metadata for tag library identified by the URI.

registerKnownLibraryAnnotations

public static void registerKnownLibraryAnnotations(java.lang.String tagLibUri,
                                                   java.lang.String libVersion,
                                                   java.net.URL url)

registerKnownLibrarySchema

public static void registerKnownLibrarySchema(java.lang.String tagLibUri,
                                              java.lang.String libVersion,
                                              java.net.URL url)

registerKnownLibrarySchema

public static void registerKnownLibrarySchema(java.lang.String tagLibUri,
                                              java.net.URL url)

Registers location of the schema file that contains grammar definition for tag library identified by the URI. Provided schema must contain all grammar information available in the Taglib file, and may define additional rules that are more restrictive than those from Taglib file.

newTagLibraryUriComparator

protected java.util.Comparator<JspLibrary> newTagLibraryUriComparator()

Specified by:

newTagLibraryUriComparator in class TagLibraryManager<JspLibrary>

newTagLibraryNameComparator

protected java.util.Comparator<JspLibrary> newTagLibraryNameComparator()

Specified by:

newTagLibraryNameComparator in class TagLibraryManager<JspLibrary>