Name (Java™)

Represents a user or server name.

Syntax

public class Name extends Base

Containment

Contained by: AgentContext and Session

Properties

Abbreviated through getAbbreviated

Addr821 through getAddr821

Addr822Comment1 through getAddr822Comment1

Addr822Comment2 through getAddr822Comment2

Addr822Comment3 through getAddr822Comment3

Addr822LocalPart through getAddr822LocalPart

Addr822Phrase through getAddr822Phrase

ADMD through getADMD

Canonical through getCanonical

Common through getCommon

Country through getCountry

Generation through getGeneration

Given through getGiven

Initials through getInitials

IsHierarchical through isHierarchical

Keyword through getKeyword

Language through getLanguage

Organization through getOrganization

OrgUnit1 through getOrgUnit1

OrgUnit2 through getOrgUnit2

OrgUnit3 through getOrgUnit3

OrgUnit4 through getOrgUnit4

Parent through getParent

PRMD through getPRMD

Surname through getSurname

Methods

recycle

toString

Creation

To create a new Name object, use createName in Session.

Usage

A canonical hierarchical name is a series of components separated by slashes. Each component starts with a keyword and equals sign. Domino® names use the following components: CN (common name), OU (organizational unit - up to four are permitted), O (organization), and C (country). Domino® names do not use the following components but this class recognizes them: G (given name), I (initial), S (surname), Q (generation; for example, "Jr"), A (ADMD name), and P (PRMD name).

Below is an example of a Domino® hierarchical name in canonical format. It uses two of the available organizational units. The hierarchy is right to left, so East is organizational unit 1 and Sales is organizational unit 2.

CN=John B Goode/OU=Sales/OU=East/O=Acme/C=US

An abbreviated name is a series of components separated by slashes. The components are not identified by keyword but depend on order for identification. The preceding name in abbreviated format is as follows:

John B Goode/Sales/East/Acme/US

This class does not abbreviate a canonical name if the abbreviation would be ambiguous. For example, "CN=John B Goode/OU=East" cannot be abbreviated because "East" would appear to be the organization (rather than an organizational unit). This class also does not abbreviate a canonical name if it contains any of the components not used in Domino® names.

A specification of an abbreviated name can include only those components used in Domino® names. The components must be in proper sequence. The following are acceptable:

  • common name/country
  • common name/organization (unless the name of the organization is identical to a country code)
  • common name/organization/country
  • common name/organizational unit/organization/country (up to four organizational units)

A common name by itself is interpreted as a flat name. A common name followed by a slash receives the organizational and country information of the effective user.

A name that conforms to RFC 821 or RFC 822 is interpreted as an Internet address. Examples of Internet addresses are as follows:

  • jbg@us.acme.com
  • "John B Goode" <jbg@us.acme.com>
  • "John B Goode" <jbg@us.acme.com> (Sales) (East)

Use getUserNameList and getUserNameObject in Session to get the primary and alternate names for the current Domino® user. Use getUserName and getCommonUserName in Session to get the full user name and common user name in String format.

Example