Package de.xima.fc.security.authorization.filter

Class AzureAdProfileAttributeFilterExtension

java.lang.Object

de.xima.fc.security.authorization.filter.AzureAdProfileAttributeFilterExtension

All Implemented Interfaces:

IPluginProfileFilterExtension

public class AzureAdProfileAttributeFilterExtension
extends Object
implements IPluginProfileFilterExtension

Built-in default implementation for a plugin profile filter extensions for authenticators of type EAuthClientType.AZURE_AD.

Since:

8.0.0

Author:

XIMA Media GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static IPluginProfileFilterExtension	INSTANCE

Method Summary

Modifier and Type	Method	Description
List<IPluginProfileFilterAttribute>	getAttributeOptions(IPluginProfileFilterAttributeOptionsGetParams params)	Returns a list of profile attribute options (left-hand side) for which a single (atomic) filter can be set.
@NotBlank String	getAttributeType()	Returns the type of attributes that this extension provides.
List<EMatchCondition>	getMatchConditions(IPluginProfileFilterMatchConditionGetParams params)	Returns a list of available match conditions for single (atomic) filter based on the filter attribute (left-hand side) and client (IClientDescriptor).
Object	getProfileAttributeValue(IPluginProfileFilterEvaluationParams params)	Evaluates the profile attribute value for the given parameters (attribute name & profile)
IPluginProfileFilterValue	getValue(IPluginProfileFilterValueGetParams params)	Returns the exact value representing the.
List<IPluginProfileFilterValue>	getValueOptions(IPluginProfileFilterValueOptionsGetParams params)	Returns a list of options that can be use in a single (atomic) filter as values (right-hand-side).

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final IPluginProfileFilterExtension INSTANCE

Method Detail

getAttributeType

@NotBlank
public @NotBlank String getAttributeType()

Description copied from interface: IPluginProfileFilterExtension

Returns the type of attributes that this extension provides. The type needs to be unique in the system and is used to distinguish different attributes from one another. Therefore the type can't be blank. The attribute type must not contain the symbol "#".

Specified by:

getAttributeType in interface IPluginProfileFilterExtension

Returns:

the type of attributes that this extension provides. Cannot be blank and cannot be "JSON_PATH"!

getAttributeOptions

public List<IPluginProfileFilterAttribute> getAttributeOptions(IPluginProfileFilterAttributeOptionsGetParams params)

Description copied from interface: IPluginProfileFilterExtension

Returns a list of profile attribute options (left-hand side) for which a single (atomic) filter can be set. This method should always return a complete list of the available attribute options for the given parameters (authentication client).

Specified by:

getAttributeOptions in interface IPluginProfileFilterExtension

Parameters:

params - Parameters with the client descriptors.

Returns:

a list of profile attributes for which filters can be set.

getMatchConditions

public List<EMatchCondition> getMatchConditions(IPluginProfileFilterMatchConditionGetParams params)

Description copied from interface: IPluginProfileFilterExtension

Returns a list of available match conditions for single (atomic) filter based on the filter attribute (left-hand side) and client (IClientDescriptor). This limits the list of available match conditions to choose from. If the list is empty or null than the default list of match conditions will be available.

Specified by:

getMatchConditions in interface IPluginProfileFilterExtension

Parameters:

params - for determining the list of available match conditions.

Returns:

a list of recommended match conditions for a single (atomic) filter.

getValueOptions

public List<IPluginProfileFilterValue> getValueOptions(IPluginProfileFilterValueOptionsGetParams params)

Description copied from interface: IPluginProfileFilterExtension

Returns a list of options that can be use in a single (atomic) filter as values (right-hand-side). This list can be dependent on the filter attribute (right-hand side). Unlike IPluginProfileFilterExtension.getAttributeOptions(IPluginProfileFilterAttributeOptionsGetParams) this method does not have to return a complete list of value options but rather a list of value options with appropriate entries for the given query.

Specified by:

getValueOptions in interface IPluginProfileFilterExtension

Parameters:

params - Parameters with the client descriptor and filters.

Returns:

a list of value options for a single (atomic) filter.

getValue

public IPluginProfileFilterValue getValue(IPluginProfileFilterValueGetParams params)

Description copied from interface: IPluginProfileFilterExtension

Returns the exact value representing the. This is mainly used for re-displaying the filter value in the GUI with a human readable display name instead of the technical value which might / should be some form of ID.

Specified by:

getValue in interface IPluginProfileFilterExtension

Parameters:

params - Parameters with the client descriptor and filters.

Returns:

the plugin profile filter value for the given parameters (attribute name & value).

getProfileAttributeValue

public Object getProfileAttributeValue(IPluginProfileFilterEvaluationParams params)

Description copied from interface: IPluginProfileFilterExtension

Evaluates the profile attribute value for the given parameters (attribute name & profile)

Specified by:

getProfileAttributeValue in interface IPluginProfileFilterExtension

Parameters:

params - containing the attribute name and user profile.

Returns:

the value of the given profile attribute in the given user profile.