Sun Java Communications Suite 5 Schema Reference

Root and Book Object Classes for Personal Address Book

These Object Classes describe the attributes used in the entry which serves as the base of every user's Personal Store (Address Book collection). Root entries for a user's address book store are created using the structural object class. The following object classes are used to create address book entries. These object classes include nodes for creating the address book store, contact entries, group entries and resource entries.

piStoreRoot

Supported by

Communications Express 6.2

Definition

Used to create the root node of an address book store root node for a user.

Superior Class

top

Object Class Type

structural

OID

Unknown

Required Attributes

piPStoreOwner

Allowed Attributes

piMaxStoreEntries, piDefaultAB, lastPurgeDate

piTypeBook

Supported by

Messaging Server 6.0 with LDAP Schema 2

Definition

Used to create a basic address book entry. This entry is extended by piAddressBook and piLocalBook object classes.

Superior Class

top

Object Class Type

structural

OID

Unknown

Required Attributes

piEntryID, piBookType

Allowed Attributes

displayName, multilineDescription, piLastModifiedBy

piLocalBook

Definition

Used to store the access control values for an address book entry and book type. This class is typically used to extend an address book node created using piAddressBook object class and the attributes are used to specify access control granted by a user to other users.

Superior Class

piTypeBook

Object Class Type

auxiliary

OID

Unknown

Required Attributes

None

Allowed Attributes

piReader, piWriter, piDeleter, piCreator, abBookType

piRemoteBook

Definition

Used to store the attributes necessary for a remote address book server. These are typically corporate address books shared by users and have shared and read-only access.

Superior Class

piTypeBook

Object Class Type

auxiliary

OID

Unknown

Required Attributes

piRemotePiURL

Allowed Attributes

None

piEntry

Definition

All address book entries are created using this structural object class. The basic entry can be further extended by specific object classes for users (to represent an individual contact entry) and groups (to represent an address book group).

Superior Class

top

Object Class Type

structural

OID

Unknown

Required Attributes

piEntryID

Allowed Attributes

displayName, memberOfPIGroup, multilineDescription, piLastModifiedBy, memberOfPIBook, deleted, piPEntryXMLData, piPEntryTextData, attachment

piTypePerson

Definition

Used to extend the base entry created by piEntry. Entries extended using this object class are used to represent an individual contact entry.

Superior Class

piEntry

Object Class Type

structural

OID

Unknown

Required Attributes

None

Allowed Attributes

piBackPointer, givenName, sn, middleName, nickname, jobTitle, company, ou, campus, building, floor, officeNumber, piPhone1, piPhone2, piPhone3,piPhone4,piPhone5, piPhone1Type,piPhone2Type,piPhone3Type,piPhone4Type,piPhone5Type,piAdditionalPhone,piEmail1,piEmail2,piEmail3,piEmail1Type,piEmail2Type,piEmail3Type,piEmail1CN,piEmail2CN,piEmail3CN,piEmail1TransType,piEmail2TransType,piEmail3TransType,piWebsite1,piWebsite2,piWebsite1Descr,piWebsite2Descr,inetCalendar,inetFreeBusy,piIM1ID,piIM2ID,piIM3ID,piIM1Service,piIM2Service,piIM3Service,homePostalAdddress,homeCity,homeState,homePostalCode,homeCountry,homePOBox,workPostalAddress,workCity,workState,workPostalCode,workCountry,workPOBox,otherPostalAddress,otherCity,otherState,otherPostalCode,otherCountry,otherPOBox,anniversary,dateOfBirthotherDate,otherDateDescr,mailingAddress,photoURL,notes,assistantName,department,fullName,gender,location,manager,profession,spouse,suffix,title,alarmflag,alarmstatus,alarmtime,alarmtopic

piTypeGroup

Definition

Used to extend the base entry created by piEntry. Entries extended using this object class are used to represent an address book group entry.

Superior Class

piEntry

Object Class Type

structural

Required Attributes

None

Allowed Attributes

piEmail1, piWebsite1, piWebsite1Descr,inetCalendar,inetFreeBusy

piTypeABConferenceRoom

Definition

Used to create an entry to represent a conference room entry. This object class is intended to be used for entries in the users’ personal address book store. The corresponding object class used in the corporate LDAP to represent a generic resource entry (including a conference room) is icsCalendarResource.

Since users may find resources in the corporate LDAP directory and decide to add them to their personal address book, you need to map the values from icsCalendarResource to the attributes in piTypeABConferenceRoom. As of now, calendar server has no typing information in the icsCalendarResource entry to indicate what type of resource is represented by LDAP entry. Hence we should assume that the corporate entry is for a conference room. The following table shows the mapping of attributes.

Table 7–1 Mapping of attributes

icsCalendarResouce

piTypeABConferenceRoom/piEntry

cn

displayName

description

multilineDescription

icsCapacity

sunConfRoomCapacity

none 

campus

none 

building

none 

floor

none 

officeNumber

icsCalendar

inetCalendar

none 

inetFreeBusy

icsContact

contactPerson

Superior Class

piEntry

Object Class Type

structural

OID

Unknown

Required Attributes

None

Allowed Attributes

telephoneNumber, sunConfRoomCapacity, building,floor,officeNumber,inetCalendar,contactPerson