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 }
 

Field Summary

Fields

Modifier and Type	Field and Description
private Credential	newPassword Desired password.
static java.lang.String	OID OID of this extended request.
private Credential	oldPassword Current password.
private java.lang.String	userIdentity User to modify.

Constructor Summary

Constructors

Constructor and Description
PasswordModifyRequest() Default constructor.
PasswordModifyRequest(java.lang.String identity) Creates a new password modify request.
PasswordModifyRequest(java.lang.String identity, Credential oldPass, Credential newPass) Creates a new password modify request.

Method Summary

Modifier and Type	Method and Description
byte[]	encode() Provides the BER encoding of this request.
Credential	getNewPassword() Returns the new password.
java.lang.String	getOID() Returns the OID for this extended request.
Credential	getOldPassword() Returns the old password.
java.lang.String	getUserIdentity() Returns the user to modify.
void	setNewPassword(Credential newPass) Sets the new password.
void	setOldPassword(Credential oldPass) Sets the old password.
void	setUserIdentity(java.lang.String identity) Sets the user to modify.
java.lang.String	toString()

Methods inherited from class org.ldaptive.AbstractRequest

getControls, getIntermediateResponseHandlers, getReferralHandler, setControls, setIntermediateResponseHandlers, setReferralHandler

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ldaptive.Request

getIntermediateResponseHandlers, getReferralHandler

Methods inherited from interface org.ldaptive.Message

getControls

Field Detail

OID

public static final java.lang.String OID

OID of this extended request.

See Also:

Constant Field Values

userIdentity

private java.lang.String userIdentity

User to modify.

oldPassword

private Credential oldPassword

Current password.

newPassword

private Credential newPassword

Desired password.

Constructor Detail

PasswordModifyRequest

public PasswordModifyRequest()

Default constructor.

PasswordModifyRequest

public PasswordModifyRequest(java.lang.String identity)

Creates a new password modify request.

Parameters:

identity - to modify

PasswordModifyRequest

public PasswordModifyRequest(java.lang.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

getUserIdentity

public java.lang.String getUserIdentity()

Returns the user to modify.

Returns:

user identity

setUserIdentity

public void setUserIdentity(java.lang.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()

Description copied from interface: ExtendedRequest

Provides the BER encoding of this request.

Specified by:

encode in interface ExtendedRequest

Returns:

BER encoded request

getOID

public java.lang.String getOID()

Description copied from interface: ExtendedRequest

Returns the OID for this extended request.

Specified by:

getOID in interface ExtendedRequest

Returns:

oid

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object