IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.services.ldap
Class LDAPUtility

java.lang.Object
  extended by com.ibm.btt.services.ldap.LDAPUtility

public final class LDAPUtility
extends java.lang.Object

This class provides useful definitions and functions for use by classes comprising the LDAP Access Service.


Field Summary
static java.lang.String ADD
           
static java.lang.String CREATE
           
static java.lang.String DESTROY
           
static java.lang.String FILTER_ATTRIBUTES
           
static java.lang.String FILTER_EXPRESSION
           
static java.lang.String FILTER_VALUE
           
static java.lang.String GET_ATTRIBUTES
           
static java.lang.String IN_ATTR_FILTER_LIST
           
static java.lang.String IN_ATTR_LIST
           
static java.lang.String IN_DYNAMIC_NAME
           
static java.lang.String IN_FILTER
           
static java.lang.String IN_FILTER_EXPRESSION
           
static java.lang.String IN_FILTER_LIST
           
static java.lang.String IN_FILTER_TYPE
           
static java.lang.String IN_MAX_HITS
           
static java.lang.String IN_MOD_CODES
           
static java.lang.String IN_MOD_LIST
           
static java.lang.String IN_OBJ_FLAG
           
static java.lang.String IN_REF_FLAG
           
static java.lang.String IN_SEARCH_SCOPE
           
static java.lang.String IN_SIMPLE_NAME
           
static java.lang.String IN_TIME_LIMIT
           
static java.lang.String IN_USE_FILTER
           
static java.lang.String LDAP_IN_CTX
           
static java.lang.String LDAP_OUT_CTX
           
static java.lang.String LIST
           
static java.lang.String LIST_BINDINGS
           
static java.lang.String LOOKUP
           
static java.lang.String MODIFY
           
static java.lang.String OUT_GET_ATTRIBUTES_RESULTS
           
static java.lang.String OUT_LDAP_DATA
           
static java.lang.String OUT_LIST_BINDINGS_RESULTS
           
static java.lang.String OUT_LIST_RESULTS
           
static java.lang.String OUT_LOOKUP_RESULTS
           
static java.lang.String OUT_SEARCH_RESULTS
           
static java.lang.String REMOVE
           
static java.lang.String REPLACE
           
static java.lang.String SCOPE_OBJECT
           
static java.lang.String SCOPE_ONE_LEVEL
           
static java.lang.String SCOPE_SUBTREE
           
static java.lang.String SEARCH
           
 
Constructor Summary
LDAPUtility()
          This constructor creates an LDAPUtility object.
 
Method Summary
static void addQuotedTagAttributeToBuffer(java.lang.StringBuffer buffer, java.lang.String attrName, java.lang.Object attrValue, boolean addNull)
          A utility method for adding tag attributes to a string buffer.
static void addTagAttributeToBuffer(java.lang.StringBuffer buffer, java.lang.String attrName, java.lang.Object attrValue, boolean addNull)
          A utility method for adding tag attributes to a string buffer.
static java.lang.String[] buildAttributeFilterList(Context context)
          Obtains pre-defined values from the supplied context and uses these values to build up a string array containing attribute names.
static javax.naming.directory.Attributes buildAttributeList(Context context)
          Obtains pre-defined values from the supplied context and uses these values to build up an Attributes object.
static java.lang.Object[] buildFilterObjectList(Context context)
          Obtains pre-defined values from the supplied context and uses these values to build up a object array containing objects to be used in building a dynamic filter.
static javax.naming.directory.ModificationItem[] buildModificationList(Context context)
          Builds a list of modification items from data stored in a context.
static javax.naming.directory.Attribute createAttributeFromColl(KeyedCollection coll)
          Given a keyed collection: <kColl id=telephoneNumber> <field id=0 value=1-888-213-2256> <field id=0 value=1-212-512-2887> </kColl> Then this method will create an attribute named telephoneNumber, with values 1-888-213-2256, and 1-212-512-2887.
static LDAPRequest getRequestModelFor(java.lang.String requestType)
          Returns an appropriate request model depending on the request type supplied as argument.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LIST

