|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProfileManager
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 p13n-profile-config.xml descriptor. Each external EntityPropertyManager must be deployed and have its property-adapter configuration in p13n-profile-config.xml descriptor.
If a property set is mapped to an EntityPropertyManager, and another entry maps one property of that property set to a different EntityPropertyManager, the single property mapping will override the property set mapping. In the previous examples, the LdapPropertyManager would be used for all properties in the Ldap property set except for "fax", which would be retrieved from the CustomerPropertyManager.
Method Summary | |
---|---|
void |
createProfile(String profileName) Create a profile record with the given name. |
void |
deleteProfile(String profileName) Remove a profile |
String[] |
getAllProfileNames() Return a list of all profiles names 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 |
getProperties(String profileName, Set propertyMapKeys) Get all properties for this profile and property set/name keys contained in the Set of propertyMapKeys |
EntityPropertyCache |
getProperties(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. |
Object |
getProperty(String profileName, String propertySet, String propertyName, String successor) 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 |
getPropertyAsString(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. |
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 |
isPropertyValueSet(String profileName, String propertySet, String propertyName) Determine whether a property value of a profile is explicitly set (a.k.a customized) or the default value |
PagedResult<ProfileValueCache> |
listAllProfiles(int pageSize) Return a paged list of all profile values that this ProfileManager knows about. |
boolean |
profileExists(String profileName) Determine if a profile exists |
Object |
removeProperty(String profileName, String propertySet, String propertyName) Remove a property from the profile |
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 |
void |
setSuccessor(String profileName, String propertySet, String successor) Set the successor for the specified property set |
Methods inherited from interface javax.ejb.EJBObject |
---|
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove |
Method Detail |
---|
Object getProperty(String profileName, String propertySet, String propertyName) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to readpropertySet
- the property set containing the propertypropertyName
- the name of the property to retrieveProfileNotFoundException
- if the profile is not validRemoteException
String getPropertyAsString(String profileName, String propertySet, String propertyName) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to readpropertySet
- the property set containing the propertypropertyName
- the name of the property to retrieveProfileNotFoundException
- if the profile is not validRemoteException
EntityPropertyCache getProperties(String profileName) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile for which properties will be retrievedProfileNotFoundException
- if the profile is not validRemoteException
EntityPropertyCache
, PropertyMapKey
EntityPropertyCache getProperties(String profileName, String propertySetName) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile for which properties will be retrievedpropertySetName
- the name of the property set to be searchedProfileNotFoundException
- if the profile is not validRemoteException
EntityPropertyCache
, PropertyMapKey
EntityPropertyCache getProperties(String profileName, Set propertyMapKeys) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile for which properties will be retrievedpropertyMapKeys
- the set of property set/name keysProfileNotFoundException
- if the profile is not validRemoteException
EntityPropertyCache
, PropertyMapKey
Object getProperty(String profileName, String propertySet, String propertyName, String successor) throws RemoteException, ProfileNotFoundException
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 searchedProfileNotFoundException
- if the profile or successor is not validRemoteException
boolean isPropertyValueSet(String profileName, String propertySet, String propertyName) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to readpropertySet
- the property set containing the propertypropertyName
- the name of the property to retrieveProfileNotFoundException
- if the profile or successor is not validRemoteException
String getPropertyAsString(String profileName, String propertySet, String propertyName, String successor) throws RemoteException, ProfileNotFoundException
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 searchedProfileNotFoundException
- if the profile or successor is not validRemoteException
Object getPropertyNoDefault(String profileName, String propertySet, String propertyName, String successor) throws RemoteException, ProfileNotFoundException
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 searchedProfileNotFoundException
- if the profile or successor is not validRemoteException
void setProperty(String profileName, String propertySet, String propertyName, Object value) throws PropertyValidationException, ProfileNotFoundException, RemoteException
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 propertyPropertyValidationException
- if the new value is not validProfileNotFoundException
- if the profile is not validRemoteException
Object removeProperty(String profileName, String propertySet, String propertyName) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to modifypropertySet
- the property set containing the propertypropertyName
- the name of the property to retrieveProfileNotFoundException
- if the profile is not validRemoteException
String getSuccessor(String profileName, String propertySet) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to readpropertySet
- The name of the property setProfileNotFoundException
- if the profile is not validRemoteException
void removeSuccessor(String profileName, String propertySet) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to modifypropertySet
- The name of the property setProfileNotFoundException
- if the profile is not validRemoteException
void setSuccessor(String profileName, String propertySet, String successor) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to modifypropertySet
- The name of the property setsuccessor
- the name of the successor profile to setProfileNotFoundException
- if the profile or the successor is not validRemoteException
long getUniqueId(String profileName) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to readProfileNotFoundException
- if the profile does not existRemoteException
String getProfileName(long profileId) throws RemoteException, ProfileNotFoundException
profileId
- the unique id to lookupProfileNotFoundException
- if the profile does not existRemoteException
String getJNDIName() throws RemoteException
RemoteException
void createProfile(String profileName) throws RemoteException
profileName
- the name of the profile to createRemoteException
void deleteProfile(String profileName) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to removeRemoteException
ProfileNotFoundException
boolean profileExists(String profileName) throws RemoteException
profileName
- the name to look forRemoteException
String[] getAllProfileNames() throws RemoteException
RemoteException
PagedResult<ProfileValueCache> listAllProfiles(int pageSize) throws RemoteException
RemoteException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.