Adapter Development Kit 6.5 | webMethods Adapter Development Kit Documentation | webMethods Adapter Development Kit Installation and User’s Documentation | Using the Services for Managing Namespace Nodes | Polling Notification Services | wm.art.dev.connection:fetchConnectionMetadata
 
wm.art.dev.connection:fetchConnectionMetadata
Given an adapter type name and a fully qualified connection factory class path, this service queries the connection factory and returns the metadata for all properties supported by connections of that type.
For example, a Java client might invoke this service as follows:
IData pipeline = IDataFactory.create();
IDataCursor pipeCursor = pipeline.getCursor();
pipeCursor.insertAfter("adapterTypeName",
"FooAdapter");
pipeCursor.insertAfter("connectionFactoryType",
"com.wm.adapters.FooConnFactory");
ExtendedConnectionUtils.fetchConnectionMetadata(pipeline);
.
.
.
The service returns a connectionPropertiesarray containing all metadata associated with each of the connection properties. Of particular interest are the systemName, parameterType, defaultValue,and isRequiredattributes, which you can use to configure a connection node.
Input Parameters
adapterTypeName
String. Required. The name of adapter (the value returned by WmAdapter.getAdapterName()).
connectionFactoryType
String. Required. The fully qualified path of the WmManagedConnectionFactory implementation class.
Output Parameters
description
String. Required. The value returned by WmDescriptor.getDescription().
displayName
String. Required. The value returned by WmDescriptor.getDisplayName().
templateURL
String. Required. The URL of online help page for the connection.
connectionProperties[n]
IData[]. Required. An n-dimensioned array of properties.
.systemName
String. Required. The internal property name (adapter-specific).
.displayName
String. Required. The external displayable property name.
.description
String. Required. The displayable property description.
.parameterType
String. Required. The data type of property; see note 1.
.groupURL
String. The URL of the group's help page.
.groupName
String. The name of the group to which the property belongs.
.tupleName
String. The name of the tuple to which the property belongs.
.treeName
String. The name of the tree to which the property belongs.
.treeDelimiter
String. The delimiter character used in the tree.
.resourceDomain
String. The resource domain name.
.defaultValue
String. The default property value.
.isRequired
Boolean. Specifies whether the property is required.
.isHidden
Boolean. Specifies whether the property is displayable.
.isReadOnly
Boolean. Specifies whether the property can be modified.
.isFill
Boolean. Specifies whether the editors should pre-fill the property.
.isPassword
Boolean. Specifies whether the property is a password.
.isMultiline
Boolean. Specifies whether the property traverses multiple lines.
.isKey
Boolean. Specifies whether the property is a key field.
.minSeqLength
String. The lower bound of the sequence.
.maxSeqLength
String. The upper bound of the sequence.
.minStringLength
String. The minimum string length.
.maxStringLength
String. The maximum string length.
.useParam
String. Specifies whether the property is available for use.
Note:
The following Java data types are supported for connections: char, short, int, long, float, double, boolean, java.lang.String, java.lang.Character, java.lang.Short, java.lang.Integer, java.lang.Long, java.lang.Float, java.lang.Double, java.lang.Boolean. Arrays are not currently supported.