|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ProfileManager is a stateless session bean used to access profile values. It coordinates successor searches and mapping properties to different datasources. To provide a successor to the methods which take one, use the profile name of the successor profile. Each profile manager uses only one type as the successor type; for example, when specifying a successor to a UserProfileManager, it assumes the name is a group profile name. Property mapping is done through the deployment descriptor of the ProfileManager session bean. First, the default EntityPropertyManager to be used must have an ejb-ref named ejb/EntityPropertyManager. Any other EntityPropertyManager's to be used must also have ejb-refs. To map properties to a non-default EntityPropertyManager:
This control requires that the GroupProfileManager EJB has been deployed to
the application. The GroupProfileManager EJB is contained in p13n_ejb.jar, and is
automatically deployed as part of a Portal application.
Security requirements:
The caller must be in the role of "PortalSystemAdministrator" to invoke
these methods
EntityPropertyCache
Method Summary | |
void |
createProfile(String profileName)
Create a profile record with the given name. |
void |
deleteProfile(String profileName)
Remove a profile Caller must be in the role of PortalSystemAdminstrator |
String[] |
getAllProfileNames()
Return a list of all profiles that this ProfileManager knows about. |
String |
getJndiName()
Retrieve the jndi name used by this ProfileManager. |
String |
getProfileName(long profileId)
Get the name of a profile based on its unique identifier. |
EntityPropertyCache |
getProperties(String profileName)
Get all properties for this profile |
EntityPropertyCache |
getPropertiesForKeys(String profileName,
Set propertyMapKeys)
Get all properties for this profile and property set/name keys contained in the Set of propertyMapKeys |
EntityPropertyCache |
getPropertiesInPropertySet(String profileName,
String propertySetName)
Get all properties for this profile and named property set |
Object |
getProperty(String profileName,
String propertySet,
String propertyName)
Get a property from the profile. |
String |
getPropertyAsString(String profileName,
String propertySet,
String propertyName)
Get 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 |
getPropertyAsStringTrySuccessor(String profileName,
String propertySet,
String propertyName,
String successor)
Get a property from the profile as a String. |
Object |
getPropertyNoDefault(String profileName,
String propertySet,
String propertyName,
String successor)
Get a property from the profile. |
Object |
getPropertyTrySuccessor(String profileName,
String propertySet,
String propertyName,
String successor)
Get a property from the profile. |
String |
getSuccessor(String profileName,
String propertySet)
Retrieve the successor for the specified property set. |
long |
getUniqueId(String profileName)
Retrieve the unique identifier generated for this profile. |
boolean |
profileExists(String profileName)
Determine if a profile exists |
Object |
removeProperty(String profileName,
String propertySet,
String propertyName)
Remove a property from the profile Caller must be in the role of PortalSystemAdminstrator |
void |
removeSuccessor(String profileName,
String propertySet)
Remove the successor for the specified property set. |
void |
setProperty(String profileName,
String propertySet,
String propertyName,
Object value)
Set a property in the profile Caller must be in the role of PortalSystemAdminstrator |
void |
setSuccessor(String profileName,
String propertySet,
String successor)
Set the successor for the specified property set Caller must be in the role of PortalSystemAdminstrator |
Method Detail |
public void createProfile(String profileName) throws P13nControlException
profileName
- the name of the profile to create
P13nControlException
- if errors creating profilepublic void deleteProfile(String profileName) throws P13nControlException
profileName
- the name of the profile to remove
P13nControlException
- if profile not found, or caller is not in allowed
rolepublic String[] getAllProfileNames() throws P13nControlException
P13nControlException
- if remote errors accessing GroupProfileManager EJBpublic String getJndiName() throws P13nControlException
P13nControlException
- if remote errors accessing
GroupProfileManager EJBpublic String getProfileName(long profileId) throws P13nControlException
profileId
- the unique id to lookup
P13nControlException
- if the profile does not existpublic EntityPropertyCache getProperties(String profileName) throws P13nControlException
profileName
- the name of the profile for which properties will
be retrieved
P13nControlException
- if profile is not validpublic EntityPropertyCache getPropertiesInPropertySet(String profileName, String propertySetName) throws P13nControlException
profileName
- the name of the profile for which properties will
be retrievedpropertySetName
- the name of the property set to be searched
P13nControlException
- if profile is not validpublic EntityPropertyCache getPropertiesForKeys(String profileName, Set propertyMapKeys) throws P13nControlException
profileName
- the name of the profile for which properties will
be retrievedpropertyMapKeys
- the set of property set/name keys
P13nControlException
- if profile is not validPropertyMapKey
public Object getProperty(String profileName, String propertySet, String propertyName) throws P13nControlException
profileName
- the name of the profile to readpropertySet
- the property set containing the propertypropertyName
- the name of the property to retrieve
P13nControlException
- if profile is not validpublic Object getPropertyTrySuccessor(String profileName, String propertySet, String propertyName, String successor) throws P13nControlException
profileName
- the name of the profile to readpropertySet
- the property set containing the propertypropertyName
- the name of the property to retrievesuccessor
- the name of the successor whose profile will be searched
P13nControlException
- if profile or successor is not validpublic String getPropertyAsString(String profileName, String propertySet, String propertyName) throws P13nControlException
profileName
- the name of the profile to readpropertySet
- the property set containing the propertypropertyName
- the name of the property to retrieve
P13nControlException
- if profile is not validpublic String getPropertyAsStringTrySuccessor(String profileName, String propertySet, String propertyName, String successor) throws P13nControlException
profileName
- the name of the profile to readpropertySet
- the property set containing the propertypropertyName
- the name of the property to retrievesuccessor
- the name of the successor whose profile will be searched
P13nControlException
- if profile or successor is not validpublic Object getPropertyNoDefault(String profileName, String propertySet, String propertyName, String successor) throws P13nControlException
profileName
- the name of the profile to readpropertySet
- the property set containing the propertypropertyName
- the name of the property to retrievesuccessor
- the name of the successor whose profile will be searched
P13nControlException
- if profile or successor is not validpublic String getSuccessor(String profileName, String propertySet) throws P13nControlException
profileName
- the name of the profile to readpropertySet
- The name of the property set
P13nControlException
- if profile is not validpublic long getUniqueId(String profileName) throws P13nControlException
profileName
- the name of the profile to read
P13nControlException
- if profile is not validpublic boolean profileExists(String profileName) throws P13nControlException
profileName
- the name to look for
P13nControlException
- if errors accessing GroupProfileManager EJBpublic Object removeProperty(String profileName, String propertySet, String propertyName) throws P13nControlException
profileName
- the name of the profile to modifypropertySet
- the property set containing the propertypropertyName
- the name of the property to retrieve
P13nControlException
- if profile is not valid or caller is not
in allowed rolepublic void removeSuccessor(String profileName, String propertySet) throws P13nControlException
profileName
- the name of the profile to modifypropertySet
- The name of the property set
P13nControlException
- if profile is not valid or caller is not
in allowed rolepublic void setProperty(String profileName, String propertySet, String propertyName, Object value) throws P13nControlException
profileName
- the name of the profile to modifypropertySet
- the property set containing the propertypropertyName
- the name of the property to retrievevalue
- the new value for the property
P13nControlException
- if profile is not valid or caller is not
in allowed rolepublic void setSuccessor(String profileName, String propertySet, String successor) throws P13nControlException
profileName
- the name of the profile to modifypropertySet
- The name of the property setsuccessor
- the name of the successor profile to set
P13nControlException
- if profile or successor is not valid or caller is not
in allowed role
|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |