Serializable
ProfileWrapper is a lightweight object that can be used to access a user or group profile. To retrieve a ProfileWrapper, use the ProfileFactory. Once a ProfileWrapper is retrieved, it knows how to access the correct ProfileManager session bean(s) based on the identity it was initialized with. If it was initialized with both a user and group name, the group will be used as an explicit successor for all getProperty methods that do not take an explicit successor. If an explicit successor is provided to the getProperty methods, that one will override the group that this object was initialized with. When specifying a successor for user and group profiles, it will always be the name of the group; because users and groups always use groups as their successors.
Related Topics
Serializable
AnonymousProfileWrapper
, PhantomProfileWrapper
,
Method Summary |
public |
|
public | |
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public boolean |
|
public |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
Method Detail |
public ProfileIdentity
getProfileIdentity()
Get the current identity of this profile
publicEntityPropertyCache
getProperties()
throwsRemoteException
,ProfileNotFoundException
RemoteException
ProfileNotFoundException
Related Topics
EntityPropertyCache
PropertyMapKey
publicEntityPropertyCache
getProperties(String
propertySetName)
throwsRemoteException
,ProfileNotFoundException
RemoteException
ProfileNotFoundException
Related Topics
EntityPropertyCache
PropertyMapKey
publicEntityPropertyCache
getProperties(Set
propertyMapKeys)
throwsRemoteException
,ProfileNotFoundException
RemoteException
ProfileNotFoundException
Related Topics
EntityPropertyCache
PropertyMapKey
publicGet a property from the profile. If the property is still not found, the default value from the property set will be returned.Object
getProperty(String
propertySet,String
propertyName)
throwsRemoteException
,ProfileNotFoundException
RemoteException
ProfileNotFoundException
publicGet a property from the profile. If a successor is provided, it will be used instead of the profile's groupname. If the property is not found, the default value from the property set will be returned.Object
getProperty(String
propertySet,String
propertyName,String
successor)
throwsRemoteException
,ProfileNotFoundException
RemoteException
ProfileNotFoundException
publicGet a property from the profile, converted to a String If the property is not found, the default value from the property set will be returned.String
getPropertyAsString(String
propertySet,String
propertyName)
throwsRemoteException
,ProfileNotFoundException
RemoteException
ProfileNotFoundException
publicGet a property from the profile. If a successor is provided, it will be used instead of the profile's groupname. If the property is not found, the default value from the property set will be returned.String
getPropertyAsString(String
propertySet,String
propertyName,String
successor)
throwsRemoteException
,ProfileNotFoundException
RemoteException
ProfileNotFoundException
publicRetrieve the successor for the specified property set. For user and group profiles, this will always be a group name.String
getSuccessor(String
propertySet)
throwsRemoteException
,ProfileNotFoundException
RemoteException
ProfileNotFoundException
public ProfileType
getType()
Get profile type. There is no corresponding setter because the profile type
is a static final attribute of all ProfileWrapper implementations
public String
getUsername()
Get the current username of this profile
public boolean isType(ProfileType
type)
Compare this profile type with another.
publicRemove a property from the profileObject
removeProperty(String
propertySet,String
propertyName)
throwsRemoteException
,ProfileNotFoundException
RemoteException
ProfileNotFoundException
public void removeSuccessor(Remove the successor for the specified property set.String
propertySet)
throwsRemoteException
,ProfileNotFoundException
RemoteException
ProfileNotFoundException
public void setProperties(Set properties in the profile, taken from the input cache. Invalid properties are ignored.EntityPropertyCache
cache)
throwsRemoteException
,ProfileNotFoundException
RemoteException
ProfileNotFoundException
public void setProperty(Set a property in the profileString
propertySet,String
propertyName,Object
value)
throwsPropertyValidationException
,RemoteException
,ProfileNotFoundException
PropertyValidationException
RemoteException
ProfileNotFoundException
public void setSuccessor(Set the successor for the specified property setString
propertySet,String
successor)
throwsRemoteException
,ProfileNotFoundException
RemoteException
ProfileNotFoundException
public void validateProfile()Ensure that the profile represented by this object is valid
throwsRemoteException
,ProfileNotFoundException
,SuccessorNotFoundException
RemoteException
ProfileNotFoundException
SuccessorNotFoundException