JPF 0.10

org.java.plugin
Interface PathResolver

All Known Implementing Classes:
StandardPathResolver

public interface PathResolver

This interface is intended to establish correspondence between relative path and absolute URL in context of plug-in or plug-in fragment.

Version:
$Id: PathResolver.java,v 1.9 2006/04/08 15:44:35 ddimon Exp $
See Also:
ObjectFactory.createPathResolver()

Method Summary
 void configure(ExtendedProperties config)
          Configures this resolver instance.
 java.net.URL getRegisteredContext(java.lang.String id)
          Returns URL of registered plug-in element context.
 boolean isContextRegistered(java.lang.String id)
           
 boolean isResourceExists(java.net.URL url)
          Deprecated. use IoUtil.isResourceExists(URL) method instead, this method will be removed before 1.0 release
 void registerContext(Identity idt, java.net.URL url)
          Registers "home" URL for given plug-in element.
 java.net.URL resolvePath(Identity identity, java.lang.String path)
          Should resolve given path to URL for a given identity.
 void unregisterContext(java.lang.String id)
          Unregisters plug-in element from this path resolver.
 java.io.File url2file(java.net.URL url)
          Deprecated. use IoUtil.url2file(URL) method instead, this method will be removed before 1.0 release
 

Method Detail

configure

public void configure(ExtendedProperties config)
               throws java.lang.Exception
Configures this resolver instance. Usually this method is called from object factory implementation.

Parameters:
config - path resolver configuration data
Throws:
java.lang.Exception - if any error has occurred

registerContext

public void registerContext(Identity idt,
                            java.net.URL url)
Registers "home" URL for given plug-in element.

Parameters:
idt - plug-in element
url - "home" URL for a given plug-in element

unregisterContext

public void unregisterContext(java.lang.String id)
Unregisters plug-in element from this path resolver.

Parameters:
id - plug-in element identifier

getRegisteredContext

public java.net.URL getRegisteredContext(java.lang.String id)
Returns URL of registered plug-in element context. If context for plug-in element with given ID not registered, this method should throw an IllegalArgumentException. In other words, this method shouldn't return null.

Parameters:
id - plug-in element identifier
Returns:
registered context "home" location

isContextRegistered

public boolean isContextRegistered(java.lang.String id)
Parameters:
id - plug-in element identifier
Returns:
true if context for plug-in element with given ID registered

resolvePath

public 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 path
path - path to be resolved
Returns:
resolved absolute URL

isResourceExists

public boolean isResourceExists(java.net.URL url)
Deprecated. use IoUtil.isResourceExists(URL) method instead, this method will be removed before 1.0 release

Should check if resource exists and can be opened.

Parameters:
url - absolute URL which points to a resource to be checked
Returns:
true if given URL points to an existing resource

url2file

public java.io.File url2file(java.net.URL url)
Deprecated. use IoUtil.url2file(URL) method instead, this method will be removed before 1.0 release

Utility method to convert local URL to a File object.

Parameters:
url - an URL
Returns:
file object for given URL or null if URL is not local

JPF 0.10

Copyright © 2004-2005 Dmitry Olshansky. All Rights Reserved.