com.eruces.teadmin.LdapPrincipalInfo
The LdapPrincipalInfo class is an abstract class that keeps the common attribute for all principals.
Inheritance
- Inherits com.eruces.teadmin.PrincipalInfo
Public Member Functions
| Member | Description |
|---|---|
LdapPrincipalInfo() | The LdapPrincipalInfo constructor is the default class constructor. |
LdapPrincipalInfo(long pid) | The LdapPrincipalInfo constructor specifies a principal ID. |
LdapPrincipalInfo(int sid, long pid) | The PrincipalInfo constructor specifies a system ID and a principal ID. |
String getPrincipalName() | The getPrincipalName method returns LDAP user name as principal name. |
String getName() | The getName method returns LDAP user name. |
void setName(String name) | The setName method sets a LDAP user name. |
boolean equals(Object anotherInfo) | The equals method compares two principals. |
String toString() | The toString method converts LDAP object data to a string. |
Member Function Documentation
LdapPrincipalInfo()
The LdapPrincipalInfo constructor is the default class constructor.
LdapPrincipalInfo(long pid)
The LdapPrincipalInfo constructor specifies a principal ID.
Parameters
| Parameter | Description |
|---|---|
pid | An integer representing a principal ID. type:long |
LdapPrincipalInfo(int sid, long pid)
The PrincipalInfo constructor specifies a system ID and a principal ID.
Parameters
| Parameter | Description |
|---|---|
sid | An integer representing a system ID. type:integer |
pid | An integer representing a principal ID. type:long |
String getPrincipalName()
The getPrincipalName method returns LDAP user name as principal name.
Returns: Returns a string representing a principal name.
String getName()
The getName method returns LDAP user name.
Returns: A string of user name.
void setName(String name)
The setName method sets a LDAP user name.
Parameters
| Parameter | Description |
|---|---|
name | An integer representing a principal ID. |
boolean equals(Object anotherInfo)
The equals method compares two principals.
Two LdapPrincipalInfo principals are the same if their user names or principal IDs are the same
Parameters
| Parameter | Description |
|---|---|
anotherInfo | A PrincipalInfo object to which the current PrincipalInfo object will be compared. |
Returns: Returns a boolean value indicating whether the two principals are the same; True = principals are the same, False = principals are different.
String toString()
The toString method converts LDAP object data to a string.
Returns: Returns a string representing LdapPrincipalInfo object data.
Remark: Overrides the toString method in the com.eruces.teadmin.UpdatableObject class.