Package org.java.plugin
Interface PathResolver
-
- All Known Implementing Classes:
ShadingPathResolver,StandardPathResolver
public interface PathResolverThis interface is intended to establish correspondence between relative path and absolute URL in context of plug-in or plug-in fragment.- Version:
- $Id$
- See Also:
ObjectFactory.createPathResolver()
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidconfigure(ExtendedProperties config)Configures this resolver instance.java.net.URLgetRegisteredContext(java.lang.String id)Returns URL ofregisteredplug-in element context.booleanisContextRegistered(java.lang.String id)voidregisterContext(Identity idt, java.net.URL url)Registers "home" URL for given plug-in element.java.net.URLresolvePath(Identity identity, java.lang.String path)Should resolve given path to URL for a given identity.voidunregisterContext(java.lang.String id)Unregisters plug-in element from this path resolver.
-
-
-
Method Detail
-
configure
void configure(ExtendedProperties config) throws java.lang.Exception
Configures this resolver instance. Usually this method is called fromobject factoryimplementation.- Parameters:
config- path resolver configuration data- Throws:
java.lang.Exception- if any error has occurred
-
registerContext
void registerContext(Identity idt, java.net.URL url)
Registers "home" URL for given plug-in element.- Parameters:
idt- plug-in elementurl- "home" URL for a given plug-in element
-
unregisterContext
void unregisterContext(java.lang.String id)
Unregisters plug-in element from this path resolver.- Parameters:
id- plug-in element identifier
-
getRegisteredContext
java.net.URL getRegisteredContext(java.lang.String id)
Returns URL ofregisteredplug-in element context. If context for plug-in element with given ID not registered, this method should throw anIllegalArgumentException. In other words, this method shouldn't returnnull.- Parameters:
id- plug-in element identifier- Returns:
- registered context "home" location
-
isContextRegistered
boolean isContextRegistered(java.lang.String id)
- Parameters:
id- plug-in element identifier- Returns:
trueif context for plug-in element with given ID registered
-
resolvePath
java.net.URL resolvePath(Identity identity, java.lang.String path)
Should resolve given path to URL for a given identity.- Parameters:
identity- plug-in element for which to resolve pathpath- path to be resolved- Returns:
- resolved absolute URL
-
-