|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.metamatrix.platform.security.membership.spi.ldap.LDAPMembershipDomain
public class LDAPMembershipDomain
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_GROUPS_DISPLAY_NAME_ATTRIBUTE
|
static java.lang.String |
DEFAULT_SEARCH_FILTER
|
static java.lang.String |
DEFAULT_USERS_DISPLAY_NAME_ATTRIBUTE
|
static java.lang.String |
GROUPS_DISPLAY_NAME_ATTRIBUTE
|
static java.lang.String |
GROUPS_GROUP_MEMBER_ATTRIBUTE
|
static java.lang.String |
GROUPS_ROOT_CONTEXT
|
static java.lang.String |
GROUPS_SEARCH_FILTER
|
static java.lang.String |
GROUPS_SEARCH_SCOPE
|
static java.lang.String |
LDAP_ADMIN_DN
|
static java.lang.String |
LDAP_ADMIN_PASSWORD
|
static java.lang.String |
LDAP_AUTH_TYPE
|
static java.lang.String |
LDAP_INITIAL_CONTEXT_FACTORY
|
static java.lang.String |
LDAP_REFERRAL_MODE
|
static java.lang.String |
LDAP_URL
|
static java.lang.String |
LDAP_USER_OBJECT_TYPE
|
static java.lang.String |
OBJECT_SCOPE_VALUE
|
static java.lang.String |
ONELEVEL_SCOPE_VALUE
|
static java.lang.String |
POOL_KEY
|
static java.lang.String |
SUBTREE_SCOPE_VALUE
|
static java.lang.String |
TIMEOUT_KEY
|
static java.lang.String |
TXN_TIMEOUT_IN_MILLIS
|
static java.lang.String |
USERS_DISPLAY_NAME_ATTRIBUTE
|
static java.lang.String |
USERS_MEMBER_OF_ATTRIBUTE
|
static java.lang.String |
USERS_ROOT_CONTEXT
|
static java.lang.String |
USERS_SEARCH_FILTER
|
static java.lang.String |
USERS_SEARCH_SCOPE
|
Constructor Summary | |
---|---|
LDAPMembershipDomain()
|
Method Summary | |
---|---|
SuccessfulAuthenticationToken |
authenticateUser(java.lang.String username,
Credentials credential,
java.io.Serializable trustedPayload,
java.lang.String applicationName)
Authenticate a user with the specified username and credential for use with the specified application. |
static java.lang.String |
escapeLDAPSearchFilter(java.lang.String filter)
|
java.util.Set |
getGroupNames()
Returns a String set all group names known to this domain. |
java.util.Set |
getGroupNamesForUser(java.lang.String username)
Returns a String set of all group names the given user is a member of. |
void |
initialize(java.util.Properties props)
Initialize this domain with the given properties. |
void |
shutdown()
Shut down this domain to further work. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ONELEVEL_SCOPE_VALUE
public static final java.lang.String OBJECT_SCOPE_VALUE
public static final java.lang.String SUBTREE_SCOPE_VALUE
public static final java.lang.String GROUPS_GROUP_MEMBER_ATTRIBUTE
public static final java.lang.String GROUPS_ROOT_CONTEXT
public static final java.lang.String GROUPS_SEARCH_SCOPE
public static final java.lang.String GROUPS_SEARCH_FILTER
public static final java.lang.String GROUPS_DISPLAY_NAME_ATTRIBUTE
public static final java.lang.String USERS_MEMBER_OF_ATTRIBUTE
public static final java.lang.String USERS_ROOT_CONTEXT
public static final java.lang.String USERS_SEARCH_SCOPE
public static final java.lang.String USERS_DISPLAY_NAME_ATTRIBUTE
public static final java.lang.String USERS_SEARCH_FILTER
public static final java.lang.String LDAP_URL
public static final java.lang.String LDAP_ADMIN_PASSWORD
public static final java.lang.String LDAP_ADMIN_DN
public static final java.lang.String TXN_TIMEOUT_IN_MILLIS
public static final java.lang.String LDAP_INITIAL_CONTEXT_FACTORY
public static final java.lang.String LDAP_AUTH_TYPE
public static final java.lang.String LDAP_USER_OBJECT_TYPE
public static final java.lang.String LDAP_REFERRAL_MODE
public static final java.lang.String DEFAULT_SEARCH_FILTER
public static final java.lang.String POOL_KEY
public static final java.lang.String TIMEOUT_KEY
public static final java.lang.String DEFAULT_USERS_DISPLAY_NAME_ATTRIBUTE
public static final java.lang.String DEFAULT_GROUPS_DISPLAY_NAME_ATTRIBUTE
Constructor Detail |
---|
public LDAPMembershipDomain()
Method Detail |
---|
public void initialize(java.util.Properties props) throws ServiceStateException
MembershipDomain
initialize
in interface MembershipDomain
props
- contains the properties for this domain as set by the console
ServiceStateException
public void shutdown() throws ServiceStateException
MembershipDomain
shutdown
in interface MembershipDomain
ServiceStateException
public SuccessfulAuthenticationToken authenticateUser(java.lang.String username, Credentials credential, java.io.Serializable trustedPayload, java.lang.String applicationName) throws UnsupportedCredentialException, InvalidUserException, LogonException, MembershipSourceException
MembershipDomain
authenticateUser
in interface MembershipDomain
username
- The base username (without the domain suffix) of the individual attempting authentication. May be null
if the
membership domain implementation uses a mechanism other than username/credential authentication.credential
- The credentials belonging to the individual seeking authentication. May be null
for anonymous authentications.trustedPayload
- The trusted payload set by the client. May be null
if not set by the client.applicationName
- The name of the application to which the individual is attempting to authenticate. It's provided as a connection
property when the individual connects (via URL or connection properties). This applicationName
may be used by the authenticating membership domain as a basis for authentication and authorization.
UnsupportedCredentialException
- if the credential or trustedPayload cannot be used to authenticate the user
InvalidUserException
- if the user does not exist in this domain
LogonException
- if the user was unsuccessfully authenticated
MembershipSourceException
- if there was an internal errorpublic java.util.Set getGroupNames() throws MembershipSourceException
MembershipDomain
getGroupNames
in interface MembershipDomain
MembershipSourceException
- if there was an internal errorpublic java.util.Set getGroupNamesForUser(java.lang.String username) throws InvalidUserException, MembershipSourceException
MembershipDomain
getGroupNamesForUser
in interface MembershipDomain
InvalidUserException
- if the user does not exist in this domain
MembershipSourceException
- if there was an internal errorpublic static final java.lang.String escapeLDAPSearchFilter(java.lang.String filter)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |