Package netscape.ldap.client.opers

Class JDAPBindRequest

java.lang.Object

netscape.ldap.client.opers.JDAPBindRequest

All Implemented Interfaces:

JDAPProtocolOp

public class JDAPBindRequest
extends Object
implements JDAPProtocolOp

This class implements the bind request. This object is sent to the ldap server.

 BindRequest ::= [APPLICATION 0] SEQUENCE {
   version INTEGER(1..127) ,
   name LDAPDN,
   authentication CHOICE {
     simple [0] OCTET STRING,
     krbv42LDAP [1] OCTET STRING,
     krbv42DSA [2] OCTET STRING
   }
 }
 

Note that LDAPv3 bind reuqest is structured as follows:

 BindRequest ::= [APPLICATION 0] SEQUENCE {
   version INTEGER (1..127)
   name LDAPDN,
   authentication AuthenticationChoice
 }
 AuthenticationChoice ::= CHOICE {
   simple [0] OCTET STRING,
          -- 1 and 2 reserved
   sasl [3] SaslCredentials
 }
 SaslCredentials ::= SEQUENCE {
   mechanism LDAPString,
   credentials OCTET STRING
 }
 

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	m_credentials
protected String	m_mechanism
protected String	m_name
protected String	m_password
protected int	m_version	Internal variables

Fields inherited from interface netscape.ldap.client.opers.JDAPProtocolOp

ABANDON_REQUEST, ADD_REQUEST, ADD_RESPONSE, BIND_REQUEST, BIND_RESPONSE, COMPARE_REQUEST, COMPARE_RESPONSE, DEL_REQUEST, DEL_RESPONSE, EXTENDED_REQUEST, EXTENDED_RESPONSE, MODIFY_RDN_REQUEST, MODIFY_RDN_RESPONSE, MODIFY_REQUEST, MODIFY_RESPONSE, SEARCH_REQUEST, SEARCH_RESPONSE, SEARCH_RESULT, SEARCH_RESULT_REFERENCE, UNBIND_REQUEST

Constructor Summary

Constructors

Constructor	Description
JDAPBindRequest(int version, String name, String password)	Constructs anonymous or simple bind request.
JDAPBindRequest(int version, String name, String mechanism, byte[] credentials)	Constructs a LDAP v3.0 SaslCredentials bind request.

Method Summary

Modifier and Type	Method	Description
BERElement	getBERElement()	Retrieves the ber representation of the request.
String	getParamString()	Retrieves the string representation of the request parameters.
int	getType()	Retrieves the protocol operation type.
String	toString()	Retrieves the string representation of the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

m_version

protected int m_version

Internal variables

m_name

protected String m_name

m_password

protected String m_password

m_mechanism

protected String m_mechanism

m_credentials

protected byte[] m_credentials

Constructor Details

JDAPBindRequest

public JDAPBindRequest(int version,
 String name,
 String password)

Constructs anonymous or simple bind request.

Parameters:

version - version

name - distinguished name

password - password

JDAPBindRequest

public JDAPBindRequest(int version,
 String name,
 String mechanism,
 byte[] credentials)

Constructs a LDAP v3.0 SaslCredentials bind request.

Parameters:

version - version

name - distinguished name

mechanism - mechanism (must not be null)

credentials - credientials

Method Details

getType

public int getType()

Retrieves the protocol operation type.

Specified by:

getType in interface JDAPProtocolOp

Returns:

protocol type

getBERElement

public BERElement getBERElement()

Retrieves the ber representation of the request.

Specified by:

getBERElement in interface JDAPProtocolOp

Returns:

ber representation

getParamString

public String getParamString()

Retrieves the string representation of the request parameters.

Returns:

string representation parameters

toString

public String toString()

Retrieves the string representation of the request.

Specified by:

toString in interface JDAPProtocolOp

Overrides:

toString in class Object

Returns:

string representation