ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
TLDAPServer Class Reference

Definition at line 27 of file TLDAPServer.h.

Public Member Functions

 TLDAPServer (const char *host, Int_t port=LDAP_PORT, const char *binddn=0, const char *password=0, Int_t version=LDAP_VERSION2)
 
virtual ~TLDAPServer ()
 If the object is connected to the server, it disconnects. More...
 
Bool_t IsConnected () const
 
TLDAPResultSearch (const char *base="", Int_t scope=LDAP_SCOPE_BASE, const char *filter=0, TList *attrs=0, Bool_t attrsonly=0)
 Performs searching at the LDAP directory. More...
 
const char * GetNamingContexts ()
 Performs an LDAPSearch with the attribute "namingContexts" to be returned with the result. More...
 
const char * GetSubschemaSubentry ()
 Performs an LDAPSearch with the attribute "subschemaSubentry" to be returned with the result. More...
 
TLDAPResultGetObjectClasses ()
 Calls GetSubschemaSubentry() and performs and LDAPSearch with the attribute "objectClasses" to be returned with the result. More...
 
TLDAPResultGetAttributeTypes ()
 Calls GetSubschemaSubentry() and performs and LDAPSearch with the attribute "attributeTypes" to be returned with the result. More...
 
Int_t AddEntry (TLDAPEntry &entry)
 Adds entry to the LDAP tree. More...
 
Int_t ModifyEntry (TLDAPEntry &entry, Int_t mode=LDAP_MOD_REPLACE)
 Modifies specified entry. More...
 
Int_t DeleteEntry (const char *dn)
 Deletes the entry with specified DN, the base entry must exist. More...
 
Int_t RenameEntry (const char *dn, const char *newrdn, Bool_t removeattr=kFALSE)
 Renames the entry with specified DN, the entry must be leaf Be sure that you are bound with the write permissions Return value: LDAP error code, 0 = succes char *dn: Distinguished name of entry to be renamed. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Protected Member Functions

 TLDAPServer (const TLDAPServer &)
 Copy constructor. More...
 
TLDAPServeroperator= (const TLDAPServer &)
 Equal operator. More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Private Member Functions

Int_t Bind ()
 Binds to the server with specified binddn and password. More...
 
void Unbind ()
 Unbinds from the server with specified binddn and password. More...
 

Static Private Member Functions

static void DeleteMods (LDAPMod **mods)
 Deletes the array of LDAPMod structures and frees its memory. More...
 

Private Attributes

LDAP * fLd
 
TString fBinddn
 
TString fPassword
 
Bool_t fIsConnected
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TLDAPServer.h>

+ Inheritance diagram for TLDAPServer:
+ Collaboration diagram for TLDAPServer:

Constructor & Destructor Documentation

TLDAPServer::TLDAPServer ( const TLDAPServer lds)
protected

Copy constructor.

Definition at line 60 of file TLDAPServer.cxx.

TLDAPServer::TLDAPServer ( const char *  host,
Int_t  port = LDAP_PORT,
const char *  binddn = 0,
const char *  password = 0,
Int_t  version = LDAP_VERSION2 
)
TLDAPServer::~TLDAPServer ( )
virtual

If the object is connected to the server, it disconnects.

Definition at line 86 of file TLDAPServer.cxx.

Member Function Documentation

Int_t TLDAPServer::AddEntry ( TLDAPEntry entry)

Adds entry to the LDAP tree.

Be sure that you are bound with write permissions. Return value: LDAP error code.

Definition at line 298 of file TLDAPServer.cxx.

Int_t TLDAPServer::Bind ( )
private

Binds to the server with specified binddn and password.

Return value: LDAP error code, 0 if successfully bound.

Definition at line 95 of file TLDAPServer.cxx.

Referenced by AddEntry(), DeleteEntry(), ModifyEntry(), and Search().

Int_t TLDAPServer::DeleteEntry ( const char *  dn)

Deletes the entry with specified DN, the base entry must exist.

Be sure that you are bound with write permissions. Return value: LDAP error code, 0 = succes.

Definition at line 352 of file TLDAPServer.cxx.

void TLDAPServer::DeleteMods ( LDAPMod **  mods)
staticprivate

Deletes the array of LDAPMod structures and frees its memory.

LDAPMod **mods: Pointer to the zero-terminated array of pointers to LDAPMod structures

Definition at line 400 of file TLDAPServer.cxx.

Referenced by AddEntry(), and ModifyEntry().

TLDAPResult * TLDAPServer::GetAttributeTypes ( )

Calls GetSubschemaSubentry() and performs and LDAPSearch with the attribute "attributeTypes" to be returned with the result.

The returned result object must be deleted by the user.

Definition at line 215 of file TLDAPServer.cxx.