public static final java.lang.String LIST
See Also:
Constant Field Values

LIST_BINDINGS

public static final java.lang.String LIST_BINDINGS
See Also:
Constant Field Values

LOOKUP

public static final java.lang.String LOOKUP
See Also:
Constant Field Values

SEARCH

public static final java.lang.String SEARCH
See Also:
Constant Field Values

CREATE

public static final java.lang.String CREATE
See Also:
Constant Field Values

DESTROY

public static final java.lang.String DESTROY
See Also:
Constant Field Values

MODIFY

public static final java.lang.String MODIFY
See Also:
Constant Field Values

GET_ATTRIBUTES

public static final java.lang.String GET_ATTRIBUTES
See Also:
Constant Field Values

SCOPE_OBJECT

public static final java.lang.String SCOPE_OBJECT
See Also:
Constant Field Values

SCOPE_SUBTREE

public static final java.lang.String SCOPE_SUBTREE
See Also:
Constant Field Values

SCOPE_ONE_LEVEL

public static final java.lang.String SCOPE_ONE_LEVEL
See Also:
Constant Field Values

FILTER_VALUE

public static final java.lang.String FILTER_VALUE
See Also:
Constant Field Values

FILTER_EXPRESSION

public static final java.lang.String FILTER_EXPRESSION
See Also:
Constant Field Values

FILTER_ATTRIBUTES

public static final java.lang.String FILTER_ATTRIBUTES
See Also:
Constant Field Values

ADD

public static final java.lang.String ADD
See Also:
Constant Field Values

REMOVE

public static final java.lang.String REMOVE
See Also:
Constant Field Values

REPLACE

public static final java.lang.String REPLACE
See Also:
Constant Field Values

LDAP_IN_CTX

public static final java.lang.String LDAP_IN_CTX
See Also:
Constant Field Values

LDAP_OUT_CTX

public static final java.lang.String LDAP_OUT_CTX
See Also:
Constant Field Values

IN_SIMPLE_NAME

public static final java.lang.String IN_SIMPLE_NAME
See Also:
Constant Field Values

IN_DYNAMIC_NAME

public static final java.lang.String IN_DYNAMIC_NAME
See Also:
Constant Field Values

IN_FILTER

public static final java.lang.String IN_FILTER
See Also:
Constant Field Values

IN_FILTER_EXPRESSION

public static final java.lang.String IN_FILTER_EXPRESSION
See Also:
Constant Field Values

IN_FILTER_TYPE

public static final java.lang.String IN_FILTER_TYPE
See Also:
Constant Field Values

IN_FILTER_LIST

public static final java.lang.String IN_FILTER_LIST
See Also:
Constant Field Values

IN_MAX_HITS

public static final java.lang.String IN_MAX_HITS
See Also:
Constant Field Values

IN_REF_FLAG

public static final java.lang.String IN_REF_FLAG
See Also:
Constant Field Values

IN_OBJ_FLAG

public static final java.lang.String IN_OBJ_FLAG
See Also:
Constant Field Values

IN_ATTR_FILTER_LIST

public static final java.lang.String IN_ATTR_FILTER_LIST
See Also:
Constant Field Values

IN_SEARCH_SCOPE

public static final java.lang.String IN_SEARCH_SCOPE
See Also:
Constant Field Values

IN_TIME_LIMIT

public static final java.lang.String IN_TIME_LIMIT
See Also:
Constant Field Values

IN_ATTR_LIST

public static final java.lang.String IN_ATTR_LIST
See Also:
Constant Field Values

IN_MOD_LIST

public static final java.lang.String IN_MOD_LIST
See Also:
Constant Field Values

IN_USE_FILTER

public static final java.lang.String IN_USE_FILTER
See Also:
Constant Field Values

IN_MOD_CODES

public static final java.lang.String IN_MOD_CODES
See Also:
Constant Field Values

OUT_LDAP_DATA

public static final java.lang.String OUT_LDAP_DATA
See Also:
Constant Field Values

