org.wildfly.security.authz

Class SourceAddressRoleDecoder

java.lang.Object

org.wildfly.security.authz.SourceAddressRoleDecoder

All Implemented Interfaces:

RoleDecoder

public class SourceAddressRoleDecoder
extends Object
implements RoleDecoder

A decoder to obtain role information using the source IP address runtime attribute from the identity.

Author:

Farah Juma

Field Summary

Fields inherited from interface org.wildfly.security.authz.RoleDecoder

DEFAULT, EMPTY, KEY_ROLES, KEY_SOURCE_ADDRESS

Constructor Summary

Constructors

Constructor and Description
SourceAddressRoleDecoder(Pattern sourceAddressPattern, Roles roles) Construct a new instance.
SourceAddressRoleDecoder(String sourceAddress, Roles roles) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
Roles	decodeRoles(AuthorizationIdentity authorizationIdentity) Decode the role set using the source IP address runtime attribute from the given authorization identity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wildfly.security.authz.RoleDecoder

aggregate, simple

Constructor Detail

SourceAddressRoleDecoder

public SourceAddressRoleDecoder(String sourceAddress,
                                Roles roles)

Construct a new instance.

Parameters:

sourceAddress - the source IP address to match (cannot be null)

roles - the roles to associate with the identity if the actual source IP address matches the given source IP address

SourceAddressRoleDecoder

public SourceAddressRoleDecoder(Pattern sourceAddressPattern,
                                Roles roles)

Construct a new instance.

Parameters:

sourceAddressPattern - the source IP address pattern to match (cannot be null)

roles - the roles to associate with the identity if the actual source IP address matches the given pattern

Method Detail

decodeRoles

public Roles decodeRoles(AuthorizationIdentity authorizationIdentity)

Decode the role set using the source IP address runtime attribute from the given authorization identity.

Specified by:

decodeRoles in interface RoleDecoder

Parameters:

authorizationIdentity - the authorization identity (not null)

Returns:

the role set (must not be null)