BasicSecurityPrincipal (UserModule 4.1.0.RELEASE API)

java.lang.Object
- com.foreach.across.modules.hibernate.business.SettableIdBasedEntity<T>
- - com.foreach.across.modules.user.business.BasicSecurityPrincipal<T>

All Implemented Interfaces:

com.foreach.across.modules.hibernate.business.Auditable<String>, com.foreach.across.modules.hibernate.business.EntityWithDto<T>, com.foreach.across.modules.hibernate.business.IdBasedEntity, com.foreach.across.modules.spring.security.infrastructure.business.SecurityPrincipal, IdBasedSecurityPrincipal, org.springframework.data.domain.Persistable<Long>

Direct Known Subclasses:

Group, GroupedPrincipal
```
@NotThreadSafe
 @Entity
public abstract class BasicSecurityPrincipal<T extends com.foreach.across.modules.hibernate.business.SettableIdBasedEntity<?>>
extends com.foreach.across.modules.hibernate.business.SettableIdBasedEntity<T>
implements IdBasedSecurityPrincipal, com.foreach.across.modules.hibernate.business.Auditable<String>
```
Represents a security principal that can be assigned one or more roles.

Author:

Arne Vandamme

Constructor Summary

Constructors
Constructor and Description

BasicSecurityPrincipal()

Constructors
Constructor and Description
`BasicSecurityPrincipal()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRole(Role role)`
`protected void`	`buildAuthoritySet(Set<org.springframework.security.core.GrantedAuthority> authorities)`
`Collection<? extends org.springframework.security.core.GrantedAuthority>`	`getAuthorities()`
`String`	`getCreatedBy()`
`Date`	`getCreatedDate()`
`Long`	`getId()`
`String`	`getLastModifiedBy()`
`Date`	`getLastModifiedDate()`
`String`	`getPrincipalName()`
`Set<Role>`	`getRoles()`
`UserDirectory`	`getUserDirectory()`
`boolean`	`hasPermission(Permission permission)`
`boolean`	`hasPermission(String authority)` Does the user have a permission with the requested authority string.
`boolean`	`hasRole(Role role)`
`boolean`	`hasRole(String authority)` Does the user have a role with the given authority string.
`void`	`removeRole(Role role)`
`void`	`setCreatedBy(String createdBy)`
`void`	`setCreatedDate(Date createdDate)`
`void`	`setId(Long id)`
`void`	`setLastModifiedBy(String lastModifiedBy)`
`void`	`setLastModifiedDate(Date lastModifiedDate)`
`protected void`	`setPrincipalName(String principalName)`
`void`	`setRoles(Collection<Role> roles)`
`void`	`setUserDirectory(UserDirectory userDirectory)`
`String`	`toString()`
`static String`	`uniquePrincipalName(String name, UserDirectory userDirectory)` Converts a partial principal name to a globally unique principal name including the user directory.

Methods inherited from class com.foreach.across.modules.hibernate.business.SettableIdBasedEntity
equals, getNewEntityId, hashCode, isNew, setNewEntityId, toDto

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

Methods inherited from interface com.foreach.across.modules.spring.security.infrastructure.business.SecurityPrincipal
getSecurityPrincipalId

- Constructor Detail
  - BasicSecurityPrincipal
```
public BasicSecurityPrincipal()
```
- Method Detail
  - getPrincipalName
```
public String getPrincipalName()
```
    Specified by:
    
    getPrincipalName in interface com.foreach.across.modules.spring.security.infrastructure.business.SecurityPrincipal
  - setPrincipalName
```
protected void setPrincipalName(String principalName)
```
  - getId
```
public Long getId()
```
    Specified by:
    
    getId in interface com.foreach.across.modules.hibernate.business.IdBasedEntity
    
    Specified by:
    
    getId in interface org.springframework.data.domain.Persistable<Long>
  - setId
```
public void setId(Long id)
```
    Specified by:
    
    setId in class com.foreach.across.modules.hibernate.business.SettableIdBasedEntity<T extends com.foreach.across.modules.hibernate.business.SettableIdBasedEntity<?>>
  - getUserDirectory
