© 2003 BEA Systems, Inc.

com.bea.p13n.controls.ejb.usermgmt.profile
Interface UserProfileManager

All Superinterfaces:
com.bea.control.Control, weblogic.jws.control.Control, Serializable

public interface UserProfileManager
extends weblogic.jws.control.Control

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:

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.

This control requires that the UserProfileManager EJB has been deployed to the application. The UserProfileManager EJB is contained in p13n_ejb.jar, and is automatically deployed as part of a Portal application.

See Also:
EntityPropertyCache

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 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
 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
 

Method Detail

createProfile

public void createProfile(String profileName)
                   throws P13nControlException
Create a profile record with the given name.

Parameters:
profileName - the name of the profile to create
Throws:
P13nControlException; - if errors creating profile
P13nControlException

deleteProfile

public void deleteProfile(String profileName)
                   throws P13nControlException
Remove a profile

Parameters:
profileName - the name of the profile to remove
Throws:
P13nControlException; - if profile not found
P13nControlException

getAllProfileNames

public String[] getAllProfileNames()
                            throws P13nControlException
Return a list of all profiles that this ProfileManager knows about.

Returns:
a String array of profile names, or null if none were found
P13nControlException

getJndiName

public String getJndiName()
                   throws P13nControlException
Retrieve the jndi name used by this ProfileManager. A combination of pk string and jndi name is always unique between profiles.

Returns:
the jndi name for this profile
Throws:
P13nControlException; - if remote errors accessing UserProfileManager EJB
P13nControlException

getProfileName

public String getProfileName(long profileId)
                      throws P13nControlException
Get the name of a profile based on its unique identifier.

Parameters:
profileId - the unique id to lookup
Returns:
the profile's name
Throws:
P13nControlException; - if the profile does not exist
P13nControlException

getProperties

public EntityPropertyCache getProperties(String profileName)
                                  throws P13nControlException
Get all properties for this profile

Parameters:
profileName - the name of the profile for which properties will be retrieved
Returns:
the cache of retrieved properties
Throws:
P13nControlException; - if profile is not valid
P13nControlException

getPropertiesInPropertySet

public EntityPropertyCache getPropertiesInPropertySet(String profileName,
                                                      String propertySetName)
                                               throws P13nControlException
Get all properties for this profile and named property set

Parameters:
profileName - the name of the profile for which properties will be retrieved
propertySetName - the name of the property set to be searched
Returns:
the cache of retrieved properties
Throws:
P13nControlException; - if profile is not valid
P13nControlException

getPropertiesForKeys

public EntityPropertyCache getPropertiesForKeys(String profileName,
                                                Set propertyMapKeys)
                                         throws P13nControlException
Get all properties for this profile and property set/name keys contained in the Set of propertyMapKeys

Parameters:
profileName - the name of the profile for which properties will be retrieved
propertyMapKeys - the set of property set/name keys
Returns:
the cache of retrieved properties
Throws:
P13nControlException; - if profile is not valid
P13nControlException
See Also:
PropertyMapKey

getProperty

public Object getProperty(String profileName,
                          String propertySet,
                          String propertyName)
                   throws P13nControlException
Get a property from the profile. If the property is not found, the default value from the property set will be returned.

Parameters:
profileName - the name of the profile to read
propertySet - the property set containing the property
propertyName - the name of the property to retrieve
Returns:
the property's value
Throws:
P13nControlException; - if profile is not valid
P13nControlException

getPropertyTrySuccessor

public Object getPropertyTrySuccessor(String profileName,
                                      String propertySet,
                                      String propertyName,
                                      String successor)
                               throws P13nControlException
Get a property from the profile. If the property is not found in the profile, search the profile named in the successor field. If the property is still not found, the default value from the property set will be returned.

Parameters:
profileName - the name of the profile to read
propertySet - the property set containing the property
propertyName - the name of the property to retrieve
successor - the name of the successor whose profile will be searched
Returns:
the property's value
Throws:
P13nControlException; - if profile or successor is not valid
P13nControlException

getPropertyAsString

