|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
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.
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 retrieve
ProfileNotFoundException
- if the profile is not valid
RemoteException
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 retrieve
ProfileNotFoundException
- if the profile is not valid
RemoteException
EntityPropertyCache getProperties(String profileName) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile for which properties will
be retrieved
ProfileNotFoundException
- if the profile is not valid
RemoteException
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 searched
ProfileNotFoundException
- if the profile is not valid
RemoteException
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 keys
ProfileNotFoundException
- if the profile is not valid
RemoteException
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 searched
ProfileNotFoundException
- if the profile or successor is not valid
RemoteException
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 retrieve
ProfileNotFoundException
- if the profile or successor is not valid
RemoteException
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 searched
ProfileNotFoundException
- if the profile or successor is not valid
RemoteException
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 searched
ProfileNotFoundException
- if the profile or successor is not valid
RemoteException
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 property
PropertyValidationException
- if the new value is not valid
ProfileNotFoundException
- if the profile is not valid
RemoteException
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 retrieve
ProfileNotFoundException
- if the profile is not valid
RemoteException
String getSuccessor(String profileName, String propertySet) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to readpropertySet
- The name of the property set
ProfileNotFoundException
- if the profile is not valid
RemoteException
void removeSuccessor(String profileName, String propertySet) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to modifypropertySet
- The name of the property set
ProfileNotFoundException
- if the profile is not valid
RemoteException
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 set
ProfileNotFoundException
- if the profile or the successor is not valid
RemoteException
long getUniqueId(String profileName) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to read
ProfileNotFoundException
- if the profile does not exist
RemoteException
String getProfileName(long profileId) throws RemoteException, ProfileNotFoundException
profileId
- the unique id to lookup
ProfileNotFoundException
- if the profile does not exist
RemoteException
String getJNDIName() throws RemoteException
RemoteException
void createProfile(String profileName) throws RemoteException
profileName
- the name of the profile to create
RemoteException
void deleteProfile(String profileName) throws RemoteException, ProfileNotFoundException
profileName
- the name of the profile to remove
RemoteException
ProfileNotFoundException
boolean profileExists(String profileName) throws RemoteException
profileName
- the name to look for
RemoteException
String[] getAllProfileNames() throws RemoteException
RemoteException
PagedResult<ProfileValueCache> listAllProfiles(int pageSize) throws RemoteException
RemoteException
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |