com.novell.nds.dirxml.ldap
Class GetPasswordsStateResponse

java.lang.Object
  extended by com.novell.ldap.LDAPMessage
      extended by com.novell.ldap.LDAPResponse
          extended by com.novell.ldap.LDAPExtendedResponse
              extended by com.novell.nds.dirxml.ldap.GetPasswordsStateResponse
All Implemented Interfaces:
Externalizable, Serializable, ExtendedResponse

public class GetPasswordsStateResponse
extends LDAPExtendedResponse

The response class for the GetPasswordsStateRequest operation.

If this class is registered via LDAPExtendedResponse.register then the return from the LDAPConnection.extendedOperation call will be an instance of this class. Call this class's register method or call DirXMLExtensions.initialize to register all DirXML LDAP extension response classes.

OID:
2.16.840.1.113719.1.14.100.46

Response data:
 ASN1Sequence
       ASN1Integer     bitmapped passwords state
 

Notes:
The value is bitmapped as follows:
     bit 0:    if set, driver object password is set
     bit 1:    if set, application password is set
     bit 2:    if set, remote loader password is set
     bits 3-n: reserved
 

See Also:
GetPasswordsStateRequest, DirXMLExtensions.initialize(), Serialized Form

Field Summary
 
Fields inherited from class com.novell.ldap.LDAPMessage
ABANDON_REQUEST, ADD_REQUEST, ADD_RESPONSE, BIND_REQUEST, BIND_RESPONSE, COMPARE_REQUEST, COMPARE_RESPONSE, DEL_REQUEST, DEL_RESPONSE, EXTENDED_REQUEST, EXTENDED_RESPONSE, INTERMEDIATE_RESPONSE, message, MODIFY_RDN_REQUEST, MODIFY_RDN_RESPONSE, MODIFY_REQUEST, MODIFY_RESPONSE, SEARCH_REQUEST, SEARCH_RESPONSE, SEARCH_RESULT, SEARCH_RESULT_REFERENCE, UNBIND_REQUEST
 
Constructor Summary
GetPasswordsStateResponse(byte[] berData, int offset, int length)
          Constructor used to create the JNDI ExtendedResponse implementation.
GetPasswordsStateResponse(com.novell.ldap.rfc2251.RfcLDAPMessage rfcMessage)
          Constructor used by response factory to create an instance of this class based on a response message.
 
Method Summary
 byte[] getEncodedValue()
           
 int getState()
          Get the state value from the response.
 boolean isApplicationPasswordSet()
          Convenience method that tests the state bit for the application password.
 boolean isDriverObjectPasswordSet()
          Convenience method that tests the state bit for the driver object password.
 boolean isRemoteLoaderPasswordSet()
          Convenience method that tests the state bit for the remote loader password.
static void register()
          Register this class with LDAPExtendedResponse.register for automatic construction of this class as a result of LDAPConnection.extendedOperation.
 
Methods inherited from class com.novell.ldap.LDAPExtendedResponse
getID, getRegisteredResponses, getValue, register, setDeserializedValues
 
Methods inherited from class com.novell.ldap.LDAPResponse
chkResultCode, getControls, getErrorMessage, getMatchedDN, getMessageID, getReferrals, getResultCode, getType
 
Methods inherited from class com.novell.ldap.LDAPMessage
getTag, isRequest, readDSML, readExternal, setTag, toString, writeDSML, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.naming.ldap.ExtendedResponse
getID
 

Constructor Detail

GetPasswordsStateResponse

public GetPasswordsStateResponse(com.novell.ldap.rfc2251.RfcLDAPMessage rfcMessage)
Constructor used by response factory to create an instance of this class based on a response message.

Parameters:
rfcMessage - message containing response data

GetPasswordsStateResponse

public GetPasswordsStateResponse(byte[] berData,
                                 int offset,
                                 int length)
Constructor used to create the JNDI ExtendedResponse implementation.

Parameters:
berData - LBER-encoded response data
offset - offset of start of response data in berData parameter
length - length of response data
Method Detail

getState

public int getState()
Get the state value from the response.

Returns:
bitmapped state value

isDriverObjectPasswordSet

public boolean isDriverObjectPasswordSet()
Convenience method that tests the state bit for the driver object password.

Returns:
true if password is set.

isApplicationPasswordSet

public boolean isApplicationPasswordSet()
Convenience method that tests the state bit for the application password.

Returns:
true if password is set.

isRemoteLoaderPasswordSet

public boolean isRemoteLoaderPasswordSet()
Convenience method that tests the state bit for the remote loader password.

Returns:
true if password is set.

register

public static void register()
                     throws ClassNotFoundException
Register this class with LDAPExtendedResponse.register for automatic construction of this class as a result of LDAPConnection.extendedOperation.

Throws:
ClassNotFoundException - thrown if the java.lang.Class object for this class cannot be obtained.

getEncodedValue

public byte[] getEncodedValue()
Specified by:
getEncodedValue in interface ExtendedResponse