TIBCO EMS .NET API 10.3
TIBCO EMS .NET API 10.3
|
This class provides an interface used to search for and perform queries in a third-party LDAP server for EMS administered objects. More...
Inherits ILookupContext.
Public Member Functions | |
void | AddSettings (Hashtable prop) |
Add or change the lookup context settings defined in a hash table. More... | |
object | AddSettings (string propName, object propValue) |
Add or change a lookup context setting. More... | |
Object | RemoveSettings (string propName) |
Remove a setting by name More... | |
object | Lookup (string name) |
Lookup up an EMS administered object by name in an LDAP server. More... | |
Properties | |
Hashtable | Settings [get] |
Return a copy of the current settings. More... | |
This class provides an interface used to search for and perform queries in a third-party LDAP server for EMS administered objects.
|
inline |
Add or change the lookup context settings defined in a hash table.
Settings are mainly connection parameters and lookup parameters.
Example: LdapLookupConsts.LDAP_SERVER_URL
prop | The hash table that contains the name-value pairs used to set the lookup context. |
ArgumentException | If the prop table is null |
|
inline |
Add or change a lookup context setting.
This method sets one lookup context property. If the property was previously set, this method modifies it and returns the old value.
Examples:LdapLookupConsts.LDAP_SERVER_URL LdapLookupConsts.LDAP_BASE_DN
propName | Set this single property. See LdapLookupConsts.LDAP_BASE_DN for property names. |
propValue | Set the single property to this value. |
ArgumentException | If either property name or value are null. |
|
inline |
Lookup up an EMS administered object by name in an LDAP server.
This is an implementation of ILookupContext.Lookup. The administered objects can be either EMS connection factories, topics, queues stored in a third-party LDAP server.
Note: Lookup of XA connection factories is not supported.
When looking up administered TLS connection factory object, because of certain differences in the .NET TLS implementation and Java/C TLS implementation certain parameters do not hold any relevance in the .NET world and are ignored.
The following values are supported.
The following (not complete) is the list of values ignored when constructing the TLS connection factory object.
The following shows how to create and LDAP lookup context object and lookup an object in an LDAP server:
name | Lookup the object with this name. |
NullReferenceException | If the name is null. |
ConfigurationException | If any of the configuration parameters are missing. |
NamingException | Any other error while establishing a connection to the ldap server or during lookup. |
|
inline |
Remove a setting by name
Implements ILookupContext.RemoveSettings.
propName | Remove this property. For property names, see LdapLookupConsts. |
ArgumentException | If the property name is null. |
|
get |
Return a copy of the current settings.