Package io.helidon.security

Class ProviderRequest

java.lang.Object

io.helidon.security.ProviderRequest

All Implemented Interfaces:

AbacSupport

public class ProviderRequest
extends java.lang.Object
implements AbacSupport

A request sent to security providers. Contains all information that may be needed to authenticate or authorize a request:

• User's subject: getSubject() - if user is authenticated
• Service subject: getService() - if service is authenticated
• Environment information: getEnv() - path, method etc.
• Object: getObject() - target resource, if provided by user
• Security context: getContext() - current subjects and information about security context of this request
• Endpoint configuration: getEndpointConfig() - annotations, endpoint specific configuration, custom objects, custom atttributes

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.security.util.AbacSupport

AbacSupport.BasicAttributes

Method Summary

Modifier and Type	Method	Description
java.util.Collection<java.lang.String>	getAttributeNames()	A collection of all property names in this container.
java.lang.Object	getAttributeRaw(java.lang.String key)	Return the actual property value or null if not present.
SecurityContext	getContext()
EndpointConfig	getEndpointConfig()
SecurityEnvironment	getEnv()
java.util.Optional<java.lang.Object>	getObject()
java.util.Optional<Entity>	getRequestEntity()	Access request message entity.
java.util.Optional<Entity>	getResponseEntity()	Access response message entity.
java.util.Optional<Subject>	getService()
java.util.Optional<Subject>	getSubject()
static java.util.Optional<java.lang.Object>	getValue(java.lang.Object object, java.lang.String key)	Get a value of a property from an object.

Methods inherited from interface io.helidon.security.util.AbacSupport

getAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getValue

public static java.util.Optional<java.lang.Object> getValue(java.lang.Object object,
                                                            java.lang.String key)

Get a value of a property from an object. If object implements AbacSupport the value is obtained through AbacSupport.getAttribute(String), if not, the value is obtained by reflection from a public field or a public getter method. The method name may be (for attribute called for example "audit"):

• audit
• getAudit
• isAudit
• shouldAudit
• hasAudit

Parameters:

object - object to get attribute from

key - key of the attribute

Returns:

value of the attribute if found

getEndpointConfig

public EndpointConfig getEndpointConfig()

getContext

public SecurityContext getContext()

getSubject

public java.util.Optional<Subject> getSubject()

getService

public java.util.Optional<Subject> getService()

getEnv

public SecurityEnvironment getEnv()

getObject

public java.util.Optional<java.lang.Object> getObject()

getRequestEntity

public java.util.Optional<Entity> getRequestEntity()

Access request message entity.

Returns:

Entity of the request, if current request has entity

getResponseEntity

public java.util.Optional<Entity> getResponseEntity()

Access response message entity.

Returns:

Entity of the response, if current response can have entity

getAttributeRaw

public java.lang.Object getAttributeRaw(java.lang.String key)

Description copied from interface: AbacSupport

Return the actual property value or null if not present. This is the only method that needs to be implemented.

Specified by:

getAttributeRaw in interface AbacSupport

Parameters:

key - key (name) of the property

Returns:

value of the property or null

getAttributeNames

public java.util.Collection<java.lang.String> getAttributeNames()

Description copied from interface: AbacSupport

A collection of all property names in this container.

Specified by:

getAttributeNames in interface AbacSupport

Returns:

collection of keys