com.infoengine.au.delegateprovider
Class CommandDelegateProvider

java.lang.Object
  com.infoengine.au.delegateprovider.CommandDelegateProvider

public class CommandDelegateProvider

extends Object

Provides methods to retrieve Command Delegate information from the Command Delegate Registry. Currently the only Command Delegate Registry is an LDAP Directory.

Supported API: false

Extendable: false

Field Summary

private static String	CLASSNAME
private CmdDelegateProviderService	providerService
private static String	RESOURCE

Constructor Summary

CommandDelegateProvider()
Default constructor.

Method Summary

Group	getCommandDelegateEntry(String commandName, String wcTypeIdentifier, String targetRepository, String directorySearchBaseURL, TypeHierarchy typeHierarchy) Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the Command Delegate Entry.
Group	getCommandDelegateEntry(String commandName, String wcTypeIdentifier, String targetRepository, TypeHierarchy typeHierarchy) Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the Command Delegate Entry.
Group	getCommandDelegateEntryWithUfid(String commandName, String wcTypeIdentifier, String ufid, String directorySearchBaseURL, TypeHierarchy typeHierarchy) Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the Command Delegate Entry.
Group	getCommandDelegateEntryWithUfid(String commandName, String wcTypeIdentifier, String ufid, TypeHierarchy typeHierarchy) Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the Command Delegate Entry.
String	getCommandDelegateName(String commandName, String wcTypeIdentifier, String targetRepository, String directorySearchBaseURL, TypeHierarchy typeHierarchy) Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the fully qualified command delegate classname.
String	getCommandDelegateName(String commandName, String wcTypeIdentifier, String targetRepository, TypeHierarchy typeHierarchy) Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the fully qualified command delegate classname.
Vector	getSupportingAdapters(String commandName, String wcTypeIdentifier, String targetRepository, String directorySearchBaseURL) Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the Command Delegate Entry.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

providerService

private CmdDelegateProviderService providerService

Constructor Detail

CommandDelegateProvider

public CommandDelegateProvider()

Default constructor.

Supported API: false

Method Detail

getCommandDelegateName

public String getCommandDelegateName(String commandName,
                                     String wcTypeIdentifier,
                                     String targetRepository,
                                     TypeHierarchy typeHierarchy)
                              throws CommandDelegateProviderException

Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the fully qualified command delegate classname.

Supported API: false

Parameters:

commandName - Fully qualifed command bean classname (e.g., com.ptc.core.command.common.bean.entity.NewEntityCommand).

wcTypeIdentifier - Windchill Type (e.g., WCTYPE|wt.part.WTPart)

targetRepository - Repository name.

typeHierarchy - TypeHierarchy object used to traverse the input type's hierarchy when searching for a Delegate. If null is specified, the type hierarchy is not traversed.

Returns:

Fully qualified command delegate classname. If the Command Delegate isn't found and no errors occurred, null is returned.

Throws:

CommandDelegateProviderException

getCommandDelegateName

public String getCommandDelegateName(String commandName,
                                     String wcTypeIdentifier,
                                     String targetRepository,
                                     String directorySearchBaseURL,
                                     TypeHierarchy typeHierarchy)
                              throws CommandDelegateProviderException

Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the fully qualified command delegate classname.

Supported API: false

Parameters:

commandName - Fully qualifed command bean classname (e.g., com.ptc.core.command.common.bean.entity.NewEntityCommand).

wcTypeIdentifier - Windchill Type (e.g., WCTYPE|wt.part.WTPart)

targetRepository - Repository name.

