IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.services.ldap.model
Class LDAPRequest

java.lang.Object
  extended by com.ibm.btt.services.ldap.model.LDAPRequest
Direct Known Subclasses:
LDAPCreateRequest, LDAPDestroyRequest, LDAPGetAttributesRequest, LDAPListRequest, LDAPLookupRequest, LDAPModifyRequest, LDAPSearchRequest

public abstract class LDAPRequest
extends java.lang.Object

This is the top level class for supporting requests to the LDAP Access Service. It provides basic information needed by all LDAP requests, and is extended to support specific LDAP requests.


Field Summary
static java.lang.String COMPID
           
protected  java.lang.String requestType
           
 
Constructor Summary
LDAPRequest()
          This constructor creates an LDAPRequest object.
 
Method Summary
 boolean getBooleanValue(Context context, java.lang.String name, boolean required)
          Performs functionally equivalent task as getValue(Context, String, boolean), except that this attempts to parse the value obtained from the context into a boolean.
 int getIntValue(Context context, java.lang.String name, boolean required)
          Performs functionally equivalent task as getValue(Context, String, boolean), except that this attempts to parse the value obtained from the context into an int.
 java.lang.String getName()
          Returns the LDAP name attributes of this model.
 java.lang.String getRequestType()
          Returns the request type of this request model.
 java.lang.Object getValue(Context context, java.lang.String name, boolean required)
          Obtains a named value from the supplied context and returns it.
 void mapFromContext(Context context)
          Supports externalization of an LDAP request.
 void setName(java.lang.String newRelativeDN)
          Sets the LDAP name attribute of this request model.
 void setRequestType(java.lang.String newRequestType)
          Sets the request type of this request model.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPID

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

requestType

protected java.lang.String requestType
Constructor Detail

LDAPRequest

public LDAPRequest()
This constructor creates an LDAPRequest object.

Method Detail

getBooleanValue

public boolean getBooleanValue(Context context,
                               java.lang.String name,
                               boolean required)
                        throws DSEException
Performs functionally equivalent task as getValue(Context, String, boolean), except that this attempts to parse the value obtained from the context into a boolean.

Parameters:
context - com.ibm.btt.base.Context
name - java.lang.String
required - boolean
Returns:
boolean
Throws:
DSEException

getIntValue

public int getIntValue(Context context,
                       java.lang.String name,
                       boolean required)
                throws DSEException
Performs functionally equivalent task as getValue(Context, String, boolean), except that this attempts to parse the value obtained from the context into an int.

Parameters:
context - com.ibm.btt.base.Context
name - java.lang.String
required - boolean
Returns:
int
Throws:
DSEException

getName

public java.lang.String getName()
Returns the LDAP name attributes of this model.

Returns:
java.lang.String

getRequestType

public java.lang.String getRequestType()
Returns the request type of this request model.

Returns:
java.lang.String

getValue

public java.lang.Object getValue(Context context,
                                 java.lang.String name,
                                 boolean required)
                          throws DSEException
Obtains a named value from the supplied context and returns it. If the value does not exist in the context and the required flag is set to true, an exception is thrown. Otherwise, the value null is returned.

Parameters:
context - com.ibm.btt.base.Context
name - java.lang.String
required - boolean
Returns:
java.lang.Object
Throws:
DSEException

mapFromContext

public void mapFromContext(Context context)
                    throws DSEException
Supports externalization of an LDAP request. It maps external data definitions from a context into the request model.

Parameters:
context - com.ibm.btt.base.Context
Throws:
DSEException

setName

public void setName(java.lang.String newRelativeDN)
Sets the LDAP name attribute of this request model.

Parameters:
newRelativeDN - java.lang.String

setRequestType

public void setRequestType(java.lang.String newRequestType)
Sets the request type of this request model.

Parameters:
newRequestType - java.lang.String

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010