PermissionEntity (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.ambari.server.orm.entities.PermissionEntity

@Entity
public class PermissionEntity
extends Object

Represents an admin permission.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AMBARI_ADMINISTRATOR_PERMISSION` Admin permission id constants.
`static String`	`AMBARI_ADMINISTRATOR_PERMISSION_NAME` Admin permission name constants.
`static int`	`CLUSTER_ADMINISTRATOR_PERMISSION`
`static String`	`CLUSTER_ADMINISTRATOR_PERMISSION_NAME`
`static String`	`CLUSTER_OPERATOR_PERMISSION_NAME`
`static int`	`CLUSTER_USER_PERMISSION`
`static String`	`CLUSTER_USER_PERMISSION_NAME`
`static String`	`SERVICE_ADMINISTRATOR_PERMISSION_NAME`
`static String`	`SERVICE_OPERATOR_PERMISSION_NAME`
`static int`	`VIEW_USER_PERMISSION`
`static String`	`VIEW_USER_PERMISSION_NAME`

Constructor Summary

Constructors
Constructor and Description

PermissionEntity()

Constructors
Constructor and Description
`PermissionEntity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAuthorization(RoleAuthorizationEntity roleAuthorization)` Add roleAuthorization if it's not already added
`void`	`addAuthorizations(Collection<RoleAuthorization> roleAuthorizations)` Add multiple role authorizations
`boolean`	`equals(Object o)`
`Collection<RoleAuthorizationEntity>`	`getAuthorizations()` Gets the collection of granular authorizations for this PermissionEntity
`Integer`	`getId()` Get the permission id.
`String`	`getPermissionLabel()` Get the permission's label.
`String`	`getPermissionName()` Get the permission name.
`PrincipalEntity`	`getPrincipal()` Get the principal entity.
`ResourceTypeEntity`	`getResourceType()` Get the resource type entity.
`Integer`	`getSortOrder()` Gets the explicit sort order value for this PermissionEntity This value is used to help explicitly order permission entities.
`int`	`hashCode()`
`void`	`setId(Integer id)` Set the permission id.
`void`	`setPermissionLabel(String permissionLabel)` Set the permission's label.
`void`	`setPermissionName(String permissionName)` Set the permission name.
`void`	`setPrincipal(PrincipalEntity principal)` Set the principal entity.
`void`	`setResourceType(ResourceTypeEntity resourceType)` Set the resource type entity.
`void`	`setSortOrder(Integer sortOrder)` Sets the explicit sort order value for this PermissionEntity

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AMBARI_ADMINISTRATOR_PERMISSION
```
public static final int AMBARI_ADMINISTRATOR_PERMISSION
```
    Admin permission id constants.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_USER_PERMISSION
```
public static final int CLUSTER_USER_PERMISSION
```
    See Also:
    
    Constant Field Values
  - CLUSTER_ADMINISTRATOR_PERMISSION
```
public static final int CLUSTER_ADMINISTRATOR_PERMISSION
```
    See Also:
    
    Constant Field Values
  - VIEW_USER_PERMISSION
```
public static final int VIEW_USER_PERMISSION
```
    See Also:
    
    Constant Field Values
  - AMBARI_ADMINISTRATOR_PERMISSION_NAME
```
public static final String AMBARI_ADMINISTRATOR_PERMISSION_NAME
```
    Admin permission name constants.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_ADMINISTRATOR_PERMISSION_NAME
```
public static final String CLUSTER_ADMINISTRATOR_PERMISSION_NAME
```
    See Also:
    
    Constant Field Values
  - CLUSTER_OPERATOR_PERMISSION_NAME
```
public static final String CLUSTER_OPERATOR_PERMISSION_NAME
```
    See Also:
    
    Constant Field Values
  - SERVICE_ADMINISTRATOR_PERMISSION_NAME
```
public static final String SERVICE_ADMINISTRATOR_PERMISSION_NAME
```
    See Also:
    
    Constant Field Values
  - SERVICE_OPERATOR_PERMISSION_NAME
```
public static final String SERVICE_OPERATOR_PERMISSION_NAME
```
    See Also:
    
    Constant Field Values
  - CLUSTER_USER_PERMISSION_NAME
```
public static final String CLUSTER_USER_PERMISSION_NAME
```
    See Also:
    
    Constant Field Values
  - VIEW_USER_PERMISSION_NAME
```
public static final String VIEW_USER_PERMISSION_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PermissionEntity
```
public PermissionEntity()
```
- Method Detail
  - getId
```
public Integer getId()
```
    Get the permission id.
    
    Returns:
    
    the permission id.
  - setId
```
public void setId(Integer id)
```
    Set the permission id.
    
    Parameters:
    
    id - the type id.
  - getPermissionName
```
public String getPermissionName()
```
    Get the permission name.
    
    Returns:
    
    the permission name
  - setPermissionName
```
public void setPermissionName(String permissionName)
```
    Set the permission name.
    
    Parameters:
    
    permissionName - the permission name
  - getPermissionLabel
```
public String getPermissionLabel()
```
    Get the permission's label.
    
    Returns:
    
    the permission's label
  - setPermissionLabel
```
public void setPermissionLabel(String permissionLabel)
```
    Set the permission's label.
    
    Parameters:
    
    permissionLabel - the permission's label
  - getPrincipal
```
public PrincipalEntity getPrincipal()
```
    Get the principal entity.
    
    Returns:
    
    the principal entity
  - setPrincipal
```
public void setPrincipal(PrincipalEntity principal)
```
    Set the principal entity.
    
    Parameters:
    
    principal - the principal entity
  - getResourceType
```
public ResourceTypeEntity getResourceType()
```
    Get the resource type entity.
    
    Returns:
    
    the resource type entity
  - setResourceType
```
public void setResourceType(ResourceTypeEntity resourceType)
```
    Set the resource type entity.
    
    Parameters:
    
    resourceType - the resource type entity
  - getAuthorizations
```
public Collection<RoleAuthorizationEntity> getAuthorizations()
```
    Gets the collection of granular authorizations for this PermissionEntity
    
    Returns:
    
    a collection of granular authorizations
  - addAuthorization
```
public void addAuthorization(RoleAuthorizationEntity roleAuthorization)
```
    Add roleAuthorization if it's not already added
  - addAuthorizations
```
public void addAuthorizations(Collection<RoleAuthorization> roleAuthorizations)
```
    Add multiple role authorizations
  - getSortOrder
```
public Integer getSortOrder()
```
    Gets the explicit sort order value for this PermissionEntity
    This value is used to help explicitly order permission entities. For example, order from most permissive to least permissive.
    
    Returns:
    
    the explict sorting order value
  - setSortOrder
```
public void setSortOrder(Integer sortOrder)
```
    Sets the explicit sort order value for this PermissionEntity
    
    Parameters:
    
    sortOrder - a sorting order value
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class PermissionEntity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AMBARI_ADMINISTRATOR_PERMISSION

CLUSTER_USER_PERMISSION

CLUSTER_ADMINISTRATOR_PERMISSION

VIEW_USER_PERMISSION

AMBARI_ADMINISTRATOR_PERMISSION_NAME

CLUSTER_ADMINISTRATOR_PERMISSION_NAME

CLUSTER_OPERATOR_PERMISSION_NAME

SERVICE_ADMINISTRATOR_PERMISSION_NAME

SERVICE_OPERATOR_PERMISSION_NAME

CLUSTER_USER_PERMISSION_NAME

VIEW_USER_PERMISSION_NAME

Constructor Detail

PermissionEntity

Method Detail

getId

setId

getPermissionName

setPermissionName

getPermissionLabel

setPermissionLabel

getPrincipal

setPrincipal

getResourceType

setResourceType

getAuthorizations

addAuthorization

addAuthorizations

getSortOrder

setSortOrder

equals

hashCode