com.sun.identity.authentication.util

Class AMAuthUtils

java.lang.Object

com.sun.identity.authentication.util.AMAuthUtils

public class AMAuthUtils
extends Object

This class provides utility methods to Policy and Administration console service to get realm qualified Authentication data.

Method Summary

Modifier and Type	Method and Description
static Set<String>	getAuthenticatedLevels(SSOToken token) Returns the set of all authenticated levels.
static Set	getAuthenticatedRealms(SSOToken token) Returns the set of all authenticated Realm names.
static Set<String>	getAuthenticatedRoles(SSOToken token) Returns the set of all authenticated roles.
static Set<String>	getAuthenticatedSchemes(SSOToken token) Returns the set of all authenticated Scheme names.
static Set<String>	getAuthenticatedServices(SSOToken token) Returns the set of all authenticated Service names.
static long	getAuthInstant(SSOToken ssoToken, String authType, String authValue) Returns time at which the particular authentication occured
static String	getDataFromRealmQualifiedData(String realmQualifedData) Returns the data from Realm qualified data.
static Map	getModuleAuthTimeMap(SSOToken ssoToken) Returns a Map with all Auth Module instance names as key and the time the module was authenticated as value.
static List	getModuleInstancesForHttpBasic(String realmName) Returns the list of configured module instances that could be used by HTTP Basic
static String	getRealmFromRealmQualifiedData(String realmQualifedData) Returns the Realm name from Realm qualified data.
static Set	getRealmQualifiedAuthenticatedLevels(SSOToken token) Returns the set of all authenticated realm qualified authentication levels.
static Set	getRealmQualifiedAuthenticatedSchemes(SSOToken token) Returns the set of all authenticated realm qualified scheme names.
static Set	getRealmQualifiedAuthenticatedServices(SSOToken token) Returns the set of all authenticated realm qualified service names.
static String	toRealmQualifiedAuthnData(String realm, String data) Returns the given data in Realm qualified format.

Methods inherited from class java.lang.Object

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

Method Detail

getAuthenticatedRealms

public static Set getAuthenticatedRealms(SSOToken token)
                                  throws SSOException

Returns the set of all authenticated Realm names.

Parameters:

token - valid user SSOToken

Returns:

Set containing String values representing Realm names.

Throws:

SSOException - if token.getProperty() fails.

getAuthenticatedSchemes

public static Set<String> getAuthenticatedSchemes(SSOToken token)
                                           throws SSOException

Returns the set of all authenticated Scheme names.

Parameters:

token - valid user SSOToken

Returns:

Set containing String values representing Scheme names.

Throws:

SSOException - if token.getProperty() fails.

getAuthenticatedServices

public static Set<String> getAuthenticatedServices(SSOToken token)
                                            throws SSOException

Returns the set of all authenticated Service names.

Parameters:

token - valid user SSOToken

Returns:

Set containing String values representing Service names.

Throws:

SSOException - if token.getProperty() fails.

getAuthenticatedLevels

public static Set<String> getAuthenticatedLevels(SSOToken token)
                                          throws SSOException

Returns the set of all authenticated levels.

Parameters:

token - valid user SSOToken

Returns:

Set containing String values representing levels.

Throws:

SSOException - if token.getProperty() fails.

getAuthenticatedRoles

public static Set<String> getAuthenticatedRoles(SSOToken token)
                                         throws SSOException

Returns the set of all authenticated roles.

Parameters:

token - valid user SSOToken

Returns:

Set containing the String role names.

Throws:

SSOException - if SSOToken.getProperty(String) fails.

getRealmQualifiedAuthenticatedSchemes

public static Set getRealmQualifiedAuthenticatedSchemes(SSOToken token)
                                                 throws SSOException

Returns the set of all authenticated realm qualified scheme names.

Parameters:

token - valid user SSOToken

Returns:

Set containing String values representing realm qualified scheme names.

Throws:

SSOException - if token.getProperty() fails.

getRealmQualifiedAuthenticatedServices

public static Set getRealmQualifiedAuthenticatedServices(SSOToken token)
                                                  throws SSOException

Returns the set of all authenticated realm qualified service names.

Parameters:

token - valid user SSOToken

Returns:

Set containing String values representing realm qualified service names.

Throws:

SSOException - if token.getProperty() fails.

getRealmQualifiedAuthenticatedLevels

public static Set getRealmQualifiedAuthenticatedLevels(SSOToken token)
                                                throws SSOException

Returns the set of all authenticated realm qualified authentication levels.

Parameters:

token - valid user SSOToken

Returns:

Set containing String values representing realm qualified authentication levels.

Throws:

SSOException - if token.getProperty() fails.

toRealmQualifiedAuthnData

public static String toRealmQualifiedAuthnData(String realm,
                                               String data)

Returns the given data in Realm qualified format.

Parameters:

realm - valid Realm

data - data which qualifies for Realm qualified data. This could be authentication scheme or authentication level or service.

Returns:

String representing realm qualified authentication data.

getRealmFromRealmQualifiedData

public static String getRealmFromRealmQualifiedData(String realmQualifedData)

Returns the Realm name from Realm qualified data.

Parameters:

realmQualifedData - Realm qualified data. This could be Realm qualified authentication scheme or authentication level or service.

Returns:

String representing realm name.

getDataFromRealmQualifiedData

public static String getDataFromRealmQualifiedData(String realmQualifedData)

Returns the data from Realm qualified data. This could be authentication scheme or authentication level or service.

Parameters:

realmQualifedData - Realm qualified data. This could be Realm qualified authentication scheme or authentication level or service.

Returns:

String representing data. This could be authentication scheme or authentication level or service.

getModuleAuthTimeMap

public static Map getModuleAuthTimeMap(SSOToken ssoToken)

Returns a Map with all Auth Module instance names as key and the time the module was authenticated as value.

Parameters:

ssoToken - valid user's single sign on token.

Returns:

Map containing module instace auth time.

getAuthInstant

public static long getAuthInstant(SSOToken ssoToken,
                                  String authType,
                                  String authValue)

Returns time at which the particular authentication occured

Parameters:

ssoToken - valid user SSOToken

authType - valid Authentication Type.

authValue - valid Authentication value.

Returns:

long value of authentication time.

getModuleInstancesForHttpBasic

public static List getModuleInstancesForHttpBasic(String realmName)

Returns the list of configured module instances that could be used by HTTP Basic

Parameters:

realmName - Realm Name

Returns:

the list of configured module instances that could be used by HTTP Basic