• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KIO

KIO::NetRC

KIO::NetRC Class Reference

A Singleton class that provides access to passwords stored in .netrc files for automatic login purposes. More...

#include <authinfo.h>

List of all members.

Classes

struct  AutoLogin
 Contains auto login information. More...

Public Types

enum  LookUpModeFlag { exactOnly = 0x0002, defaultOnly = 0x0004, presetOnly = 0x0008 }

Public Member Functions

bool lookup (const KUrl &url, AutoLogin &login, bool userealnetrc=false, const QString &type=QString(), LookUpMode mode=LookUpMode(exactOnly)|defaultOnly)
void reload ()

Static Public Member Functions

static NetRC * self ()

Protected Member Functions

QString extract (const char *, const char *, int &)
int openf (const QString &)
bool parse (int)

Detailed Description

A Singleton class that provides access to passwords stored in .netrc files for automatic login purposes.

This is only meant to address backward compatibility with old automated ftp client style logins...

An interface to the ftp .netrc files

Author:
Dawit Alemayehu <adawit@kde.org>

Definition at line 309 of file authinfo.h.


Member Enumeration Documentation

enum KIO::NetRC::LookUpModeFlag

Specifies the mode to be used when searching for a matching automatic login info for a given site :.

  • exactOnly search entries with exact host name matches.
  • defaultOnly search entries that are specified as "default".
  • presetOnly search entries that are specified as "preset".
See also:
lookup
Enumerator:
exactOnly 
defaultOnly 
presetOnly 

Definition at line 323 of file authinfo.h.


Member Function Documentation

QString NetRC::extract ( const char *  buf,
const char *  key,
int &  pos 
) [protected]

Definition at line 374 of file authinfo.cpp.

bool NetRC::lookup ( const KUrl &  url,
AutoLogin &  login,
bool  userealnetrc = false,
const QString &  type = QString(),
LookUpMode  mode = LookUpMode(exactOnly) | defaultOnly 
)

Looks up the login information for the given url.

Parameters:
url the url whose login information will be checked
login the login information will be writte here
userealnetrc if true, use $HOME/.netrc fle
type the type of the login. If null, the url's protocol will be taken
mode the LookUpMode flags (ORed) for the query

Definition at line 278 of file authinfo.cpp.

int NetRC::openf ( const QString &  f  )  [protected]

Definition at line 360 of file authinfo.cpp.

bool NetRC::parse ( int  fd  )  [protected]

Definition at line 409 of file authinfo.cpp.

void NetRC::reload (  ) 

Reloads the auto login information.

Definition at line 355 of file authinfo.cpp.

NetRC * NetRC::self (  )  [static]

A reference to the instance of the class.

Returns:
the class

Definition at line 271 of file authinfo.cpp.


The documentation for this class was generated from the following files:
  • authinfo.h
  • authinfo.cpp

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal