NAME

Net::LDAP::Entry -- An LDAP entry object

SUPPORTED PLATFORMS

Linux
Solaris
Windows

This module is not included with the standard ActivePerl distribution. It is available as a separate download using PPM.

SYNOPSIS

  use Net::LDAP;

  $ldap = Net::LDAP->new($host);
  $mesg = $ldap->search(@search_args);

  my $max = $mesg->count;
  for($i = 0 ; $i < $max ; $i++) {
    my $entry = $mesg->entry($i);
    foreach my $attr ($entry->attributes) {
      print join("\n ",$attr, $entry->get($attr)),"\n";
    }
  }

  # or

  use Net::LDAP::Entry;


  $entry = Net::LDAP::Entry->new;


  $entry->add(
    attr1 => 'value1',
    attr2 => [qw(value1 value2)]
  );


  $entry->delete( 'unwanted' );


  $entry->replace(
    attr1 => 'newvalue'
    attr2 => [qw(new values)]
  );


  $entry->update( $ldap ); # update directory server

DESCRIPTION

The Net::LDAP::Entry object represents a single entry in the directory. It is a container for attribute-value pairs.

A Net::LDAP::Entry object can be used in two situations. The first and probably most common use is in the result of a search to the directory server.

The other is where a new object is created locally and then a single command is sent to the directory server to add, modify or replace an entry. Entries for this purpose can also be created by reading an LDIF file with the the Net::LDAP::LDIF manpage module.

CONSTRUCTOR

METHODS

add ( ATTR => VALUE [, ATTR2 => VALUE2 ... ] )

Add one or more new attributes to the entry. Each value must be a scalar variable or a reference to an array. The values given will be added to the values which already exist for the given attributes.

  $entry->add( 'sn' => 'Barr');

  $entry->add( 'street' => [ '1 some road','nowhere']);

NOTE: these changes are local to the client and will not appear on the directory server until the update method is called.

replace ( ATTR => VALUE [, ATTR2 => VALUE2 ... ] )

Similar to add, except that the values given will replace any values that already exist for the given attributes.

NOTE: these changes are local to the client and will not appear on the directory server until the update method is called.

delete ( [ ATTR [, ATTR2 ... ]] )

Delete the given attributes from the entry. If no attributes are passed then the next call to update will cause the entry to be deleted from the server.

NOTE: these changes are local to the client and will not appear on the directory server until the update method is called.

dn ( [ DN ] )

Set or get the DN for the entry. With no arguments dn will return the current DN. If an argument is given then it will change the DN for the entry and return the previous value.

NOTE: these changes are local to the client and will not appear on the directory server until the update method is called.

update ( [ CLIENT ] )

Update the directory server with any changes that have been made locally. This means any calls that have been made to add, replace or delete since the last call to changetype or update was made.

CLIENT should be a Net::LDAP object where the update should be sent to.

CLIENT is only optional is the Net::LDAP::Entry object was created by a search on a directory server. In which case, if omitted, the update will be sent back to the same server.

The result will be an object of type Net::LDAP::Message as returned by the add, modify or delete method called on CLIENT.

attributes

Return a list of attributes that this entry has.

get ( ATTR )

Get the values for the attribute ATTR. The result will be a reference to an array, if that attribute exists. If the attribute does not exist the undef will be returned.

changetype ( [ TYPE ] )

If called without arguments it returns the type of operation that would be performed when the update method is called. If called with an argument it will set the changetype to TYPE.

Possible values for TYPE are

add: The update method will call the add method on the client object, which will result in the entry being added to the directory server.
delete: The update method will call the delete method on the client object, which will result in the entry being removed from the directory server.
modify: The update method will call the modify method on the client object, which will result in any changes that have been made locally being made to the entry on the directory server.

AUTHOR

Graham Barr <gbarr@pobox.com>.

Please report any bugs, or post any suggestions, to the perl-ldap mailing list <perl-ldap@mail.med.cornell.edu>.

COPYRIGHT

Net::LDAP::Entry -- An LDAP entry object