public class CmsDefaultUsers extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
DEFAULT_GROUP_ADMINISTRATORS
Default name for the "Administrators" group.
|
protected static java.lang.String |
DEFAULT_GROUP_GUESTS
Default name for the "Guests" group.
|
protected static java.lang.String |
DEFAULT_GROUP_USERS
Default name for the "Users" group.
|
protected static java.lang.String |
DEFAULT_USER_ADMIN
Default name for the "Admin" user.
|
protected static java.lang.String |
DEFAULT_USER_DELETED_RESOURCE
Default name for the "Deleted Resource" user.
|
protected static java.lang.String |
DEFAULT_USER_EXPORT
Default name for the "Export" user.
|
protected static java.lang.String |
DEFAULT_USER_GUEST
Default name for the "Guest" user.
|
Constructor and Description |
---|
CmsDefaultUsers()
Constructor that initializes all names with default values.
|
CmsDefaultUsers(java.lang.String userAdmin,
java.lang.String userGuest,
java.lang.String userExport,
java.lang.String userDeletedResource,
java.lang.String groupAdministrators,
java.lang.String groupUsers,
java.lang.String groupGuests)
Public constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getGroupAdministrators()
Returns the name of the administrators group.
|
java.lang.String |
getGroupGuests()
Returns the name of the guests group.
|
java.lang.String |
getGroupProjectmanagers()
Deprecated.
As of OpenCms 9.5, there is no default group for project managers anymore.
Use the role
CmsRole.PROJECT_MANAGER instead in case you want a user to be able to manage projects.
For backward compatibility in old installations, this returns the old default group name "Projectmanagers". |
java.lang.String |
getGroupUsers()
Returns the name of the users group.
|
java.lang.String |
getUserAdmin()
Returns the name of the default administrator user.
|
java.lang.String |
getUserDeletedResource()
Returns the name of the default deleted resource user.
|
java.lang.String |
getUserExport()
Returns the name of the user used to generate the static export.
|
java.lang.String |
getUserGuest()
Returns the name of the default guest user.
|
protected void |
init(java.lang.String userAdmin,
java.lang.String userGuest,
java.lang.String userExport,
java.lang.String userDeletedResource,
java.lang.String groupAdministrators,
java.lang.String groupUsers,
java.lang.String groupGuests)
Initializes this instance.
|
boolean |
isDefaultGroup(java.lang.String groupName)
Checks if a given group name is the name of one of the OpenCms default groups.
|
boolean |
isDefaultUser(java.lang.String userName)
Checks if a given user name is the name of one of the OpenCms default users.
|
boolean |
isGroupGuests(java.lang.String groupName)
Checks if a given group name is the name of the guests group.
|
boolean |
isUserAdmin(java.lang.String userName)
Checks if a given user name is the name of the admin user.
|
boolean |
isUserExport(java.lang.String userName)
Checks if a given user name is the name of the export user.
|
boolean |
isUserGuest(java.lang.String userName)
Checks if a given user name is the name of the guest user.
|
protected static final java.lang.String DEFAULT_GROUP_ADMINISTRATORS
protected static final java.lang.String DEFAULT_GROUP_GUESTS
protected static final java.lang.String DEFAULT_GROUP_USERS
protected static final java.lang.String DEFAULT_USER_ADMIN
protected static final java.lang.String DEFAULT_USER_DELETED_RESOURCE
protected static final java.lang.String DEFAULT_USER_EXPORT
protected static final java.lang.String DEFAULT_USER_GUEST
public CmsDefaultUsers()
See the constants of this class for the defaule values that are uses.
public CmsDefaultUsers(java.lang.String userAdmin, java.lang.String userGuest, java.lang.String userExport, java.lang.String userDeletedResource, java.lang.String groupAdministrators, java.lang.String groupUsers, java.lang.String groupGuests)
userAdmin
- the name of the default admin useruserGuest
- the name of the guest useruserExport
- the name of the export useruserDeletedResource
- the name of the deleted resource user, can be null
groupAdministrators
- the name of the administrators groupgroupUsers
- the name of the users groupgroupGuests
- the name of the guests grouppublic java.lang.String getGroupAdministrators()
public java.lang.String getGroupGuests()
@Deprecated public java.lang.String getGroupProjectmanagers()
CmsRole.PROJECT_MANAGER
instead in case you want a user to be able to manage projects.
For backward compatibility in old installations, this returns the old default group name "Projectmanagers".public java.lang.String getGroupUsers()
public java.lang.String getUserAdmin()
public java.lang.String getUserDeletedResource()
public java.lang.String getUserExport()
public java.lang.String getUserGuest()
public boolean isDefaultGroup(java.lang.String groupName)
groupName
- the group name to checktrue
if group name is one of OpenCms default groups, false
if it is not
or if groupName
is null
or an empty string (no trim)getGroupAdministrators()
,
getGroupUsers()
,
getGroupGuests()
public boolean isDefaultUser(java.lang.String userName)
userName
- the group name to checktrue
if user name is one of OpenCms default users, false
if it is not
or if userName
is null
or an empty string (no trim)getUserAdmin()
,
getUserExport()
,
getUserGuest()
,
getUserDeletedResource()
public boolean isGroupGuests(java.lang.String groupName)
groupName
- the group name to checktrue
if a given group name is the name of the guests grouppublic boolean isUserAdmin(java.lang.String userName)
userName
- the user name to checktrue
if a given user name is the name of the admin userpublic boolean isUserExport(java.lang.String userName)
userName
- the user name to checktrue
if a given user name is the name of the export userpublic boolean isUserGuest(java.lang.String userName)
userName
- the user name to checktrue
if a given user name is the name of the guest userprotected void init(java.lang.String userAdmin, java.lang.String userGuest, java.lang.String userExport, java.lang.String userDeletedResource, java.lang.String groupAdministrators, java.lang.String groupUsers, java.lang.String groupGuests)
userAdmin
- the name of the default admin useruserGuest
- the name of the guest useruserExport
- the name of the export useruserDeletedResource
- the name of the deleted resource user, can be null
groupAdministrators
- the name of the administrators groupgroupUsers
- the name of the users groupgroupGuests
- the name of the guests group