directorySearchBaseURL - The Directory Search Base in LDAP URL format (e.g., ldap://camaro.mn.ptc.com/l=arden hills,o=ptc). If this parameter is null, the Directory search base is retrieved from NamingService.

typeHierarchy - TypeHierarchy object used to traverse the input type's hierarchy when searching for a Delegate. If null is specified, the type hierarchy is not traversed.

Returns:

Fully qualified command delegate classname. If the Command Delegate isn't found and no errors occurred, null is returned.

Throws:

CommandDelegateProviderException

getCommandDelegateEntry

public Group getCommandDelegateEntry(String commandName,
                                     String wcTypeIdentifier,
                                     String targetRepository,
                                     TypeHierarchy typeHierarchy)
                              throws CommandDelegateProviderException

Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the Command Delegate Entry.

Supported API: false

Parameters:

commandName - Fully qualifed command bean classname (e.g., com.ptc.core.command.common.bean.entity.NewEntityCommand).

wcTypeIdentifier - Windchill Type (e.g., WCTYPE|wt.part.WTPart)

targetRepository - Repository name.

typeHierarchy - TypeHierarchy object used to traverse the input type's hierarchy when searching for a Delegate. If null is specified, the type hierarchy is not traversed.

Returns:

Group object containing the Command Delegate LDAP entry with all of its attributes. If the Command Delegate isn't found and no errors occurred, null is returned.

Throws:

CommandDelegateProviderException

getCommandDelegateEntry

public Group getCommandDelegateEntry(String commandName,
                                     String wcTypeIdentifier,
                                     String targetRepository,
                                     String directorySearchBaseURL,
                                     TypeHierarchy typeHierarchy)
                              throws CommandDelegateProviderException

Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the Command Delegate Entry.

Supported API: false

Parameters:

commandName - Fully qualifed command bean classname (e.g., com.ptc.core.command.common.bean.entity.NewEntityCommand).

wcTypeIdentifier - Windchill Type (e.g., WCTYPE|wt.part.WTPart)

targetRepository - Repository name.

directorySearchBaseURL - The Directory Search Base in LDAP URL format (e.g., ldap://camaro.mn.ptc.com/l=arden hills,o=ptc). If this parameter is null, the Directory search base is retrieved from NamingService.

typeHierarchy - TypeHierarchy object used to traverse the input type's hierarchy when searching for a Delegate. If null is specified, the type hierarchy is not traversed.

Returns:

Group object containing the Command Delegate LDAP entry with all of its attributes. If the Command Delegate isn't found and no errors occurred, null is returned.

Throws:

CommandDelegateProviderException

getCommandDelegateEntryWithUfid

public Group getCommandDelegateEntryWithUfid(String commandName,
                                             String wcTypeIdentifier,
                                             String ufid,
                                             TypeHierarchy typeHierarchy)
                                      throws CommandDelegateProviderException

Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the Command Delegate Entry.

Supported API: false

Parameters:

commandName - Fully qualifed command bean classname (e.g., com.ptc.core.command.common.bean.entity.NewEntityCommand).

wcTypeIdentifier - Windchill Type (e.g., WCTYPE|wt.part.WTPart)

ufid - Ufid.

typeHierarchy - TypeHierarchy object used to traverse the input type's hierarchy when searching for a Delegate. If null is specified, the type hierarchy is not traversed.

Returns:

Group object containing the Command Delegate LDAP entry with all of its attributes. If the Command Delegate isn't found and no errors occurred, null is returned.

Throws:

CommandDelegateProviderException

getCommandDelegateEntryWithUfid

public Group getCommandDelegateEntryWithUfid(String commandName,
                                             String wcTypeIdentifier,
                                             String ufid,
                                             String directorySearchBaseURL,
                                             TypeHierarchy typeHierarchy)
                                      throws CommandDelegateProviderException

Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the Command Delegate Entry.

Supported API: false

Parameters:

commandName - Fully qualifed command bean classname (e.g., com.ptc.core.command.common.bean.entity.NewEntityCommand).

wcTypeIdentifier - Windchill Type (e.g., WCTYPE|wt.part.WTPart)

ufid - Ufid.

directorySearchBaseURL - The Directory Search Base in LDAP URL format (e.g., ldap://camaro.mn.ptc.com/l=arden hills,o=ptc). If this parameter is null, the Directory search base is retrieved from NamingService.

typeHierarchy - TypeHierarchy object used to traverse the input type's hierarchy when searching for a Delegate. If null is specified, the type hierarchy is not traversed.

Returns:

Group object containing the Command Delegate LDAP entry with all of its attributes. If the Command Delegate isn't found and no errors occurred, null is returned.

Throws:

CommandDelegateProviderException

getSupportingAdapters

public Vector getSupportingAdapters(String commandName,
                                    String wcTypeIdentifier,
                                    String targetRepository,
                                    String directorySearchBaseURL)
                             throws CommandDelegateProviderException

Searches the Command Delegate Registry for the Command Delegate specified by the input values and returns the Command Delegate Entry.

Supported API: false

Parameters:

commandName - Fully qualifed command bean classname (e.g., com.ptc.core.command.common.bean.entity.NewEntityCommand).

wcTypeIdentifier - Windchill Type (e.g., WCTYPE|wt.part.WTPart)

targetRepository - Repository name.

directorySearchBaseURL - The Directory Search Base in LDAP URL format (e.g., ldap://camaro.mn.ptc.com/l=arden hills,o=ptc). If this parameter is null, the Directory search base is retrieved from NamingService.

Returns:

The vector of Info*Engine adapter names supporting the command/type/repository combination, or null if no supporting adapters are found.

Throws:

CommandDelegateProviderException