Contents
The TIBCO StreamBase® Adapter for LDAP Edit allows a StreamBase application to use an existing LDAP connection to send CRUD commands to an LDAP server.
This section describes the properties you can set for this adapter, using the various tabs of the Properties view in StreamBase Studio.
Name: Use this required field to specify or change the name of this instance of this component, which must be unique in the current EventFlow module. The name must contain only alphabetic characters, numbers, and underscores, and no hyphens or other special characters. The first character must be alphabetic or an underscore.
Adapter: A read-only field that shows the formal name of the adapter.
Class name: Shows the fully qualified class name that implements the functionality of this adapter. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.
Start with application: If this field is set to Yes (default) or to a module parameter that evaluates to true, this instance of this adapter starts as part of the JVM engine that runs this EventFlow fragment. If this field is set to
No or to a module parameter that evaluates to false, the adapter instance is loaded with the engine, but does not start until you send an epadmin container resume command (or its sbadmin equivalent), or until you start the component with StreamBase Manager.
Enable Error Output Port: Select this check box to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.
Description: Optionally enter text to briefly describe the component's purpose and function. In the EventFlow canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.
| Property | Description |
|---|---|
| Connection Adapter | The name of the default connection adapter to use. If the connection adapter is in the same sbapp file, the value can be just the connection adapter name. If the connection adapter is located in a different sbapp, you must use the fully qualified name of the connection adapter. |
| Log Level | Controls the level of verbosity the adapter uses to send notifications to the console. This setting can be higher than the containing application's log level. If set lower, the system log level is used. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE. |
Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.
Caution
Concurrency settings are not suitable for every application, and using these settings requires a thorough analysis of your application. For details, see Execution Order and Concurrency, which includes important guidelines for using the concurrency options.
Use the add input port to perform an add operation, which creates a new entry in the directory.
The schema for the port is:
| Field Name | Field Type | Description |
|---|---|---|
| ConnectionAdapter | string | Optional — The name of the default connection adapter to use. If the connection adapter is in the same sbapp file, the value can be just the connection adapter name. If the connection adapter is located in a different sbapp, you must use the fully qualified name of the connection adapter. |
| DN | string | The DN for the item to add. |
| Attributes | list(tuple(Name string, Value string)) or Tuple | The attributes to add for the specified DN. The attributes field can be either a single tuple or a list of name-value tuples. If the attributes field is a tuple, then the system will use each schema field name as the attribute name and the value (or values if a list is used) will be converted to its string representation with these guidelines |
| Controls | list(tuple(OID string, Critical boolean, Value string)) | Optional — Controls to use during add. |
Use the modify input port to perform an modify operation, which you can then use to update an entry in the directory server.
The schema for the port is:
| Field Name | Field Type | Description |
|---|---|---|
| ConnectionAdapter | string | Optional — The name of the default connection adapter to use. If the connection adapter is in the same sbapp file, the value can be just the connection adapter name. If the connection adapter is located in a different sbapp, you must use the fully qualified name of the connection adapter. |
| DN | string | The DN for the item to modify. |
| Attributes | list(tuple(Name string, Value string)) or Tuple | The attributes to modify for the specified DN. The Attributes field can be either a single tuple or a list of name-value tuples. If the attributes field is a tuple, then the system will use each schema field name as the attribute name and the value (or values if a list is used) will be converted to its string representation with these guidelines |
| Controls | list(tuple(OID string, Critical boolean, Value string)) | Optional - Controls to use during add. |
Use the modifyDN input port to perform a modify DN operation, which you can then use to rename and/or move an entry or subtree in the directory.
The schema for the port is:
| Field Name | Field Type | Description |
|---|---|---|
| ConnectionAdapter | string | Optional — The name of the default connection adapter to use. If the connection adapter is in the same sbapp file, the value can be just the connection adapter name. If the connection adapter is located in a different sbapp, you must use the fully qualified name of the connection adapter. |
| DN | string | The current DN for the entry to rename. |
| NewRDN | string | The new RDN for the target entry. |
| DeleteOldRDN | boolean | Optional — Indicates whether to delete the current RDN value from the target entry. |
| NewSuperiorDN | string | Optional — The new superior DN for the entry. It may be null if the entry is not to be moved below a new parent. |
| Controls | list(tuple(OID string, Critical boolean, Value string)) | Optional — Controls to use during add. |
Use the modifyDN input port to perform a delete operation, which removes an entry from the directory.
The schema for the port is:
| Field Name | Field Type | Description |
|---|---|---|
| ConnectionAdapter | string | Optional — The name of the default connection adapter to use. If the connection adapter is in same sbapp file the value can be just the connection adapter name. If the connection adapter is located in a different sbapp this must be the fully qualified name of the connection adapter. |
| DN | string | The DN of the entry to delete. |
Use the add input port to add LDAP entries to the LDAP server.
Each schema field name is used as the attribute name and the value (or values if a list is used) is converted to its string representation with the following guidelines:
| StreamBase Type | Attribute Value |
|---|---|
| Boolean | True or False |
| Int | A string representation of a integer |
| Long | A string representation of a long |
| String | A string |
| Timestamp | A string expressed as generalized time format yyyyMMddHHmmss.SSS'Z' |
The status output port will output tuples giving relevant information.
The schema for the status output port is:
| Field Name | Field Type | Description |
|---|---|---|
| Status | String | A string describing the current status of the adapter. |
| Time | timestamp | The timestamp that the status occurred. |
| Info | list(tuple(Name string, Value string)) | A list of name value pairs of data to got more context to the status. |
The following lists the status outputs and associated objects:
| Status | Info Elements |
|---|---|
| Add Complete |
|
| Add Error |
|
| Modify Complete |
|
| Modify Error |
|
| ModifyDN Complete |
|
| ModifyDN Error |
|
| Delete Complete |
|
| Delete Error |
|
When suspended, the adapter no longer processes tuples.
When resumed, the adapter starts processing input tuples.