Package jetbrains.buildServer.serverSide.impl.auth

Class RoleImpl

java.lang.Object

jetbrains.buildServer.serverSide.impl.auth.RoleImpl

All Implemented Interfaces:

Comparable<RoleImpl>, Loggable, Role

public class RoleImpl
extends Object
implements Role, Comparable<RoleImpl>

Role is a set of permissions and included roles with name and identifier.

Constructor Summary

Constructors

Constructor	Description
RoleImpl(String id, String name, int orderNum, RoleManipulator manipulator)
RoleImpl(String id, String name, Permissions permissions, int orderNum, RoleManipulator manipulator)
RoleImpl(String id, String name, Permissions allowedPermissions, Permissions disabledPermissions, RoleManipulator manipulator)
RoleImpl(String id, String name, Permissions permissions, RoleManipulator roleManipulator)

Method Summary

Modifier and Type	Method	Description
void	addIncludedRole(Role includedRole)	Includes includedRole to the role
void	addPermissions(Permission... permissions)	Adds permissions to the role
int	compareTo(RoleImpl o)
void	computeAllPermissions()
String	describe(boolean verbose)
void	disableProjectAssociation()	By default we compute whether a role can be associated to a particular project by permissions containing in the role.
void	doAddDisabledPermissions(Permissions permissions)
void	doAddIncludedRole(Role role)
void	doAddPermissions(Permissions permissions)	Adds permissions to the role
void	doRemoveIncludedRole(Role role)
void	doRemovePermission(Permission permission)
boolean	equals(Object o)
Permissions	getDisabledOwnPermissions()
String	getId()	Returns unique identifier of this role
Role[]	getIncludedRoles()	Returns roles which are included in this role
String	getName()	Returns name of this role
int	getOrderNum()
Permissions	getOwnPermissions()	Return only own permissions of the role without inherited permissions
Permissions	getPermissions()	Returns permissions associated with this role
int	hashCode()
boolean	isProjectAssociationDisabled()
boolean	isProjectAssociationSupported()	Returns true if this role can be associated with a particular project.
void	removeIncludedRole(Role includedRole)	Excludes includedRole from the role
void	removePermission(Permission permission)	Removes permission from the role
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RoleImpl

public RoleImpl(@NotNull
                String id,
                @NotNull
                String name,
                @NotNull
                Permissions permissions,
                @Nullable
                RoleManipulator roleManipulator)

RoleImpl

public RoleImpl(@NotNull
                String id,
                @NotNull
                String name,
                @NotNull
                Permissions permissions,
                int orderNum,
                @Nullable
                RoleManipulator manipulator)

RoleImpl

public RoleImpl(@NotNull
                String id,
                @NotNull
                String name,
                int orderNum,
                @Nullable
                RoleManipulator manipulator)

RoleImpl

public RoleImpl(@NotNull
                String id,
                @NotNull
                String name,
                @NotNull
                Permissions allowedPermissions,
                @NotNull
                Permissions disabledPermissions,
                RoleManipulator manipulator)

Method Detail

getOrderNum

public int getOrderNum()

disableProjectAssociation

public void disableProjectAssociation()

By default we compute whether a role can be associated to a particular project by permissions containing in the role. If role contains at least one project permission Permission.isProjectAssociationSupported() returns true, we consider that this role can be associated with a project. But sometimes it is needed to override this behaviour and disable project association for some roles even if they contain project permissions (for example, Sysadmin role).

isProjectAssociationDisabled

public boolean isProjectAssociationDisabled()

getId

@NotNull
public String getId()

Returns unique identifier of this role

Specified by:

getId in interface Role

Returns:

id of the role

getName

@NotNull
public String getName()

Returns name of this role

Specified by:

getName in interface Role

Returns:

name of the role

getPermissions

@NotNull
public Permissions getPermissions()

Returns permissions associated with this role

Specified by:

getPermissions in interface Role

Returns:

role permissions

getOwnPermissions

@NotNull
public Permissions getOwnPermissions()

Description copied from interface: Role

Return only own permissions of the role without inherited permissions

Specified by:

getOwnPermissions in interface Role

Returns:

own permissions of the role

getDisabledOwnPermissions

@NotNull
public Permissions getDisabledOwnPermissions()

getIncludedRoles

@NotNull
public Role[] getIncludedRoles()

Description copied from interface: Role

Returns roles which are included in this role

Specified by:

getIncludedRoles in interface Role

Returns:

included roles

isProjectAssociationSupported

public boolean isProjectAssociationSupported()

Description copied from interface: Role

Returns true if this role can be associated with a particular project. This means that this role contains at least one permission that can be associated with a project.

Specified by:

isProjectAssociationSupported in interface Role

Returns:

true if this role can be associated with a project

addPermissions

public void addPermissions(@NotNull
                           Permission... permissions)

Description copied from interface: Role

Adds permissions to the role

Specified by:

addPermissions in interface Role

Parameters:

permissions - permissions

removePermission

public void removePermission(@NotNull
                             Permission permission)

Description copied from interface: Role

Removes permission from the role

Specified by:

removePermission in interface Role

Parameters:

permission - permission

addIncludedRole

public void addIncludedRole(@NotNull
                            Role includedRole)

Description copied from interface: Role

Includes includedRole to the role

Specified by:

addIncludedRole in interface Role

Parameters:

includedRole - role to include

removeIncludedRole

public void removeIncludedRole(@NotNull
                               Role includedRole)

Description copied from interface: Role

Excludes includedRole from the role

Specified by:

removeIncludedRole in interface Role

Parameters:

includedRole - role to include

doAddPermissions

public void doAddPermissions(Permissions permissions)

Adds permissions to the role

Parameters:

permissions - adds permissions

doAddDisabledPermissions

public void doAddDisabledPermissions(Permissions permissions)

doRemovePermission

public void doRemovePermission(@NotNull
                               Permission permission)

doAddIncludedRole

public void doAddIncludedRole(@NotNull
                              Role role)

doRemoveIncludedRole

public void doRemoveIncludedRole(@NotNull
                                 Role role)

toString

public String toString()

Overrides:

toString in class Object

computeAllPermissions

public void computeAllPermissions()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(RoleImpl o)

Specified by:

compareTo in interface Comparable<RoleImpl>

describe

@NotNull
public String describe(boolean verbose)

Specified by:

describe in interface Loggable

Parameters:

verbose - verbosity of object description

Returns:

description of this object. If verbose is true, description should have mode details.