|
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 ProfileWrapper
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.
ProfileFactory
Field Summary | |
---|---|
static String |
SESSION_KEY constant to look up the current profile wrapper in the http session |
Method Summary | |
---|---|
ProfileIdentity |
getProfileIdentity() Get the current identity of this profile |
EntityPropertyCache |
getProperties() |
EntityPropertyCache |
getProperties(Set propertyMapKeys) |
EntityPropertyCache |
getProperties(String propertySetName) |
Object |
getProperty(String propertySet, String propertyName) Get a property from the profile. |
Object |
getProperty(String propertySet, String propertyName, String successor) Get a property from the profile. |
String |
getPropertyAsString(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 propertySet, String propertyName, String successor) Get a property from the profile. |
String |
getSuccessor(String propertySet) Retrieve the successor for the specified property set. |
ProfileType |
getType() Get profile type. |
String |
getUsername() Get the current username of this profile |
boolean |
isType(ProfileType type) Compare this profile type with another. |
Object |
removeProperty(String propertySet, String propertyName) Remove a property from the profile |
void |
removeSuccessor(String propertySet) Remove the successor for the specified property set. |
void |
setProperties(EntityPropertyCache cache) Set properties in the profile, taken from the input cache. |
void |
setProperty(String propertySet, String propertyName, Object value) Set a property in the profile |
void |
setSuccessor(String propertySet, String successor) Set the successor for the specified property set |
void |
validateProfile() Ensure that the profile represented by this object is valid |
Field Detail |
---|
static final String SESSION_KEY
Method Detail |
---|
boolean isType(ProfileType type)
ProfileType getType()
String getUsername()
ProfileIdentity getProfileIdentity()
EntityPropertyCache getProperties() throws RemoteException, ProfileNotFoundException
RemoteException
ProfileNotFoundException
EntityPropertyCache
, PropertyMapKey
EntityPropertyCache getProperties(String propertySetName) throws RemoteException, ProfileNotFoundException
RemoteException
ProfileNotFoundException
EntityPropertyCache
, PropertyMapKey
EntityPropertyCache getProperties(Set propertyMapKeys) throws RemoteException, ProfileNotFoundException
RemoteException
ProfileNotFoundException
EntityPropertyCache
, PropertyMapKey
Object getProperty(String propertySet, String propertyName) throws RemoteException, ProfileNotFoundException
propertySet
- the property set containing the propertypropertyName
- the name of the property to retrieveProfileNotFoundException
- if the profile is not validRemoteException
String getPropertyAsString(String propertySet, String propertyName) throws RemoteException, ProfileNotFoundException
propertySet
- the property set containing the propertypropertyName
- the name of the property to retrieveProfileNotFoundException
- if the profile is not validRemoteException
void setProperty(String propertySet, String propertyName, Object value) throws PropertyValidationException, RemoteException, ProfileNotFoundException
propertySet
- 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
void setProperties(EntityPropertyCache cache) throws RemoteException, ProfileNotFoundException
cache
- The input property cache.RemoteException
- if profile is not validProfileNotFoundException
Object removeProperty(String propertySet, String propertyName) throws RemoteException, ProfileNotFoundException
propertySet
- the property set containing the propertypropertyName
- the name of the property to retrieveProfileNotFoundException
- if the profile is not validRemoteException
Object getProperty(String propertySet, String propertyName, String successor) throws RemoteException, ProfileNotFoundException
propertySet
- the property set containing the propertypropertyName
- the name of the property to retrievesuccessor
- a profile to use as an explicit successorProfileNotFoundException
- if the profile is not validRemoteException
String getPropertyAsString(String propertySet, String propertyName, String successor) throws RemoteException, ProfileNotFoundException
propertySet
- the property set containing the propertypropertyName
- the name of the property to retrievesuccessor
- a profile to use as an explicit successorProfileNotFoundException
- if the profile is not validRemoteException
String getSuccessor(String propertySet) throws RemoteException, ProfileNotFoundException
propertySet
- The name of the property setProfileNotFoundException
- if the profile is not validRemoteException
void removeSuccessor(String propertySet) throws RemoteException, ProfileNotFoundException
propertySet
- The name of the property setProfileNotFoundException
- if the profile is not validRemoteException
void setSuccessor(String propertySet, String successor) throws RemoteException, ProfileNotFoundException
propertySet
- The name of the property setsuccessor
- the name of the successor profile to setProfileNotFoundException
- if the profile or the successor is not validRemoteException
void validateProfile() throws RemoteException, ProfileNotFoundException, SuccessorNotFoundException
ProfileNotFoundException
- if the profile is not validSuccessorNotFoundException
- if the successor is not validRemoteException
|
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.