org.ldaptive.extended
Class PasswordModifyRequest

java.lang.Object
  org.ldaptive.AbstractRequest
      org.ldaptive.extended.PasswordModifyRequest

All Implemented Interfaces:

ExtendedRequest, Message<RequestControl>, Request

public class PasswordModifyRequest
extends AbstractRequest
implements ExtendedRequest

Contains the data required to perform an ldap password modify operation. See RFC 3062. Request is defined as:

   PasswdModifyRequestValue ::= SEQUENCE {
     userIdentity    [0]  OCTET STRING OPTIONAL
     oldPasswd       [1]  OCTET STRING OPTIONAL
     newPasswd       [2]  OCTET STRING OPTIONAL }
 

Version:

$Revision: 2885 $ $Date: 2014-02-05 16:28:49 -0500 (Wed, 05 Feb 2014) $

Author:

Middleware Services

Field Summary

static String

OID OID of this extended request.

Constructor Summary

PasswordModifyRequest()
Default constructor.

PasswordModifyRequest(String identity)
Creates a new password modify request.

PasswordModifyRequest(String identity, Credential oldPass, Credential newPass)
Creates a new password modify request.

Method Summary

byte[]	encode() Provides the BER encoding of this request.
String	getDn() Deprecated. use getUserIdentity()
Credential	getNewPassword() Returns the new password.
String	getOID() Returns the OID for this extended request.
Credential	getOldPassword() Returns the old password.
String	getUserIdentity() Returns the user to modify.
void	setDn(String dn) Deprecated. use setUserIdentity(String)
void	setNewPassword(Credential newPass) Sets the new password.
void	setOldPassword(Credential oldPass) Sets the old password.
void	setUserIdentity(String identity) Sets the user to modify.
String	toString()

Methods inherited from class org.ldaptive.AbstractRequest

getControls, getFollowReferrals, getIntermediateResponseHandlers, setControls, setFollowReferrals, setIntermediateResponseHandlers

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ldaptive.Request

getFollowReferrals, getIntermediateResponseHandlers

Methods inherited from interface org.ldaptive.Message

getControls

Field Detail

OID

public static final String OID

OID of this extended request.

See Also:

Constant Field Values

Constructor Detail

PasswordModifyRequest

public PasswordModifyRequest()

Default constructor.

PasswordModifyRequest

public PasswordModifyRequest(String identity)

Creates a new password modify request.

Parameters:

identity - to modify

PasswordModifyRequest

public PasswordModifyRequest(String identity,
                             Credential oldPass,
                             Credential newPass)

Creates a new password modify request.

Parameters:

identity - to modify

oldPass - current password for the dn

newPass - desired password for the dn

Method Detail

getDn

@Deprecated
public String getDn()

Deprecated. use getUserIdentity()

Returns the DN to modify.

Returns:

DN

setDn

@Deprecated
public void setDn(String dn)

Deprecated. use setUserIdentity(String)

Sets the DN to modify.

Parameters:

dn - to modify

getUserIdentity

public String getUserIdentity()

Returns the user to modify.

Returns:

user identity

setUserIdentity

public void setUserIdentity(String identity)

Sets the user to modify.

Parameters:

identity - to modify

getOldPassword

public Credential getOldPassword()

Returns the old password.

Returns:

old password

setOldPassword

public void setOldPassword(Credential oldPass)

Sets the old password.

Parameters:

oldPass - to verify

getNewPassword

public Credential getNewPassword()

Returns the new password.

Returns:

new password

setNewPassword

public void setNewPassword(Credential newPass)

Sets the new password.

Parameters:

newPass - to set

encode

public byte[] encode()

Provides the BER encoding of this request.

Specified by:

encode in interface ExtendedRequest

Returns:

BER encoded request

getOID

public String getOID()

Returns the OID for this extended request.

Specified by:

getOID in interface ExtendedRequest

Returns:

oid

toString

public String toString()

Overrides:

toString in class Object