public String getPropertyAsString(String profileName,
                                  String propertySet,
                                  String propertyName)
                           throws P13nControlException
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.

Parameters:
profileName - the name of the profile to read
propertySet - the property set containing the property
propertyName - the name of the property to retrieve
Returns:
the property's value
Throws:
P13nControlException; - if profile is not valid
P13nControlException

getPropertyAsStringTrySuccessor

public String getPropertyAsStringTrySuccessor(String profileName,
                                              String propertySet,
                                              String propertyName,
                                              String successor)
                                       throws P13nControlException
Get a property from the profile as a String. If the property is not found in the profile, search the profile named in the successor field. If the property is still not found, the default value from the property set will be returned.

Parameters:
profileName - the name of the profile to read
propertySet - the property set containing the property
propertyName - the name of the property to retrieve
successor - the name of the successor whose profile will be searched
Returns:
the property's value
Throws:
P13nControlException; - if profile or successor is not valid
P13nControlException

getPropertyNoDefault

public Object getPropertyNoDefault(String profileName,
                                   String propertySet,
                                   String propertyName,
                                   String successor)
                            throws P13nControlException
Get a property from the profile. If the property is not found in the profile, search the profile named in the successor field. This version will not return the default from the property set.

Parameters:
profileName - the name of the profile to read
propertySet - the property set containing the property
propertyName - the name of the property to retrieve
successor - the name of the successor whose profile will be searched
Returns:
the property's value
Throws:
P13nControlException; - if profile or successor is not valid
P13nControlException

getSuccessor

public String getSuccessor(String profileName,
                           String propertySet)
                    throws P13nControlException
Retrieve the successor for the specified property set. For user and group profiles, this will always be a group name.

Parameters:
profileName - the name of the profile to read
propertySet - The name of the property set
Returns:
the successor's name
Throws:
P13nControlException; - if profile is not valid
P13nControlException

getUniqueId

public long getUniqueId(String profileName)
                 throws P13nControlException
Retrieve the unique identifier generated for this profile. The unique identifier is used by the EntityPropertyManager to optimize the foreign keys in the persistent storage.

Parameters:
profileName - the name of the profile to read
Returns:
this entity's unique id
Throws:
P13nControlException; - if profile is not valid
P13nControlException

profileExists

public boolean profileExists(String profileName)
                      throws P13nControlException
Determine if a profile exists

Parameters:
profileName - the name to look for
Returns:
true if it exists, false otherwise
Throws:
P13nControlException; - if errors accessing UserProfileManager EJB
P13nControlException

removeProperty

public Object removeProperty(String profileName,
                             String propertySet,
                             String propertyName)
                      throws P13nControlException
Remove a property from the profile

Parameters:
profileName - the name of the profile to modify
propertySet - the property set containing the property
propertyName - the name of the property to retrieve
Returns:
the old value of the property
Throws:
P13nControlException; - if profile is not valid
P13nControlException

removeSuccessor

public void removeSuccessor(String profileName,
                            String propertySet)
                     throws P13nControlException
Remove the successor for the specified property set.

Parameters:
profileName - the name of the profile to modify
propertySet - The name of the property set
Throws:
P13nControlException; - if profile is not valid
P13nControlException

setProperty

public void setProperty(String profileName,
                        String propertySet,
                        String propertyName,
                        Object value)
                 throws P13nControlException
Set a property in the profile

Parameters:
profileName - the name of the profile to modify
propertySet - the property set containing the property
propertyName - the name of the property to retrieve
value - the new value for the property
Throws:
P13nControlException; - if profile is not valid
P13nControlException

setSuccessor

public void setSuccessor(String profileName,
                         String propertySet,
                         String successor)
                  throws P13nControlException
Set the successor for the specified property set

Parameters:
profileName - the name of the profile to modify
propertySet - The name of the property set
successor - the name of the successor profile to set
Throws:
P13nControlException; - if profile or successor is not valid
P13nControlException

© 2003 BEA Systems, Inc.

Copyright © 2003 BEA Systems, Inc. All Rights Reserved