const char * TLDAPServer::GetNamingContexts ( )

Performs an LDAPSearch with the attribute "namingContexts" to be returned with the result.

The value of this attribute is extracted and returned as const char.

Definition at line 137 of file TLDAPServer.cxx.

TLDAPResult * TLDAPServer::GetObjectClasses ( )

Calls GetSubschemaSubentry() and performs and LDAPSearch with the attribute "objectClasses" to be returned with the result.

The returned result object must be deleted by the user.

Definition at line 195 of file TLDAPServer.cxx.

const char * TLDAPServer::GetSubschemaSubentry ( )

Performs an LDAPSearch with the attribute "subschemaSubentry" to be returned with the result.

The value of this attribute is extracted and returned as const char.

Definition at line 166 of file TLDAPServer.cxx.

Referenced by GetAttributeTypes(), and GetObjectClasses().

Bool_t TLDAPServer::IsConnected ( ) const
inline

Definition at line 51 of file TLDAPServer.h.

Referenced by AddEntry(), Bind(), DeleteEntry(), ModifyEntry(), RenameEntry(), Search(), and Unbind().

Int_t TLDAPServer::ModifyEntry ( TLDAPEntry entry,
Int_t  mode = LDAP_MOD_REPLACE 
)

Modifies specified entry.

Be sure that you are bound with write permissions. Return value: LDAP error code, 0 = success. TLDAPEntry &entry: Entry to be modified. Int_t mode: Modifying mode. Should be one of LDAP_MOD_ADD (==0), LDAP_MOD_DELETE (==1) or LDAP_MOD_REPLACE (==2) Specifies what to do with all the entry's attributes and its values - add to the corresponding entry on the server, delete from it, or replace the corresponding attributes with new values

Definition at line 329 of file TLDAPServer.cxx.

TLDAPServer & TLDAPServer::operator= ( const TLDAPServer lds)
protected

Equal operator.

Definition at line 72 of file TLDAPServer.cxx.

Int_t TLDAPServer::RenameEntry ( const char *  dn,
const char *  newrdn,
Bool_t  removeattr = kFALSE 
)

Renames the entry with specified DN, the entry must be leaf Be sure that you are bound with the write permissions Return value: LDAP error code, 0 = succes char *dn: Distinguished name of entry to be renamed.

This entry must be a leaf in the LDAP directory tree. char *newrdn: The new relative distinguished name to give the entry being renamed. Bool_t removeattr: This parameter specifies whether or not the attribute values in the old relative distinguished name should be removed from the entry or retained as non-distinguished attributes.

Definition at line 381 of file TLDAPServer.cxx.

TLDAPResult * TLDAPServer::Search ( const char *  base = "",
Int_t  scope = LDAP_SCOPE_BASE,
const char *  filter = 0,
TList attrs = 0,
Bool_t  attrsonly = 0 
)

Performs searching at the LDAP directory.

Return value: a TLDAPResult object or 0 in case of error. Result needs to be deleted by user. const char *base: Specifies the base object for the search operation Int_t scope: Specifies the portion of the LDAP tree, relative to the base object, to search. Must be one of LDAP_SCOPE_BASE (==0), LDAP_SCOPE_ONELEVEL (==1) or LDAP_SCOPE_SUBTREE (==2). char *filter: The criteria during the search to determine which entries to return, 0 means that the filter "(objectclass=*)" will be applied TList *attrs: The TList of attributes to be returned along with each entry, 0 means that all available attributes should be returned. Int_t attrsonly: This parameter is a boolean specifying whether both types and values should be returned with each attribute (zero) or types only should be returned (non-zero).

Definition at line 250 of file TLDAPServer.cxx.

Referenced by GetAttributeTypes(), GetNamingContexts(), GetObjectClasses(), and GetSubschemaSubentry().

void TLDAPServer::Unbind ( )
private

Unbinds from the server with specified binddn and password.

Definition at line 124 of file TLDAPServer.cxx.

Referenced by ~TLDAPServer().

Member Data Documentation

TString TLDAPServer::fBinddn
private

Definition at line 31 of file TLDAPServer.h.

Referenced by Bind(), and operator=().

Bool_t TLDAPServer::fIsConnected
private

Definition at line 33 of file TLDAPServer.h.

Referenced by Bind(), IsConnected(), operator=(), and Unbind().

LDAP* TLDAPServer::fLd
private

Definition at line 30 of file TLDAPServer.h.

Referenced by AddEntry(), Bind(), DeleteEntry(), ModifyEntry(), operator=(), RenameEntry(), Search(), and Unbind().

TString TLDAPServer::fPassword
private

Definition at line 32 of file TLDAPServer.h.

Referenced by Bind(), and operator=().


The documentation for this class was generated from the following files: