Package ddf.security.service.impl

Class SubjectUtils

java.lang.Object

ddf.security.service.impl.SubjectUtils

All Implemented Interfaces:

ddf.security.SubjectOperations

public final class SubjectUtils
extends Object
implements ddf.security.SubjectOperations

Utility class used to perform operations on Subjects.

Field Summary

Fields inherited from interface ddf.security.SubjectOperations

COUNTRY_CLAIM_URI, EMAIL_ADDRESS_CLAIM_ALTERNATE, EMAIL_ADDRESS_CLAIM_URI, GIVEN_NAME_CLAIM_URI, GUEST_DISPLAY_NAME, LOCALITY_CODE_CLAIM_URI, MOBILE_PHONE_CLAIM_URI, NAME_CLAIM_URI, NAME_IDENTIFIER_CLAIM_ALTERNATE, NAME_IDENTIFIER_CLAIM_URI, POSTAL_CODE_CLAIM_URI, ROLE_CLAIM_URI, STREET_ADDRESS_CLAIM_URI, SURNAME_CLAIM_URI

Constructor Summary

Constructors

Constructor	Description
SubjectUtils()

Method Summary

Modifier and Type	Method	Description
String	filterDN(X500Principal principal, Predicate<org.bouncycastle.asn1.x500.RDN> predicate)
Comparator<ddf.security.assertion.SecurityAssertion>	getAssertionComparator()
List<String>	getAttribute(org.apache.shiro.subject.Subject subject, String key)	Get any attribute from a subject by key.
String	getCommonName(X500Principal principal)
String	getCountry(X500Principal principal)
String	getEmailAddress(X500Principal principal)
String	getEmailAddress(org.apache.shiro.subject.Subject subject)	Get a subject's email.
String	getName(org.apache.shiro.subject.Subject subject)	Retrieves the user name from a given subject.
String	getName(org.apache.shiro.subject.Subject subject, String defaultName)	Retrieves the user name from a given subject.
String	getName(org.apache.shiro.subject.Subject subject, String defaultName, boolean returnDisplayName)	Retrieves the user name from a given subject.
Map<String,SortedSet<String>>	getSubjectAttributes(org.apache.shiro.subject.Subject subject)	Retrieves the security attributes for the given subject.
String	getType(org.apache.shiro.subject.Subject subject)	Retrieves the type of the Security Assertion inside the given Subject.
boolean	isGuest(org.apache.shiro.subject.Subject subject)

Methods inherited from class java.lang.Object

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

Constructor Details

SubjectUtils

public SubjectUtils()

Method Details

getName

public String getName(org.apache.shiro.subject.Subject subject)

Retrieves the user name from a given subject.

Specified by:

getName in interface ddf.security.SubjectOperations

Parameters:

subject - Subject to get the user name from.

Returns:

String representation of the user name if available or null if no user name could be found.

getName

public String getName(org.apache.shiro.subject.Subject subject,
 String defaultName)

Retrieves the user name from a given subject.

Specified by:

getName in interface ddf.security.SubjectOperations

Parameters:

subject - Subject to get the user name from.

Returns:

String representation of the user name if available or null if no user name could be found.

getName

public String getName(org.apache.shiro.subject.Subject subject,
 String defaultName,
 boolean returnDisplayName)

Retrieves the user name from a given subject.

Specified by:

getName in interface ddf.security.SubjectOperations

Parameters:

subject - Subject to get the user name from.

defaultName - Name to send back if no user name was found.

returnDisplayName - return formatted user name for displaying

Returns:

String representation of the user name if available or defaultName if no user name could be found or incoming subject was null.

getCommonName

public String getCommonName(X500Principal principal)

Specified by:

getCommonName in interface ddf.security.SubjectOperations

getEmailAddress

public String getEmailAddress(X500Principal principal)

Specified by:

getEmailAddress in interface ddf.security.SubjectOperations

getCountry

public String getCountry(X500Principal principal)

Specified by:

getCountry in interface ddf.security.SubjectOperations

filterDN

public String filterDN(X500Principal principal,
 Predicate<org.bouncycastle.asn1.x500.RDN> predicate)

Specified by:

filterDN in interface ddf.security.SubjectOperations

getEmailAddress

@Nullable
public String getEmailAddress(org.apache.shiro.subject.Subject subject)

Get a subject's email.

Specified by:

getEmailAddress in interface ddf.security.SubjectOperations

Parameters:

subject -

Returns:

email or null if not found.

getAttribute

public List<String> getAttribute(@Nullable
 org.apache.shiro.subject.Subject subject,
 String key)

Get any attribute from a subject by key.

Specified by:

getAttribute in interface ddf.security.SubjectOperations

Parameters:

subject -

key -

Returns:

attribute values or an empty list if not found.

getSubjectAttributes

public Map<String,SortedSet<String>> getSubjectAttributes(org.apache.shiro.subject.Subject subject)

Retrieves the security attributes for the given subject.

Specified by:

getSubjectAttributes in interface ddf.security.SubjectOperations

Parameters:

subject - the Subject to check

Returns:

Map of attributes with the collected values for each

getType

public String getType(org.apache.shiro.subject.Subject subject)

Retrieves the type of the Security Assertion inside the given Subject.

Specified by:

getType in interface ddf.security.SubjectOperations

Parameters:

subject - Subject to get the user name from.

Returns:

String representation of the user name if available or defaultName if no user name could be found or incoming subject was null.

isGuest

public boolean isGuest(org.apache.shiro.subject.Subject subject)

Specified by:

isGuest in interface ddf.security.SubjectOperations

getAssertionComparator

public Comparator<ddf.security.assertion.SecurityAssertion> getAssertionComparator()

Specified by:

getAssertionComparator in interface ddf.security.SubjectOperations