Class Profile
- java.lang.Object
-
- org.silverpeas.core.admin.component.model.ProfileDescription
-
- org.silverpeas.core.admin.component.model.Profile
-
public class Profile extends ProfileDescription
A user profile defined in an application component. A user profile is a mix between a role and some privileges. The name of the profile denotes the name of the role. If the application can describe any role it supports, even new ones, Silverpeas does support only a set of predefined roles, all of them represented in theSilverpeasRole
enum. To these roles are automatically mapped some privileges which are all hard-coded and based upon access rights conventions in Silverpeas (for example theSilverpeasRole.READER
role has read-only access to the contributions). So, when a user profile is defined for an application, a mapping between this profile with one of the predefined user profile in Silverpeas is required; if no mapping is provided, then by default the name of the profile should match the name of a predefined profile. The mapping of profiles are applied between those of the parent space and the instances of the application component; so only a subset of predefined roles in Silverpeas is concerned by the mapping of profiles: seeInheritableSpaceRoles
to have a look of them.
-
-
Field Summary
Fields Modifier and Type Field Description protected String
name
-
Fields inherited from class org.silverpeas.core.admin.component.model.ProfileDescription
help, label, spaceProfileMapping
-
-
Constructor Summary
Constructors Constructor Description Profile()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getName()
Gets the value of the name property.ComponentSpaceProfileMapping
getSpaceProfileMapping()
Gets the mapping between this user profile with those of the parent space of the component.void
setName(String value)
Sets the value of the name property.-
Methods inherited from class org.silverpeas.core.admin.component.model.ProfileDescription
getHelp, getLabel, putHelp, putLabel, setSpaceProfileMapping
-
-
-
-
Field Detail
-
name
protected String name
-
-
Method Detail
-
getName
public String getName()
Gets the value of the name property.- Returns:
- possible object is
String
-
setName
public void setName(String value)
Sets the value of the name property.- Parameters:
value
- allowed object isString
-
getSpaceProfileMapping
@Nonnull public ComponentSpaceProfileMapping getSpaceProfileMapping()
Gets the mapping between this user profile with those of the parent space of the component. By convention, if no mapping is explicitly defined, then the default mapping applied is on the profile name, even this name doesn't match any predefined space profile; in this case, the mapping should be ignored and no role inheritance should be applied for this profile.- Overrides:
getSpaceProfileMapping
in classProfileDescription
- Returns:
- the mapping of this profile with at least one of the parent space. By default, if no mapping has been defined in the descriptor of the application, the mapping is on the user profile in the parent space having the same name that this profile.
-
-