|
|||||||||||
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
wt.federation.ProxyUser
Use the newProxyUser
static factory method(s), not the ProxyUser
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
Field Summary | |
private DirectoryAttributeHolder |
attributes
|
private static String |
CLASSNAME
|
static String |
E_MAIL
Label for the attribute. |
private static int |
E_MAIL_UPPER_LIMIT
|
private String |
eMail
|
private long |
expirationTime
|
static long |
EXTERNALIZATION_VERSION_UID
|
private Vector |
groups
|
private static Class |
GroupUserLinkClass
|
protected static long |
OLD_FORMAT_VERSION_UID
|
static String |
PREFERRED_LANGUAGE
Label for the attribute. |
private static int |
PREFERRED_LANGUAGE_UPPER_LIMIT
|
private String |
preferredLanguage
|
private long |
refreshTime
|
private static String |
RESOURCE
|
(package private) static long |
serialVersionUID
|
private FederatedService |
service
|
private ServiceIdentifier |
serviceId
|
private String |
sourceObjectId
|
private String |
sourceURL
|
private static boolean |
VERBOSE
|
private static Class |
WTUserClass
|
Fields inherited from class wt.org.WTUser |
ATTRIBUTE_NAMES, ATTRIBUTES, AUTHENTICATION_NAME, CERTIFICATE, EMAIL, FAX_NUMBER, FULL_NAME, LOCALE, MOBILE_PHONE_NUMBER, ORGANIZATION, POSTAL_ADDRESS, SURNAME, TELEPHONE_NUMBER, VERSION_30_UID, VERSION_40_UID, VERSION_50_UID, WEB_SITE |
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.federation.Federated |
EXPIRATION_TIME, REFRESH_TIME, SERVICE_ID, SOURCE_OBJECT_ID, SOURCE_URL |
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 | |
ProxyUser()
No-argument constructor returning an initialized instance of the class. |
Method Summary | |
protected void |
addGroup(WTGroup group)
Adds a group to the list of user's groups. |
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. |
QueryResult |
findLinks(Class targetLinkClass,
String obj1Role,
Persistable obj2)
Return all link objects that exist between the Federated object and the specified source object. |
AttributeHolder |
getAttributes()
Gets the object for the association that plays role: ATTRIBUTES. |
String |
getConceptualClassname()
Deprecated. |
private void |
getDirectoryAttributes()
Retrieve the contents of the directory attribute holder. |
String |
getEMail()
Gets the value of the attribute: E_MAIL. |
long |
getExpirationTime()
Gets the value of the attribute: EXPIRATION_TIME. |
Locale |
getLocale()
Set the locale property from a directory attribute value contained in the attribute holder. |
String |
getPreferredLanguage()
Gets the value of the attribute: PREFERRED_LANGUAGE. |
long |
getRefreshTime()
Gets the value of the attribute: REFRESH_TIME. |
FederatedService |
getService()
Return the service object referenced by the serviceId attribute. |
ServiceIdentifier |
getServiceId()
Gets the object for the association that plays role: SERVICE_ID. |
String |
getSourceObjectId()
Gets the value of the attribute: SOURCE_OBJECT_ID. |
String |
getSourceURL()
Gets the value of the attribute: SOURCE_URL. |
int |
hashCode()
Returns a hash code for this object based upon its ObjectIdentifier . |
protected void |
initialize(String name)
Supports initialization, following construction of an instance. |
protected void |
initialize(String name,
ServiceIdentifier serviceId,
String sourceObjectId)
Supports initialization, following construction of an instance. |
QueryResult |
navigate(String role,
Class linkClass,
boolean onlyOtherSide)
Return objects related to this federated source object given a role and link class. |
QueryResult |
navigate(String role,
QuerySpec criteria,
boolean onlyOtherSide)
Return objects related to this federated source object given a role and link selection crtieria. |
static ProxyUser |
newProxyUser(String name)
Supported API: false |
static ProxyUser |
newProxyUser(String name,
ServiceIdentifier serviceId,
String sourceObjectId)
Supported API: false |
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 |
postStore()
The persistence manager calls this method just after storing the proxy object in the database. |
void |
prepareForStore()
The persistence manager calls this method just before storing the proxy object in the database. |
void |
preset()
This method is called when a proxy object is first created by a service, just after the object is instantiated and its readExternal method has been called to populate its properties from attributes obtained from the remote information source. |
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(ProxyUser thisObject,
ObjectInput input,
long readSerialVersionUID,
boolean passThrough,
boolean superDone)
Reads the non-transient fields of this class from an external source. |
void |
refresh()
Refresh the derived attributes of the object. |
void |
refreshIfStale()
Refresh the derived attributes of the object, but only if the properties are stale. |
protected void |
removeGroup(WTGroup group)
Removes a group from the list of user's groups. |
private void |
serviceIdValidate(ServiceIdentifier a_ServiceId)
|
void |
setDisabled(boolean disabled)
Supported API: false |
void |
setEMail(String a_EMail)
Sets the value of the attribute: E_MAIL. |
void |
setExpirationTime(long a_ExpirationTime)
Sets the value of the attribute: EXPIRATION_TIME. |
private void |
setGroups()
Sets the parent groups of the user object. |
void |
setPreferredLanguage(String a_PreferredLanguage)
Sets the value of the attribute: PREFERRED_LANGUAGE. |
void |
setRefreshTime(long a_RefreshTime)
Sets the value of the attribute: REFRESH_TIME. |
void |
setServiceId(ServiceIdentifier a_ServiceId)
Sets the object for the association that plays role: SERVICE_ID. |
void |
setSourceObjectId(String a_SourceObjectId)
Sets the value of the attribute: SOURCE_OBJECT_ID. |
void |
setSourceURL(String a_SourceURL)
Sets the value of the attribute: SOURCE_URL. |
private void |
sourceObjectIdValidate(String a_SourceObjectId)
|
private void |
sourceURLValidate(String a_SourceURL)
|
String |
toString()
Returns a string representation of the user object. |
void |
update()
Update the derived attributes of the object on the source service. |
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
public static final String E_MAIL
private static int E_MAIL_UPPER_LIMIT
private String eMail
public static final String PREFERRED_LANGUAGE
private static int PREFERRED_LANGUAGE_UPPER_LIMIT
private String preferredLanguage
private String sourceObjectId
private String sourceURL
private long expirationTime
private long refreshTime
private ServiceIdentifier serviceId
static final long serialVersionUID
public static final long EXTERNALIZATION_VERSION_UID
protected static final long OLD_FORMAT_VERSION_UID
private DirectoryAttributeHolder attributes
private Vector groups
private FederatedService service
private static boolean VERBOSE
private static final Class GroupUserLinkClass
private static final Class WTUserClass
Constructor Detail |
public ProxyUser() throws WTException
WTException
Method Detail |
public void writeExternal(ObjectOutput output) throws IOException
writeExternal
in interface Externalizable
writeExternal
in class WTUser
output
-
IOException
public void readExternal(ObjectInput input) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
readExternal
in class WTUser
input
-
IOException
ClassNotFoundException
protected boolean readVersion(ProxyUser 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 WTUser
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 WTUser
input
-
SQLException
DatastoreException
public String getConceptualClassname()
getConceptualClassname
in interface NetFactor
getConceptualClassname
in class WTUser
public String getEMail()
getEMail
in class WTUser
public void setEMail(String a_EMail)
setEMail
in class WTUser
a_EMail
- public String getPreferredLanguage()
public void setPreferredLanguage(String a_PreferredLanguage) throws WTException
a_PreferredLanguage
-
WTException
public static ProxyUser newProxyUser(String name) throws WTException
name
-
WTException
protected void initialize(String name) throws WTException
initialize
in class WTUser
name
-
WTException
public static ProxyUser newProxyUser(String name, ServiceIdentifier serviceId, String sourceObjectId) throws WTException
name
- serviceId
- sourceObjectId
-
WTException
protected void initialize(String name, ServiceIdentifier serviceId, String sourceObjectId) throws WTException
name
- serviceId
- sourceObjectId
-
WTException
public void setDisabled(boolean disabled) throws WTException, WTPropertyVetoException
setDisabled
in class WTUser
disabled
-
WTException
WTPropertyVetoException
public String getSourceObjectId()
getSourceObjectId
in interface Federated
public void setSourceObjectId(String a_SourceObjectId) throws WTPropertyVetoException
setSourceObjectId
in interface Federated
a_SourceObjectId
-
WTPropertyVetoException
private void sourceObjectIdValidate(String a_SourceObjectId) throws WTPropertyVetoException
a_SourceObjectId
-
WTPropertyVetoException
public String getSourceURL()
getSourceURL
in interface Federated
public void setSourceURL(String a_SourceURL) throws WTPropertyVetoException
setSourceURL
in interface Federated
a_SourceURL
-
WTPropertyVetoException
private void sourceURLValidate(String a_SourceURL) throws WTPropertyVetoException
a_SourceURL
-
WTPropertyVetoException
public long getExpirationTime()
getExpirationTime
in interface Federated
public void setExpirationTime(long a_ExpirationTime) throws WTPropertyVetoException
setExpirationTime
in interface Federated
a_ExpirationTime
-
WTPropertyVetoException
public long getRefreshTime()
getRefreshTime
in interface Federated
public void setRefreshTime(long a_RefreshTime) throws WTPropertyVetoException
setRefreshTime
in interface Federated
a_RefreshTime
-
WTPropertyVetoException
public FederatedService getService() throws FederationServicesException
getService
in interface Federated
FederationServicesException
public void preset() throws FederationServicesException
preset
in interface Federated
FederationServicesException
public void refresh() throws FederationServicesException
refresh
in interface Federated
FederationServicesException
public void refreshIfStale() throws FederationServicesException
refreshIfStale
in interface Federated
FederationServicesException
public void update() throws FederationServicesException
update
in interface Federated
FederationServicesException
public void prepareForStore() throws FederationServicesException
prepareForStore
in interface Federated
FederationServicesException
public QueryResult findLinks(Class targetLinkClass, String obj1Role, Persistable obj2) throws FederationServicesException
findLinks
in interface Federated
targetLinkClass
- obj1Role
- obj2
-
FederationServicesException
public QueryResult navigate(String role, Class linkClass, boolean onlyOtherSide) throws FederationServicesException
navigate
in interface Federated
role
- linkClass
- onlyOtherSide
-
FederationServicesException
public QueryResult navigate(String role, QuerySpec criteria, boolean onlyOtherSide) throws FederationServicesException
navigate
in interface Federated
role
- criteria
- onlyOtherSide
-
FederationServicesException
public void postStore() throws FederationServicesException
postStore
in interface Federated
FederationServicesException
public ServiceIdentifier getServiceId()
getServiceId
in interface Federated
public void setServiceId(ServiceIdentifier a_ServiceId) throws WTPropertyVetoException
setServiceId
in interface Federated
a_ServiceId
-
WTPropertyVetoException
private void serviceIdValidate(ServiceIdentifier a_ServiceId) throws WTPropertyVetoException
a_ServiceId
-
WTPropertyVetoException
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 WTUser
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 WTUser
public AttributeHolder getAttributes()
getAttributes
in class WTUser
public Locale getLocale() throws FederationServicesException
getLocale
in class WTUser
FederationServicesException
private void getDirectoryAttributes() throws FederationServicesException
FederationServicesException
public Enumeration parentGroups() throws WTException
parentGroups
in class WTUser
WTException
public Enumeration parentGroupNames() throws WTException
parentGroupNames
in class WTUser
WTException
protected void addGroup(WTGroup group) throws WTException
group
-
WTException
protected void removeGroup(WTGroup group) throws WTException
group
-
WTException
private void setGroups() throws WTException
WTException
- if there is a problem remotely calling the method.public String toString()
toString
in interface Principal
toString
in class WTUser
public Enumeration parentGroupObjects() throws WTException
WTUser
parentGroupObjects
in class WTUser
WTException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |