|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectwt.fc.WTObject
wt.fc.Item
wt.org.WTPrincipal
wt.org.WTUser
The WTUser class represents users of the system. It holds information about the user and the groups to which he or she belongs.
Use the newWTUser
static factory method(s), not the WTUser
constructor, to construct instances of this class. Instances must be
constructed using the static factory(s), in order to ensure proper initialization
of the instance.
Supported API: true
Extendable: false
Fields inherited from class wt.org.WTPrincipal |
ALL, DISABLED, DN, INFLATED, NAME, OWNER, REPAIR_NEEDED, REPOSITORY |
Fields inherited from class wt.fc.Item |
VERSION_51_UID |
Fields inherited from class wt.fc.WTObject |
CREATE_TIMESTAMP, MODIFY_TIMESTAMP |
Fields inherited from interface wt.notify.Notifiable |
EVENT_SET |
Fields inherited from interface wt.access.AdHocControlled |
ENTRY_SET |
Fields inherited from interface wt.fc.Persistable |
IDENTITY, PERSIST_INFO, TYPE |
Fields inherited from interface wt.fc.BusinessInformation |
BUSINESS_TYPE, IDENTITY |
Fields inherited from interface wt.ufid.Federatable |
FEDERATABLE_INFO |
Fields inherited from interface wt.admin.DomainAdministered |
DOMAIN_REF, INHERITED_DOMAIN |
Fields inherited from interface wt.identity.DisplayIdentification |
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE |
Constructor Summary | |
WTUser()
|
Method Summary | |
private void |
_addValue(String name,
Object value)
|
protected void |
_mangleAuthName()
|
private void |
_setAttribute(String attrName,
Object value)
|
protected Certificate |
_translateCertificate(Object obj,
String certType)
|
private Locale |
_translateLanguage(String language)
|
private void |
_updateAttributeHolder(String attrName,
Object[] values)
|
protected void |
copyAttributes(WTPrincipal target)
Supported API: false |
boolean |
equals(Object obj)
Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifier s. |
Enumeration |
getAllCertificates()
Supported API: false |
HashMap |
getAttributeMap(String service)
Supported API: false |
AttributeHolder |
getAttributes()
Gets the object for the association that plays role: ATTRIBUTES. |
String |
getAuthenticationName()
Supported API: false |
String |
getBusinessType()
Returns string representing WTUser'sd business type. |
Certificate |
getCertificate()
Supported API: false |
String |
getConceptualClassname()
Deprecated. |
String |
getDn()
Gets the value of the attribute: DN. |
String |
getEMail()
Return the user's e-mail address. |
AclEntrySet |
getEntrySet()
Gets the value of the attribute: ENTRY_SET. |
WTStringSet |
getEventSet()
Gets the value of the attribute: EVENT_SET. |
String |
getFaxNumber()
Supported API: false |
HashMap |
getFieldValueMap()
Supported API: false |
String |
getFullName()
Supported API: false |
Locale |
getLocale()
Return the user's locale. |
String |
getMobilePhoneNumber()
Supported API: false |
String |
getOrganizationName()
Supported API: false |
String |
getPostalAddress()
Supported API: false |
String |
getRepository()
Gets the value of the attribute: REPOSITORY. |
String |
getTelephoneNumber()
Supported API: false |
URL |
getWebSite()
Supported API: false |
int |
hashCode()
Returns a hash code for this object based upon its ObjectIdentifier . |
protected void |
initialize()
Supports initialization, following construction of an instance. |
protected void |
initialize(String name)
Supports initialization, following construction of an instance. |
protected void |
initialize(String name,
DirectoryContextProvider context)
Supports initialization, following construction of an instance. |
protected void |
initialize(String name,
String dn)
Supports initialization, following construction of an instance. |
protected void |
initialize(String name,
String dn,
String service)
Supports initialization, following construction of an instance. |
void |
mapAttributes(HashMap attributes)
Supported API: false |
static WTUser |
newWTUser(String name)
Constructor: takes the user's name as sole parameter. |
static WTUser |
newWTUser(String name,
DirectoryContextProvider context)
Constructor: Constructs an instance with a specific name and organization. |
static WTUser |
newWTUser(String name,
String dn)
Supported API: true |
static WTUser |
newWTUser(String name,
String dn,
String service)
Constructor: Constructs an instance with a specific name, LDAP distinguished name, and LDAP service. |
Enumeration |
parentGroupNames()
Returns an enumeration containing the names of the groups to which the user belongs. |
Enumeration |
parentGroupObjects()
Returns all the parent groups to which the user belongs. |
Enumeration |
parentGroups()
Returns the groups to which the user belongs. |
void |
readExternal(ObjectInput input)
Reads the non-transient fields of this class from an external source. |
void |
readExternal(PersistentRetrieveIfc input)
Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store. |
private boolean |
readOldVersion(ObjectInput input,
long readSerialVersionUID,
boolean passThrough,
boolean superDone)
Reads the non-transient fields of this class from an external source, which is not the current version. |
protected boolean |
readVersion(WTUser thisObject,
ObjectInput input,
long readSerialVersionUID,
boolean passThrough,
boolean superDone)
Reads the non-transient fields of this class from an external source. |
void |
setAttributes(AttributeHolder a_Attributes)
Sets the object for the association that plays role: ATTRIBUTES. |
void |
setAuthenticationName(String authenticationName)
Supported API: false |
void |
setDisabled(boolean disabled)
Supported API: true |
void |
setDn(String dn)
Sets the value of the attribute: DN. |
void |
setEMail(String eMail)
Supported API: false |
void |
setEntrySet(AclEntrySet a_EntrySet)
Sets the value of the attribute: ENTRY_SET. |
void |
setEventSet(WTStringSet a_EventSet)
Sets the value of the attribute: EVENT_SET. |
void |
setFaxNumber(String faxNumber)
Supported API: false |
void |
setFullName(String fullName)
Supported API: false |
void |
setLocale(Locale locale)
Set the user's locale. |
void |
setMobilePhoneNumber(String mobilePhoneNumber)
Supported API: false |
void |
setOrganizationName(String organizationName)
Supported API: false |
void |
setPostalAddress(String postalAddress)
Supported API: false |
void |
setRepository(String repository)
Sets the value of the attribute: REPOSITORY. |
protected void |
setSurname(String sn)
|
void |
setTelephoneNumber(String telephoneNumber)
Supported API: false |
private void |
setWebSite(String url)
|
void |
setWebSite(URL webSite)
Supported API: false |
String |
toString()
Returns a string representation of the user object. |
void |
writeExternal(ObjectOutput output)
Writes the non-transient fields of this class to an external source. |
void |
writeExternal(PersistentStoreIfc output)
Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store. |
Methods inherited from class wt.org.WTPrincipal |
_mangleName, _setDisabled, _unmangleName, getDn, getFederatableInfo, getIdentificationObject, getIdentity, getName, getOrganization, getRepository, inflate, isDefaultDomain, isDisabled, isInflated, isRepairNeeded, readVersion, setDn, setFederatableInfo, setInflated, setName, setRepairNeeded, setRepository |
Methods inherited from class wt.fc.Item |
getDomainRef, isInheritedDomain, readVersion, setDomainRef, setInheritedDomain |
Methods inherited from class wt.fc.WTObject |
checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo |
Methods inherited from class java.lang.Object |
clone, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface wt.fc.NetFactor |
getClassInfo |
Methods inherited from interface wt.fc.Persistable |
checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo |
Field Detail |
private static final String RESOURCE
private static final String CLASSNAME
private String authenticationName
private Certificate[] certificates
private String eMail
private String faxNumber
private String fullName
private Locale locale
private String mobilePhoneNumber
private String organizationName
private String postalAddress
private String telephoneNumber
private URL webSite
public static final String ATTRIBUTES
private AttributeHolder attributes
private WTStringSet eventSet
private AclEntrySet entrySet
static final long serialVersionUID
public static final long EXTERNALIZATION_VERSION_UID
protected static final long OLD_FORMAT_VERSION_UID
private static final String INTROSPECTION_RESOURCE
protected static final long VERSION_30_UID
protected static final long VERSION_40_UID
protected static final long VERSION_50_UID
private static String defaultAdapter
private static boolean VERBOSE
public static final String AUTHENTICATION_NAME
public static final String CERTIFICATE
public static final String EMAIL
public static final String FAX_NUMBER
public static final String FULL_NAME
public static final String LOCALE
public static final String MOBILE_PHONE_NUMBER
public static final String ORGANIZATION
public static final String POSTAL_ADDRESS
public static final String SURNAME
public static final String TELEPHONE_NUMBER
public static final String WEB_SITE
public static final String[] ATTRIBUTE_NAMES
private static final String[] DIR_ATTRIBUTE_KEYS
private static final String[] DEFAULT_DIR_ATTRIBUTE_NAMES
private static HashSet attributeSet
private static Hashtable serviceMaps
Constructor Detail |
public WTUser()
Method Detail |
public void writeExternal(ObjectOutput output) throws IOException
writeExternal
in interface Externalizable
writeExternal
in class WTPrincipal
output
-
IOException
public void readExternal(ObjectInput input) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
readExternal
in class WTPrincipal
input
-
IOException
ClassNotFoundException
protected boolean readVersion(WTUser thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) throws IOException, ClassNotFoundException
thisObject
- input
- readSerialVersionUID
- passThrough
- superDone
-
IOException
ClassNotFoundException
private boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) throws IOException, ClassNotFoundException
input
- readSerialVersionUID
- passThrough
- superDone
-
IOException
ClassNotFoundException
public void writeExternal(PersistentStoreIfc output) throws SQLException, DatastoreException
(Not intended for general use.)
Supported API: false
writeExternal
in interface ObjectMappable
writeExternal
in class WTPrincipal
output
-
SQLException
DatastoreException
public void readExternal(PersistentRetrieveIfc input) throws SQLException, DatastoreException
(Not intended for general
use.)
Supported API: false
readExternal
in interface ObjectMappable
readExternal
in class WTPrincipal
input
-
SQLException
DatastoreException
public String getConceptualClassname()
getConceptualClassname
in interface NetFactor
public AttributeHolder getAttributes()
public void setAttributes(AttributeHolder a_Attributes) throws UserNotFoundException, WTPropertyVetoException
a_Attributes
-
UserNotFoundException
WTPropertyVetoException
public static WTUser newWTUser(String name) throws WTException
name
-
WTException
StandardAttributeHolder
protected void initialize(String name) throws WTException
initialize
in class WTPrincipal
name
-
WTException
public static WTUser newWTUser(String name, String dn) throws WTException
name
- dn
-
WTException
protected void initialize(String name, String dn) throws WTException
name
- dn
-
WTException
public static WTUser newWTUser(String name, String dn, String service) throws WTException
name
- dn
- service
-
WTException
protected void initialize(String name, String dn, String service) throws WTException
name
- dn
- service
-
WTException
public static WTUser newWTUser(String name, DirectoryContextProvider context) throws WTException
name
- context
-
WTException
protected void initialize(String name, DirectoryContextProvider context) throws WTException
name
- context
-
WTException
public String getAuthenticationName()
public void setAuthenticationName(String authenticationName) throws WTException
authenticationName
-
WTException
public Enumeration getAllCertificates()
public String getBusinessType()
getBusinessType
in interface BusinessInformation
getBusinessType
in class WTPrincipal
public Certificate getCertificate()
public void setDisabled(boolean disabled) throws WTException, WTPropertyVetoException
setDisabled
in class WTPrincipal
disabled
-
WTException
WTPropertyVetoException
public String getEMail() throws WTException
WTException
public void setEMail(String eMail) throws WTException, WTPropertyVetoException
eMail
-
WTException
WTPropertyVetoException
public String getFaxNumber() throws WTException
WTException
public void setFaxNumber(String faxNumber) throws WTException, WTPropertyVetoException
faxNumber
-
WTException
WTPropertyVetoException
public String getFullName()
public void setFullName(String fullName) throws WTException
fullName
-
WTException
public Locale getLocale() throws WTException
WTException
public void setLocale(Locale locale) throws WTException
locale
-
WTException
public String getMobilePhoneNumber() throws WTException
WTException
public void setMobilePhoneNumber(String mobilePhoneNumber) throws WTException, WTPropertyVetoException
mobilePhoneNumber
-
WTException
WTPropertyVetoException
public String getOrganizationName() throws WTException
WTException
public void setOrganizationName(String organizationName) throws WTException, WTPropertyVetoException
organizationName
-
WTException
WTPropertyVetoException
public String getPostalAddress() throws WTException
WTException
public void setPostalAddress(String postalAddress) throws WTException, WTPropertyVetoException
postalAddress
-
WTException
WTPropertyVetoException
public String getTelephoneNumber() throws WTException
WTException
public void setTelephoneNumber(String telephoneNumber) throws WTException, WTPropertyVetoException
telephoneNumber
-
WTException
WTPropertyVetoException
public URL getWebSite() throws WTException
WTException
public void setWebSite(URL webSite) throws WTException, WTPropertyVetoException
webSite
-
WTException
WTPropertyVetoException
public Enumeration parentGroups() throws WTException
WTException
public Enumeration parentGroupNames() throws WTException
WTException
public Enumeration parentGroupObjects() throws WTException
WTException
public String toString()
toString
in interface Principal
toString
in class WTObject
public HashMap getAttributeMap(String service) throws WTException
getAttributeMap
in class WTPrincipal
service
-
WTException
public HashMap getFieldValueMap() throws WTException
getFieldValueMap
in class WTPrincipal
WTException
public void mapAttributes(HashMap attributes) throws WTException, WTPropertyVetoException
mapAttributes
in class WTPrincipal
attributes
-
WTException
WTPropertyVetoException
protected void copyAttributes(WTPrincipal target) throws WTException, WTPropertyVetoException
copyAttributes
in class WTPrincipal
target
-
WTException
WTPropertyVetoException
public WTStringSet getEventSet()
getEventSet
in interface Notifiable
public void setEventSet(WTStringSet a_EventSet)
setEventSet
in interface Notifiable
a_EventSet
- public AclEntrySet getEntrySet()
getEntrySet
in interface AdHocControlled
public void setEntrySet(AclEntrySet a_EntrySet)
setEntrySet
in interface AdHocControlled
a_EntrySet
- public boolean equals(Object obj)
ObjectIdentifier
s.
Changed or stale copies are still considered equal by this method.
Delegates to PersistenceHelper.equals(Persistable,Object)
.
Warning: Certain core Windchill operations may depend upon
equals
being ObjectIdentifier
-based. Changes
to the default implementation should be done with care, if at all.
Supported API: false
equals
in interface Principal
equals
in class WTPrincipal
obj
-
public int hashCode()
ObjectIdentifier
.
Delegates to PersistenceHelper.hashCode(Persistable)
.
Warning: Certain core Windchill operations may depend upon
hashCode
being ObjectIdentifier-based
. Changes
to the default implementation should be done with care, if at all.
Supported API: false
hashCode
in interface Principal
hashCode
in class WTPrincipal
protected void initialize() throws WTException
initialize
in class WTPrincipal
WTException
public String getDn()
WTPrincipal
getDn
in class WTPrincipal
public void setDn(String dn)
WTPrincipal
setDn
in class WTPrincipal
dn
- public String getRepository()
WTPrincipal
getRepository
in class WTPrincipal
public void setRepository(String repository)
WTPrincipal
setRepository
in class WTPrincipal
repository
- private Locale _translateLanguage(String language)
protected void setSurname(String sn) throws WTException
WTException
private void setWebSite(String url) throws WTException
WTException
protected Certificate _translateCertificate(Object obj, String certType) throws WTException
WTException
private void _setAttribute(String attrName, Object value) throws WTException
WTException
private void _updateAttributeHolder(String attrName, Object[] values) throws WTException
WTException
private void _addValue(String name, Object value) throws WTException
WTException
protected void _mangleAuthName() throws WTException, WTPropertyVetoException
WTException
WTPropertyVetoException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |