com.technia.tif.enovia.security

Interface AuthorizationContext

@API
public interface AuthorizationContext

Provides information to the Authorizer.

Since:

2019-02-04

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getHeaderNames() Returns a list of all the header names this request contains.
java.lang.String	getHeaderValue(java.lang.String name) Returns the value of the specified header as a String.
java.util.List<java.lang.String>	getHeaderValues(java.lang.String name) Returns all the values of the specified header.
java.util.List<java.lang.String>	getParameterNames()
java.lang.String	getParameterValue(java.lang.String name)
java.lang.String[]	getParameterValues(java.lang.String name)
java.security.Principal	getPrincipal()
java.lang.String	getUserName()
boolean	hasPrincipal()
boolean	isPrincipalInRole(java.lang.String role)

Method Detail

hasPrincipal

boolean hasPrincipal()

Returns:

True if we have Principals associated. Typically this is TRUE in case we use container managed credentials.

getPrincipal

java.security.Principal getPrincipal()

Returns:

The Principal if available

getUserName

java.lang.String getUserName()

Returns:

The user name if available

isPrincipalInRole

boolean isPrincipalInRole(java.lang.String role)

Parameters:

role - The name of the role to test

Returns:

True if the user is memeber of the role

getParameterValues

java.lang.String[] getParameterValues(java.lang.String name)

Parameters:

name - The name of the parameter

Returns:

An array of values (or null)

getParameterValue

java.lang.String getParameterValue(java.lang.String name)

Parameters:

name - The name of the parameter

Returns:

The value of the parameter.

getParameterNames

java.util.List<java.lang.String> getParameterNames()

Returns:

The name of the parameters available.

Since:

2022.2.0

getHeaderValue

java.lang.String getHeaderValue(java.lang.String name)

Returns the value of the specified header as a String. If the request did not include a header of the specified name, this method returns null.

If there are multiple headers with the same name, this method returns the first head in the request. The header name is case insensitive

Parameters:

name - The name of the header

Returns:

A String containing the value of the requested header, or null if the request does not have a header of that name

Since:

2022.2.0

getHeaderValues

java.util.List<java.lang.String> getHeaderValues(java.lang.String name)

Returns all the values of the specified header. If there are no headers of the specified name, this method returns an empty List. The header name is case insensitive.

Parameters:

name - The name of the header

Returns:

A list containing the values of the headers, never null.

Since:

2022.2.0

getHeaderNames

java.util.List<java.lang.String> getHeaderNames()

Returns a list of all the header names this request contains. If there are no headers available, an empty list is returned.

Returns:

A list of all the header names

Since:

2022.2.0