Skip to main content

ERUCES::TEUnixPrincipalInfo

#include <teunixprincipal.h>

The TEUnixPrincipalInfo class represents a user authenticated by Unix-based authentication protocols.

This class is derived from the TEPrincipalInfo class.

Inheritance

Public Types

enum TE_UNIX_PRINCIPAL_TYPE

Unix principal type enumation.

ValueDescription
UNSPECIFIEDUnspecified type of unix principal
NIS_PRINCIPALNIS (Network Information System) user

Static Public Attributes

TypeNameDescription
_TESTD stringCLASSNAME

Public Member Functions

MemberDescription
TEUnixPrincipalInfo()The TEUnixPrincipalInfo constructor is the default class constructor.
TEUnixPrincipalInfo(const TEUnixPrincipalInfo &)The TEUnixPrincipalInfo constructor copies a TEUnixPrincipalInfo object.
TEUnixPrincipalInfo(TE_UNIX_PRINCIPAL_TYPE)The TEUnixPrincipalInfo constructor with given Unix principal type.
~TEUnixPrincipalInfo()The TEUnixPrincipalInfo destructor is the class destructor.
const _TESTD string getPrincipalName() constThe getPrincipalName method gets a principal name.
void setName(const _TESTD string &name)The setName method sets a Unix principal name.
const _TESTD string getName() constThe getName method gets a Unix principal name.
void setType(const TE_UNIX_PRINCIPAL_TYPE type)The setType method sets a Unix principal type.
const TE_UNIX_PRINCIPAL_TYPE getType() constThe getType method gets a Unix principal type.
const _TESTD string getClassName() constThe getClassName method gets a TEUnixPrincipalInfo object's class name.
TEObject * clone() constThe clone method clones a TEUnixPrincipalInfo object.

Member Function Documentation

TEUnixPrincipalInfo()

The TEUnixPrincipalInfo constructor is the default class constructor.

TEUnixPrincipalInfo(const TEUnixPrincipalInfo &)

The TEUnixPrincipalInfo constructor copies a TEUnixPrincipalInfo object.

TEUnixPrincipalInfo(TE_UNIX_PRINCIPAL_TYPE)

The TEUnixPrincipalInfo constructor with given Unix principal type.

~TEUnixPrincipalInfo()

The TEUnixPrincipalInfo destructor is the class destructor.

const _TESTD string getPrincipalName() const

The getPrincipalName method gets a principal name.

Returns: Returns a string representing a principal name.

void setName(const _TESTD string &name)

The setName method sets a Unix principal name.

Parameters

ParameterDescription
nameA string representing the Unix principal name to be set.

const _TESTD string getName() const

The getName method gets a Unix principal name.

Returns: Returns a string representing a username.

void setType(const TE_UNIX_PRINCIPAL_TYPE type)

The setType method sets a Unix principal type.

Parameters

ParameterDescription
typeA integer representing the Unix principal type to be set. See TE_UNIX_PRINCIPAL_TYPE.

const TE_UNIX_PRINCIPAL_TYPE getType() const

The getType method gets a Unix principal type.

Returns: Returns a integer representing the Unix principal type. See UNIX_PRINCIPAL_TYPE.

const _TESTD string getClassName() const

The getClassName method gets a TEUnixPrincipalInfo object's class name.

Returns: Returns the class name of a TEUnixPrincipalInfo object.

TEObject * clone() const

The clone method clones a TEUnixPrincipalInfo object.

Returns: Returns a cloned TEUnixPrincipalInfo object.