OSB_LIB::UimCard Class Reference

Inheritance diagram for OSB_LIB::UimCard:

[legend]Collaboration diagram for OSB_LIB::UimCard:

[legend]List of all members.

---

Detailed Description

Support for UIM cards: User Identity Module.

See also:

DeviceItem: Devices as product parts.

PersUimCard: UIM cards as subscribed product part.

Todo:

Currently (May-06) is not clear if the class should be derived from a base class Equipment and, if so, what would be the interface of such a base class.

Definition at line 76 of file uimcard.h.

Public Member Functions

• UimCard (const Oid &oid=Oid())

  Constructor with optional object id.
  

• Type type () const

  Get the device type.
  

• const ImsiResource & imsi () const

  @ name Read access to attributes: IMSI of the UIM card.
  

• const std::string & iccId () const

  Integrated Circuit Card IDentifier.
  

• const std::string & uimId () const

  Electronic identification number unique to the UIM card.
  

• const std::string & pin1 () const

  The card PIN1 as received from the card vendor.
  

• const std::string & pin2 () const

  The card PIN2 as received from the card vendor.
  

• const std::string & puk1 () const

  The Personal Unlock Key 1 of the card.
  

• const std::string & puk2 () const

  The Personal Unlock Key 2 of the card.
  

• void read (const OSB_DB::Session &session)

  @ name Database operations: Read the UIM card from the database.
  

• void saveData (const OSB_DB::Session &session, bool noWait)

  Update UIM card data to the database.
  

• void remove (const OSB_DB::Session &session, bool noWait)

  Delete the UIM card from the database.
  

Static Public Attributes

• static const Type type_

  The device type.
  

Private Attributes

• std::string uimId_

  Electronic identification number.
  

• ImsiResource imsi_

  Attached IMSI.
  

• std::string iccId_

  Integrated Circuit Card IDentifier.
  

• std::string pin1_

  The card PIN1 as received from the card vendor.
  

• std::string pin2_

  The card PIN2 as received from the card vendor.
  

• std::string puk1_

  The Personal Unlock Key 1 of the card.
  

• std::string puk2_

  The Personal Unlock Key 2 of the card.
  

Friends

• class UimCardCreator

  Allow to set the data members.
  

• class OSB_DB::UimCardGw

  Allow to set the data members.
  

---

Constructor & Destructor Documentation

OSB_LIB::UimCard::UimCard

(

const Oid &

oid = Oid()

)

Constructor with optional object id.

---

Member Function Documentation

const std::string& OSB_LIB::UimCard::iccId

(

)

const

Integrated Circuit Card IDentifier.

The 18 to 20-digit serial number of the UIM card.

const ImsiResource& OSB_LIB::UimCard::imsi

(

)

const

@ name Read access to attributes: IMSI of the UIM card.

This is International Mobile Subscriber Identity attached to the UIM card.

const std::string& OSB_LIB::UimCard::pin1

(

)

const

The card PIN1 as received from the card vendor.

const std::string& OSB_LIB::UimCard::pin2

(

)

const

The card PIN2 as received from the card vendor.

const std::string& OSB_LIB::UimCard::puk1

(

)

const

The Personal Unlock Key 1 of the card.

const std::string& OSB_LIB::UimCard::puk2

(

)

const

The Personal Unlock Key 2 of the card.

void OSB_LIB::UimCard::read

(

const OSB_DB::Session &

session

)

[virtual]

@ name Database operations: Read the UIM card from the database.

Parameters:

session

Database session to use.

Exceptions:

OsbException

if the device as identified by oid() does not exist in the database.

Implements OSB_LIB::Device.

void OSB_LIB::UimCard::remove	(	const OSB_DB::Session &	session,
		bool	noWait
	)			[virtual]

Delete the UIM card from the database.

Parameters:

	session	Database session to use.
	noWait	Don't wait for database locks?

Exceptions:

	OsbException	from lock().
	OsbException	if deletion of the IMSI fails.

Deletes the UIM card and the attached IMSI.

Implements OSB_LIB::Device.

void OSB_LIB::UimCard::saveData	(	const OSB_DB::Session &	session,
		bool	noWait
	)			[virtual]

Update UIM card data to the database.

Parameters:

	session	Database session to use.
	noWait	Don't wait for database locks?

Exceptions:

	OsbException	from insertBase().
	OsbException	from updDataBase().
	OsbException	if the own insert or update fails.
	OsbException	if the insert or update of the IMSI fails.

The function only updates PIN 1, PIN 2 and the attached IMSI.

Implements OSB_LIB::Device.

Type OSB_LIB::UimCard::type

(

)

const [virtual]

Get the device type.

Implements OSB_LIB::Device.

const std::string& OSB_LIB::UimCard::uimId

(

)

const

Electronic identification number unique to the UIM card.

This is a up-to 14 hexadecimal digit string.

The UIM ID is unrelated to both the ICCID and to the ESN/MEID of any host equipment to which the UIM card may be attached (from 3GPP2 C.S0023-B).

---

Friends And Related Function Documentation

friend class OSB_DB::UimCardGw [friend]

Allow to set the data members.

Definition at line 85 of file uimcard.h.

friend class UimCardCreator [friend]

Allow to set the data members.

It is assumed that the creator knows the valid formats and performs the necessary checks for the fields.

Definition at line 83 of file uimcard.h.

---

Member Data Documentation

std::string OSB_LIB::UimCard::iccId_ [private]

Integrated Circuit Card IDentifier.

See iccId() for details.

Definition at line 203 of file uimcard.h.

ImsiResource OSB_LIB::UimCard::imsi_ [private]

Attached IMSI.

Definition at line 197 of file uimcard.h.

std::string OSB_LIB::UimCard::pin1_ [private]

The card PIN1 as received from the card vendor.

Definition at line 207 of file uimcard.h.

std::string OSB_LIB::UimCard::pin2_ [private]

The card PIN2 as received from the card vendor.

Definition at line 211 of file uimcard.h.

std::string OSB_LIB::UimCard::puk1_ [private]

The Personal Unlock Key 1 of the card.

Definition at line 215 of file uimcard.h.

std::string OSB_LIB::UimCard::puk2_ [private]

The Personal Unlock Key 2 of the card.

Definition at line 219 of file uimcard.h.

const Type OSB_LIB::UimCard::type_ [static]

The device type.

Definition at line 88 of file uimcard.h.

std::string OSB_LIB::UimCard::uimId_ [private]

Electronic identification number.

See uimId() for details.

Definition at line 193 of file uimcard.h.

---

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

• uimcard.h

---