OUT_LIST_RESULTS

public static final java.lang.String OUT_LIST_RESULTS
See Also:
Constant Field Values

OUT_LIST_BINDINGS_RESULTS

public static final java.lang.String OUT_LIST_BINDINGS_RESULTS
See Also:
Constant Field Values

OUT_LOOKUP_RESULTS

public static final java.lang.String OUT_LOOKUP_RESULTS
See Also:
Constant Field Values

OUT_GET_ATTRIBUTES_RESULTS

public static final java.lang.String OUT_GET_ATTRIBUTES_RESULTS
See Also:
Constant Field Values

OUT_SEARCH_RESULTS

public static final java.lang.String OUT_SEARCH_RESULTS
See Also:
Constant Field Values
Constructor Detail

LDAPUtility

public LDAPUtility()
This constructor creates an LDAPUtility object.

Method Detail

addQuotedTagAttributeToBuffer

public static void addQuotedTagAttributeToBuffer(java.lang.StringBuffer buffer,
                                                 java.lang.String attrName,
                                                 java.lang.Object attrValue,
                                                 boolean addNull)
A utility method for adding tag attributes to a string buffer.

Parameters:
buffer - java.lang.StringBuffer
attrName - java.lang.String
attrValue - java.lang.Object
addNull - boolean

addTagAttributeToBuffer

public static void addTagAttributeToBuffer(java.lang.StringBuffer buffer,
                                           java.lang.String attrName,
                                           java.lang.Object attrValue,
                                           boolean addNull)
A utility method for adding tag attributes to a string buffer.

Parameters:
buffer - java.lang.StringBuffer
attrName - java.lang.String
attrValue - java.lang.Object
addNull - boolean

buildAttributeFilterList

public static java.lang.String[] buildAttributeFilterList(Context context)
                                                   throws DSEException
Obtains pre-defined values from the supplied context and uses these values to build up a string array containing attribute names.

Parameters:
context - com.ibm.btt.base.Context
Returns:
java.lang.String[]
Throws:
DSEException

buildAttributeList

public static javax.naming.directory.Attributes buildAttributeList(Context context)
                                                            throws DSEException
Obtains pre-defined values from the supplied context and uses these values to build up an Attributes object.

Parameters:
context - com.ibm.btt.base.Context
Returns:
javax.naming.directory.Attribute[]
Throws:
DSEException

buildFilterObjectList

public static java.lang.Object[] buildFilterObjectList(Context context)
                                                throws DSEException
Obtains pre-defined values from the supplied context and uses these values to build up a object array containing objects to be used in building a dynamic filter.

Parameters:
context - com.ibm.btt.base.Context
Returns:
java.lang.Object[]
Throws:
DSEException

buildModificationList

public static javax.naming.directory.ModificationItem[] buildModificationList(Context context)
                                                                       throws DSEException
Builds a list of modification items from data stored in a context.

Parameters:
context - com.ibm.btt.base.Context
Returns:
javax.naming.directory.ModificationItem[]
Throws:
DSEException

createAttributeFromColl

public static javax.naming.directory.Attribute createAttributeFromColl(KeyedCollection coll)
                                                                throws DSEException
Given a keyed collection:
 <kColl id=telephoneNumber>
                <field id=0 value=1-888-213-2256>
                <field id=0 value=1-212-512-2887>
 </kColl>
 
Then this method will create an attribute named telephoneNumber, with values 1-888-213-2256, and 1-212-512-2887.

Parameters:
coll - com.ibm.btt.base.KeyedCollection
Returns:
javax.naming.directory.Attribute
Throws:
DSEException

getRequestModelFor

public static LDAPRequest getRequestModelFor(java.lang.String requestType)
                                      throws DSEInvalidRequestException
Returns an appropriate request model depending on the request type supplied as argument. This list should be updated if new request types are defined or present request types are modified.

Parameters:
requestType - java.lang.String
Returns:
com.ibm.btt.services.ldap.LDAPRequest
Throws:
DSEInvalidRequestException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011