ERUCES::TETrustedServerInfo
#include <tetrustedserver.h>
The TETrustedServerInfo class provides methods for maintaining Trusted Server information.
It is derived from the TEUpdatableObject class.
Inheritance
- Inherits ERUCES::TEUpdatableObject
Private Static Attrib
| Type | Name | Description |
|---|---|---|
| _TESTD string | CLASSNAME |
Public Member Functions
| Member | Description |
|---|---|
TETrustedServerInfo() | The TETrustedServerInfo constructor is the default class constructor. |
TETrustedServerInfo(const TETrustedServerInfo &) | The TETrustedServerInfo constructor copies a TETrustedServerInfo object. |
~TETrustedServerInfo() | The TETrustedServerInfo destructor is the class destructor. |
void setFriendlyName(const _TESTD string &name) | The setFriendlyName method sets the common name of a trusted server. |
const _TESTD string getFriendlyName() const | The getFriendlyName method gets a trusted server's common name. |
void setServerName(const _TESTD string &name) | The setServerName method sets the name of a trusted server. |
const _TESTD string getServerName() const | The getServerName method gets the name of a trusted server. |
void setPort(const uint32_t port) | The setPort method sets a trusted server port number. |
uint32_t getPort() const | The getPort method gets a trusted server's port number. |
void setPrincipalID(const uint32_t id) | The setPrincipalID method sets the principal ID for a certificate owned by a trusted server. |
te_oid getPrincipalID() const | The getPrincipalID method gets the principal ID of a certificate owned by a trusted server. |
void setSystemID(const uint32_t sid) | The setSystemID method sets the system ID of a certificate owned by a trusted server. |
uint32_t getSystemID() const | The getSystemID method gets the system ID of a certificate owned by a trusted server. |
void setDescription(const _TESTD string &desc) | The setDescription method sets the description of a trusted server. |
const _TESTD string getDescription() const | The getDescription method gets a description of a trusted server. |
const _TESTD string getClassName() const | The getClassName method gets the name of the TETrustedServerInfo class. |
TEObject * clone() const | The clone method clones a TETrustedServerInfo object. |
void getCertObject(TECertObjectInfo &cert) const | The getCertObject method gets a certificate owned by the trusted server. |
void getTransportPrincipal(TETransportPrincipalInfo &principal) const | The getTransportPrincipal method gets a TETRansportPrincipalInfo object. This is used to build a connection between two servers. |
Member Function Documentation
TETrustedServerInfo()
The TETrustedServerInfo constructor is the default class constructor.
TETrustedServerInfo(const TETrustedServerInfo &)
The TETrustedServerInfo constructor copies a TETrustedServerInfo object.
~TETrustedServerInfo()
The TETrustedServerInfo destructor is the class destructor.
void setFriendlyName(const _TESTD string &name)
The setFriendlyName method sets the common name of a trusted server.
Parameters
| Parameter | Description |
|---|---|
name | A string representing a trusted server's common name. |
const _TESTD string getFriendlyName() const
The getFriendlyName method gets a trusted server's common name.
Returns: Returns a string representing a trusted server's common name.
void setServerName(const _TESTD string &name)
The setServerName method sets the name of a trusted server.
Parameters
| Parameter | Description |
|---|---|
name | A string representing the trusted server's name. |
const _TESTD string getServerName() const
The getServerName method gets the name of a trusted server.
Returns: Returns a string representing the name of a Trusted Server.
void setPort(const uint32_t port)
The setPort method sets a trusted server port number.
Parameters
| Parameter | Description |
|---|---|
port | An integer representing the port number. |
uint32_t getPort() const
The getPort method gets a trusted server's port number.
Returns: Returns an integer representing the port number.
void setPrincipalID(const uint32_t id)
The setPrincipalID method sets the principal ID for a certificate owned by a trusted server.
Parameters
| Parameter | Description |
|---|---|
id | An integer representing the certificate's principal ID |
te_oid getPrincipalID() const
The getPrincipalID method gets the principal ID of a certificate owned by a trusted server.
Returns: An integer representing the certificate's principal ID.
void setSystemID(const uint32_t sid)
The setSystemID method sets the system ID of a certificate owned by a trusted server.
Parameters
| Parameter | Description |
|---|---|
sid | An integer representing the certificate's system ID. |
uint32_t getSystemID() const
The getSystemID method gets the system ID of a certificate owned by a trusted server.
Returns: An integer representing the certificate's system ID.
void setDescription(const _TESTD string &desc)
The setDescription method sets the description of a trusted server.
Parameters
| Parameter | Description |
|---|---|
desc | A string representin a description of the trusted server. |
const _TESTD string getDescription() const
The getDescription method gets a description of a trusted server.
Returns: Returns a string representing a Trusted Server's description.
const _TESTD string getClassName() const
The getClassName method gets the name of the TETrustedServerInfo class.
Returns: Returns a string representing the name of the TETrustedServerInfo class.
TEObject * clone() const
The clone method clones a TETrustedServerInfo object.
Returns: TETrustedServerInfo object
void getCertObject(TECertObjectInfo &cert) const
The getCertObject method gets a certificate owned by the trusted server.
Parameters
| Parameter | Description |
|---|---|
cert | certificate object |
See also: TECertObjectInfo
void getTransportPrincipal(TETransportPrincipalInfo &principal) const
The getTransportPrincipal method gets a TETRansportPrincipalInfo object. This is used to build a connection between two servers.
Parameters
| Parameter | Description |
|---|---|
principal | A TETransportPrincipalInfo transport principal object |
See also: TETransportPrincipalInfo