Home | Contact Us | FAQ | Search & Site Map | Link to Us
Sign In | Join | Other 45 Sites in Network
HomeAnnouncementsWhite Papers
Discussion GroupsFirst AidDatabasesJavaBeansGUIJava 3DVirtual MachineCORBASecurityToolsGeneral
Java DirectoryOpen Source ProjectsSample Book ChaptersUser GroupsWeb Resources
Related Topics
Databases.NETMore Topics ...

Java Forum / General / December 2007

Tip: Looking for answers? Try searching our database.

Locating all classes implementing a given interface?

Thread view: 
Bas - 02 Dec 2007 19:57 GMT
Hi,

my app allows third party code as plugins for certain behaviour. The
actual implementation to use can be specified using a string that
contains the classname. This works great.

However, I'd like the user to be able to specify the class name to use
using a popup menu.

The plugin is contained in a jar that is visible in the classpath.

Is it possible for my code to find all classes implementing my plugin
interface that are available at runtime? Iterating over a directory,
locate the jars and check those is not really what I want. Is this
sort of information dynamically available from the jre?

Thanks,

bas.
Stefan Ram - 02 Dec 2007 20:04 GMT
>Is it possible for my code to find all classes implementing my plugin
>interface that are available at runtime? Iterating over a directory,
>locate the jars and check those is not really what I want. Is this
>sort of information dynamically available from the jre?

 I have written a library routine for this, based on code by
 Ralf Ullrich.

 For example, to find all classes implementing »java.util.Map«,
 one sets a filter accepting only classes which
 »java.util.Map« is assignable from:

public boolean accepts( final java.lang.Class class_ )
{ return java.util.Map.class.isAssignableFrom( class_ ); }

 One also needs to provide a starting class to find the jar, which
 is done as follows.

public java.lang.String entryPath(){ return "java.lang.Object"; }

 The jar containing this type will be chosen for exploration.

 In the following example, the client does not need to specify
 this »entryPath«, as "java.lang.Object" is the default
 obtained by extending
 »de.dclj.ram.java.lang.reflect.Finder.DefaultSpecification«.

 The example client is:

public class Main
{ /* based on an idea and on code by Ralf Ullrich from 2006 */

 public static void main( final java.lang.String[] args )
 { new de.dclj.ram.java.lang.reflect.Finder
   ( new de.dclj.ram.java.lang.reflect.Finder.DefaultSpecification()
     {
       public boolean isClassFinder(){ return true; }

       public boolean accepts( final java.lang.Class class_ )
       { return java.util.Map.class.isAssignableFrom( class_ ); }

       }).inspectJar(); }}

class java.lang.ProcessEnvironment
class java.rmi.server.RemoteObjectInvocationHandler$MethodToHash_Maps$1
class java.security.AuthProvider
(...)
class java.util.Properties
class java.util.Hashtable
interface java.util.Map

 The library »ram.jar« is an early publication in alpha state,
 it is experimental, changing, and mostly undocumented. See:

http://www.purl.org/stefan_ram/pub/ram-jar

 Known issues:

   - I have ideas to improve the interface, which are not yet
     implemented.

   - To compile the library from the sources, one might need
     to take care of some minor bugs: If I remember
     correctly, some »private«s need to  be replaced by
     »public«.
Mark Thornton - 02 Dec 2007 20:11 GMT
> Hi,
>
[quoted text clipped - 15 lines]
>
> bas.

The correct way to implement this type of feature is using
java.util.ServiceLoader (since Java 6). This has been the recommended
approach since at least Java 1.4, but ServiceLoader was added to make it
easier.

Mark Thornton
keke - 03 Dec 2007 10:02 GMT
> Hi,
>
> my app allows third party code as plugins for certain behaviour. The
> actual implementation to use can be specified using a string that
> contains the classname. This works great.
I think there are two approaches:

1/ manually scan all classes available in your jar file
2/ specify your implementation somewhere, for example in your
manifest.mf file.

Cheers
K

> However, I'd like the user to be able to specify the class name to use
> using a popup menu.
[quoted text clipped - 9 lines]
>
> bas.


Free Magazines

Get these publications absolutely FREE for up to 12 months. There are no hidden fees and no obligation. Simply choose a title, complete the application form and submit it. Read more ...

Oracle MagazineNetwork ComputingComputer WorldBio-IT WorldeWeekInformation WeekInfosecurity
 
Sign In
Join
My Latest Posts
My Monitored Threads
My Blog
My Photo Gallery
My Profile
My Homepage

Start New Thread
Enable EMail Alerts
Rate this Thread



©2009 Advenet LLC   Privacy Policy - Terms of Use
This website includes both content owned or controlled by Advenet as well as content owned or controlled by third parties.