com.baan.b3.legacydirectory
Class DirectoryToolkit

java.lang.Object
  |
  +--com.baan.b3.legacydirectory.DirectoryToolkit

public abstract class DirectoryToolkit

extends java.lang.Object

Entry point for accessing legacy directory objects.
Implementations should subclass this class.

Version:

Build Nr 61, file version \\main\\4, 15:09:10 24-07-2006 UTC

Method Summary

abstract IBusComponent	getBusComponent(java.lang.String p_id) Retrieves the specified Bus Component from the current directory.
static DirectoryToolkit	getDefaultToolkit() Retrieves a default implementation.
abstract java.lang.String[]	listAllBusComponentCategories() Retrieves the list of all BusComponent Categories (the separate list of categories stored in the directory).
abstract java.lang.String[]	listAllBusComponentIds() Retreives the list of all BusComponent Identifiers (the identification of the BusComponent in the directory).
abstract java.lang.String[]	listBusComponentIdsWithCategory(java.lang.String category) Retreives the list of all BusComponent Identifiers (the identification of the BusComponent in the directory) that have a given category.

Methods inherited from class java.lang.Object

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

Method Detail

getDefaultToolkit

public static DirectoryToolkit getDefaultToolkit()

Retrieves a default implementation.
All applications should use this method to get an instance of a Toolkit, unless they have VERY good reasons to use a specific implementation.
Threading policy: MTSafe.

Returns:

an instance of the default implementation of this Toolkit.

getBusComponent

public abstract IBusComponent getBusComponent(java.lang.String p_id)
                                       throws java.lang.IllegalArgumentException,
                                              DirectoryException

Retrieves the specified Bus Component from the current directory.
The directory that is used is configuration dependent. As such, the format of the String argument is dependent on the type of directory used. Applications should, therefore, not make any assumptions about the format of this String. They should not try to generate this String independently. Instead the String should be retrieved from some configuration file, LDAP or from another B3 API (BusinessObjectManager.getCurrentBackend() for instance).

Threading policy: MTSafe.

Parameters:

p_id - a String that identifies the required Bus Component.

Returns:

the required Bus Component.

Throws:

java.lang.IllegalArgumentException - if p_id is null.

DirectoryException - if the underlying directory implementation encountered an error.

listAllBusComponentIds

public abstract java.lang.String[] listAllBusComponentIds()
                                                   throws DirectoryException

Retreives the list of all BusComponent Identifiers (the identification of the BusComponent in the directory). For more detailled info on a particular BusComponent the getBusComponent(String p_id) function can be used. (getBusComponent(java.lang.String)
Threading policy: MTSafe.

Returns:

a list of all BusComponent Identifiers

Throws:

DirectoryException - if the underlying directory implementation encountered an error. *

listBusComponentIdsWithCategory

public abstract java.lang.String[] listBusComponentIdsWithCategory(java.lang.String category)
                                                            throws DirectoryException

Retreives the list of all BusComponent Identifiers (the identification of the BusComponent in the directory) that have a given category. For more detailled info on a particular BusComponent the getBusComponent(String p_id) function can be used. (getBusComponent(java.lang.String)
Threading policy: MTSafe.

Returns:

a list of all BusComponent Identifiers with a given category

Throws:

DirectoryException - if the underlying directory implementation encountered an error. *

listAllBusComponentCategories

public abstract java.lang.String[] listAllBusComponentCategories()
                                                          throws DirectoryException

Retrieves the list of all BusComponent Categories (the separate list of categories stored in the directory).
Threading policy: MTSafe.

Returns:

a list of all BusComponent Categories

Throws:

DirectoryException - if the underlying directory implementation encountered an error. *