org.wildfly.security.x500

Class X500AttributePrincipalDecoder

java.lang.Object

org.wildfly.security.x500.X500AttributePrincipalDecoder

All Implemented Interfaces:

Function<Principal,String>, PrincipalDecoder

public final class X500AttributePrincipalDecoder
extends Object
implements PrincipalDecoder

A principal decoder which decodes an attribute from an X.500 principal.

Author:

David M. Lloyd

Field Summary

Fields inherited from interface org.wildfly.security.auth.server.PrincipalDecoder

DEFAULT, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
X500AttributePrincipalDecoder(String oid) Construct a new instance.
X500AttributePrincipalDecoder(String oid, boolean reverse) Construct a new instance.
X500AttributePrincipalDecoder(String oid, int maximumSegments) Construct a new instance.
X500AttributePrincipalDecoder(String oid, int maximumSegments, boolean reverse) Construct a new instance.
X500AttributePrincipalDecoder(String oid, int startSegment, int maximumSegments) Construct a new instance.
X500AttributePrincipalDecoder(String oid, int startSegment, int maximumSegments, boolean reverse) Construct a new instance.
X500AttributePrincipalDecoder(String oid, String joiner) Construct a new instance.
X500AttributePrincipalDecoder(String oid, String joiner, boolean reverse) Construct a new instance.
X500AttributePrincipalDecoder(String oid, String joiner, int maximumSegments) Construct a new instance.
X500AttributePrincipalDecoder(String oid, String joiner, int startSegment, int maximumSegments, boolean reverse) Construct a new instance.
X500AttributePrincipalDecoder(String oid, String joiner, int startSegment, int maximumSegments, boolean reverse, boolean convert, String... requiredOids) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
String	getName(Principal principal) Get the name from a principal.

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.auth.server.PrincipalDecoder

aggregate, apply, asPrincipalRewriter, concatenating, concatenating, constant, withRewriter

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

X500AttributePrincipalDecoder

public X500AttributePrincipalDecoder(String oid)

Construct a new instance. A joining string of "." is assumed.

Parameters:

oid - the OID of the attribute to map

X500AttributePrincipalDecoder

public X500AttributePrincipalDecoder(String oid,
                                     boolean reverse)

Construct a new instance. A joining string of "." is assumed.

Parameters:

oid - the OID of the attribute to map

reverse - true if the attribute values should be processed and returned in reverse order

X500AttributePrincipalDecoder

public X500AttributePrincipalDecoder(String oid,
                                     int maximumSegments)

Construct a new instance. A joining string of "." is assumed.

Parameters:

oid - the OID of the attribute to map

maximumSegments - the maximum number of occurrences of the attribute to map

X500AttributePrincipalDecoder

public X500AttributePrincipalDecoder(String oid,
                                     int maximumSegments,
                                     boolean reverse)

Construct a new instance. A joining string of "." is assumed.

Parameters:

oid - the OID of the attribute to map

maximumSegments - the maximum number of occurrences of the attribute to map

reverse - true if the attribute values should be processed and returned in reverse order

X500AttributePrincipalDecoder

public X500AttributePrincipalDecoder(String oid,
                                     int startSegment,
                                     int maximumSegments)

Construct a new instance. A joining string of "." is assumed.

Parameters:

oid - the OID of the attribute to map

startSegment - the 0-based starting occurrence of the attribute to map

maximumSegments - the maximum number of occurrences of the attribute to map

X500AttributePrincipalDecoder

public X500AttributePrincipalDecoder(String oid,
                                     int startSegment,
                                     int maximumSegments,
                                     boolean reverse)

Construct a new instance. A joining string of "." is assumed.

Parameters:

oid - the OID of the attribute to map

startSegment - the 0-based starting occurrence of the attribute to map

maximumSegments - the maximum number of occurrences of the attribute to map

reverse - true if the attribute values should be processed and returned in reverse order

X500AttributePrincipalDecoder

public X500AttributePrincipalDecoder(String oid,
                                     String joiner)

Construct a new instance.

Parameters:

oid - the OID of the attribute to map

joiner - the joining string

X500AttributePrincipalDecoder

public X500AttributePrincipalDecoder(String oid,
                                     String joiner,
                                     boolean reverse)

Construct a new instance.

Parameters:

oid - the OID of the attribute to map

joiner - the joining string

reverse - true if the attribute values should be processed and returned in reverse order

X500AttributePrincipalDecoder

public X500AttributePrincipalDecoder(String oid,
                                     String joiner,
                                     int maximumSegments)

Construct a new instance.

Parameters:

oid - the OID of the attribute to map

joiner - the joining string

maximumSegments - the maximum number of occurrences of the attribute to map

X500AttributePrincipalDecoder

public X500AttributePrincipalDecoder(String oid,
                                     String joiner,
                                     int startSegment,
                                     int maximumSegments,
                                     boolean reverse)

Construct a new instance.

Parameters:

oid - the OID of the attribute to map

joiner - the joining string

startSegment - the 0-based starting occurrence of the attribute to map

maximumSegments - the maximum number of occurrences of the attribute to map

reverse - true if the attribute values should be processed and returned in reverse order

X500AttributePrincipalDecoder

public X500AttributePrincipalDecoder(String oid,
                                     String joiner,
                                     int startSegment,
                                     int maximumSegments,
                                     boolean reverse,
                                     boolean convert,
                                     String... requiredOids)

Construct a new instance.

Parameters:

oid - the OID of the attribute to map

joiner - the joining string

startSegment - the 0-based starting occurrence of the attribute to map

maximumSegments - the maximum number of occurrences of the attribute to map

reverse - true if the attribute values should be processed and returned in reverse order

convert - true if the Principal should be converted to X500Principal if not one already

requiredOids - the OIDs of the attributes that must be present

Method Detail

getName

public String getName(Principal principal)

Description copied from interface: PrincipalDecoder

Get the name from a principal. If this decoder cannot understand the given principal type or contents, null is returned.

Specified by:

getName in interface PrincipalDecoder

Parameters:

principal - the principal to decode

Returns:

the name, or null if this decoder does not understand the principal