```
public UserDirectory getUserDirectory()
```
  - setUserDirectory
```
public void setUserDirectory(UserDirectory userDirectory)
```
  - getCreatedBy
```
public String getCreatedBy()
```
    Specified by:
    
    getCreatedBy in interface com.foreach.across.modules.hibernate.business.Auditable<String>
  - setCreatedBy
```
public void setCreatedBy(String createdBy)
```
    Specified by:
    
    setCreatedBy in interface com.foreach.across.modules.hibernate.business.Auditable<String>
  - getCreatedDate
```
public Date getCreatedDate()
```
    Specified by:
    
    getCreatedDate in interface com.foreach.across.modules.hibernate.business.Auditable<String>
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    Specified by:
    
    setCreatedDate in interface com.foreach.across.modules.hibernate.business.Auditable<String>
  - getLastModifiedBy
```
public String getLastModifiedBy()
```
    Specified by:
    
    getLastModifiedBy in interface com.foreach.across.modules.hibernate.business.Auditable<String>
  - setLastModifiedBy
```
public void setLastModifiedBy(String lastModifiedBy)
```
    Specified by:
    
    setLastModifiedBy in interface com.foreach.across.modules.hibernate.business.Auditable<String>
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    Specified by:
    
    getLastModifiedDate in interface com.foreach.across.modules.hibernate.business.Auditable<String>
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    Specified by:
    
    setLastModifiedDate in interface com.foreach.across.modules.hibernate.business.Auditable<String>
  - getRoles
```
public Set<Role> getRoles()
```
  - setRoles
```
public void setRoles(Collection<Role> roles)
```
  - hasRole
```
public boolean hasRole(String authority)
```
    Does the user have a role with the given authority string. This will perform an authority check, but only within the collection of roles.
    
    Parameters:
    
    authority - string the role should have
    
    Returns:
    
    true if a role with that authority was present
  - hasRole
```
public boolean hasRole(Role role)
```
  - addRole
```
public void addRole(Role role)
```
  - removeRole
```
public void removeRole(Role role)
```
  - hasPermission
```
public boolean hasPermission(String authority)
```
    Does the user have a permission with the requested authority string.
    
    Parameters:
    
    authority - string to check
    
    Returns:
    
    true if permission is present
  - hasPermission
```
public boolean hasPermission(Permission permission)
```
  - getAuthorities
```
public Collection<? extends org.springframework.security.core.GrantedAuthority> getAuthorities()
```
    Specified by:
    
    getAuthorities in interface com.foreach.across.modules.spring.security.infrastructure.business.SecurityPrincipal
  - buildAuthoritySet
```
protected void buildAuthoritySet(Set<org.springframework.security.core.GrantedAuthority> authorities)
```
  - toString
```
public final String toString()
```
    Specified by:
    
    toString in interface com.foreach.across.modules.spring.security.infrastructure.business.SecurityPrincipal
    
    Overrides:
    
    toString in class Object
  - uniquePrincipalName
```
public static String uniquePrincipalName(String name,
                                         UserDirectory userDirectory)
```
    Converts a partial principal name to a globally unique principal name including the user directory.
    
    Parameters:
    
    name - current or partial principal name
    
    userDirectory - user directory
    
    Returns:
    
    unique principal name

Class BasicSecurityPrincipal<T extends com.foreach.across.modules.hibernate.business.SettableIdBasedEntity<?>>

Constructor Summary

Method Summary

Methods inherited from class com.foreach.across.modules.hibernate.business.SettableIdBasedEntity

Methods inherited from class java.lang.Object

Methods inherited from interface com.foreach.across.modules.spring.security.infrastructure.business.SecurityPrincipal

Constructor Detail

BasicSecurityPrincipal

Method Detail

getPrincipalName

setPrincipalName

getId

setId

getUserDirectory

setUserDirectory

getCreatedBy

setCreatedBy

getCreatedDate

setCreatedDate

getLastModifiedBy

setLastModifiedBy

getLastModifiedDate

setLastModifiedDate

getRoles

setRoles

hasRole

hasRole

addRole

removeRole

hasPermission

hasPermission

getAuthorities

buildAuthoritySet

toString

uniquePrincipalName