MockPrincipal (eframe 0.5 API)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

org.simplemes.eframe.test.MockPrincipal

All Implemented Interfaces and Traits:

java.security.Principal
```
class MockPrincipal
extends java.lang.Object
implements java.security.Principal
```
A mock of the user Principal for use in unit tests only. Provides the specified (optional) roles for the user.

Properties Summary

Properties
Type	Name and description
`private java.util.Map`	`attributes` The attributes (simulates the attributes in AuthenticationJWTClaimsSetAdapter).
`private java.lang.String`	`userName` The Mock user name.

Constructor Summary

Constructors
Constructor and description
`MockPrincipal ()` Builds a mock principal for the user 'TEST' ( SecurityUtils#TEST_USER#TEST_USER ).
`MockPrincipal (java.lang.String userName)` Builds a mock principal for the given user (required).
`MockPrincipal (java.lang.String userName, java.util.List<java.lang.String> roles)` Builds a mock principal for the given user (required).
`MockPrincipal (java.lang.String userName, java.lang.String role)` Builds a mock principal for the given user (required).
`MockPrincipal ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.Map`	`getAttributes()` The mock attributes.
	`java.lang.String`	`getName()` Returns the name of this principal.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - private java.util.Map attributes
    
    The attributes (simulates the attributes in AuthenticationJWTClaimsSetAdapter).
  - private java.lang.String userName
    
    The Mock user name.
- Constructor Detail
  - MockPrincipal()
    
    Builds a mock principal for the user 'TEST' ( SecurityUtils#TEST_USER#TEST_USER ). No roles assigned.
  - MockPrincipal(java.lang.String userName)
    
    Builds a mock principal for the given user (required). No roles assigned.
    Parameters:
    userName - The user name.
  - @java.lang.SuppressWarnings(value: unused) MockPrincipal(java.lang.String userName, java.util.List<java.lang.String> roles)
    
    Builds a mock principal for the given user (required).
    Parameters:
    userName - The user name.
    roles - The roles the mock user has.
  - MockPrincipal(java.lang.String userName, java.lang.String role)
    
    Builds a mock principal for the given user (required).
    Parameters:
    userName - The user name.
    role - The role the mock user has.
  - MockPrincipal()
- Method Detail
  - java.util.Map getAttributes()
    
    The mock attributes. @return
  - @java.lang.Override java.lang.String getName()
    
    Returns the name of this principal.
    Returns:
    the name of this principal.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation