HttpAccessControl (OfficeFloor 3.33.0 API)

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

JwtHttpAccessControl<C>

All Known Implementing Classes:

AnonymousHttpSecuritySource, HttpAccessControlImpl, MockHttpAccessControl
```
public interface HttpAccessControl
extends java.io.Serializable
```
Adapting interface to provide standard access control by the HttpSecuritySource.

Author:

Daniel Sagenschneider

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`java.lang.String`	`getAuthenticationScheme()`	Obtains the authentication scheme used.
`java.security.Principal`	`getPrincipal()`	Obtains the `Principal`.
`boolean`	`inRole(java.lang.String role)`	Indicates if within role.
`default boolean`	`isAccess(java.lang.String[] anyRoles, java.lang.String[] allRoles)`	Indicates if have access.

- Method Detail
  - getAuthenticationScheme
```
java.lang.String getAuthenticationScheme()
```
    Obtains the authentication scheme used.
    
    Returns:
    
    Authentication scheme.
  - getPrincipal
```
java.security.Principal getPrincipal()
```
    Obtains the Principal.
    
    Returns:
    
    Principal.
  - inRole
```
boolean inRole(java.lang.String role)
```
    Indicates if within role.
    
    Parameters:
    
    role - Role to check if have access.
    
    Returns:
    
    true if supports the role.
  - isAccess
```
default boolean isAccess(java.lang.String[] anyRoles,
                         java.lang.String[] allRoles)
```
    Indicates if have access.
    
    Parameters:
    
    anyRoles - Listing of roles that must have access to at least one. May be null.
    
    allRoles - Listing of roles that must have access to all. May be null.
    
    Returns:
    
    true if have access.