org.ow2.jonas.security.internal.realm.factory
Interface JResourceLDAPMBean

All Superinterfaces:

JResourceMBean

All Known Implementing Classes:

JResourceLDAP

public interface JResourceLDAPMBean
extends JResourceMBean

Define the methods for the MBean

Author:

Florent Benoit

Method Summary

void	clearCache() Clear the cache
String	getAlgorithm() Get the default algorithm
String	getAuthenticationMode() Get the mode for validate the authentication of this LDAP realm
String	getBaseDN() Get the DN used for the lookup of this LDAP realm
String	getInitialContextFactory() Return the initial context factory of this LDAP realm
String	getLanguage() Get the preferred language to use with the service of this LDAP realm
String	getProviderUrl() Get the Url of the ldap server of this LDAP realm
String	getReferral() Get how referrals encountered by the service provider are to be processed
String	getRoleDN() Get the DN used when searching the role DN.
String	getRoleNameAttribute() Get the role name when performing a lookup on a role
String	getRoleSearchFilter() Get the filter used when searching the role
String	getSecurityAuthentication() Get the authentication used during the authentication to the LDAP server of this LDAP realm
String	getSecurityCredentials() Get the Credential(password) of the principal of this LDAP realm
String	getSecurityPrincipal() Get the DN of the Principal(username) of this LDAP realm
String	getSecurityProtocol() Get the security protocol to use of this LDAP realm
String	getStateFactories() Get the the list of state factories of this LDAP realm
String	getUserDN() Get the DN used when searching the user DN.
String	getUserPasswordAttribute() Get the attribute in order to get the password of this LDAP realm
String	getUserRolesAttribute() Get the attribute in order to get the user role from the ldap server
String	getUserSearchFilter() Get the filter used when searching the user
void	setAlgorithm(String algorithm) Set the default algorithm to use
void	setAuthenticationMode(String authenticationMode) Set the mode for validate the authentication of this LDAP realm
void	setBaseDN(String baseDN) Set the DN used for the lookup of this LDAP realm
void	setInitialContextFactory(String initialContextFactory) Set the initial context factory of this LDAP realm
void	setLanguage(String language) Set the preferred language to use with the service of this LDAP realm
void	setProviderUrl(String providerUrl) Set the Url of the ldap server of this LDAP realm
void	setReferral(String referral) Set how referrals encountered by the service provider are to be processed
void	setRoleDN(String roleDN) Set the DN used when searching the role DN.
void	setRoleNameAttribute(String roleNameAttribute) Set the role name when performing a lookup on a role
void	setRoleSearchFilter(String roleSearchFilter) Set the filter used when searching the role
void	setSecurityAuthentication(String securityAuthentication) Set the authentication used during the authentication to the LDAP server of this LDAP realm
void	setSecurityCredentials(String securityCredentials) Set the Credential(password) of the principal of this LDAP realm
void	setSecurityPrincipal(String securityPrincipal) Set the DN of the Principal(username) of this LDAP realm
void	setSecurityProtocol(String securityProtocol) Set the security protocol to use of this LDAP realm
void	setStateFactories(String stateFactories) Set the the list of state factories of this LDAP realm
void	setUserDN(String userDN) Set the DN used when searching the user DN.
void	setUserPasswordAttribute(String userPasswordAttribute) Set the attribute in order to get the password of this LDAP realm
void	setUserRolesAttribute(String userRolesAttribute) Set the attribute in order to get the user role from the ldap server
void	setUserSearchFilter(String userSearchFilter) Set the filter used when searching the user

Methods inherited from interface org.ow2.jonas.security.internal.realm.factory.JResourceMBean

getName, saveConfig

Method Detail

clearCache

void clearCache()

Clear the cache

getInitialContextFactory

String getInitialContextFactory()

Return the initial context factory of this LDAP realm

Returns:

the initial context factory

getProviderUrl

String getProviderUrl()

Get the Url of the ldap server of this LDAP realm

Returns:

Url of the ldap server

getSecurityAuthentication

String getSecurityAuthentication()

Get the authentication used during the authentication to the LDAP server of this LDAP realm

Returns:

authentication used during the authentication to the LDAP server

getSecurityPrincipal

String getSecurityPrincipal()

Get the DN of the Principal(username) of this LDAP realm

Returns:

DN of the Principal(username)

getSecurityCredentials

String getSecurityCredentials()

Get the Credential(password) of the principal of this LDAP realm

Returns:

Credential(password) of the principal

getSecurityProtocol

String getSecurityProtocol()

Get the security protocol to use of this LDAP realm

Returns:

security protocol to use

getLanguage

String getLanguage()

Get the preferred language to use with the service of this LDAP realm

Returns:

language preferred language to use with the service

getReferral

String getReferral()

Get how referrals encountered by the service provider are to be processed

Returns:

how referrals encountered by the service provider are to be processed

getStateFactories

String getStateFactories()

Get the the list of state factories of this LDAP realm

Returns:

list of state factories

getAuthenticationMode

String getAuthenticationMode()

Get the mode for validate the authentication of this LDAP realm

Returns:

BIND_AUTHENTICATION_MODE or COMPARE_AUTHENTICATION_MODE

getUserPasswordAttribute

String getUserPasswordAttribute()

Get the attribute in order to get the password of this LDAP realm

Returns:

attribute in order to get the password of this LDAP realm

getUserRolesAttribute

String getUserRolesAttribute()

Get the attribute in order to get the user role from the ldap server

Returns:

attribute in order to get the user role from the ldap server

getRoleNameAttribute

String getRoleNameAttribute()

Get the role name when performing a lookup on a role

Returns:

role name when performing a lookup on a role

getBaseDN

String getBaseDN()

Get the DN used for the lookup of this LDAP realm

Returns:

baseDN DN used for the lookup

getUserDN

String getUserDN()

Get the DN used when searching the user DN. Override the baseDN if it is defined

Returns:

userDN DN used when searching the user DN

getUserSearchFilter

String getUserSearchFilter()

Get the filter used when searching the user

Returns:

userSearchFilter filter used when searching the user

getRoleDN

String getRoleDN()

Get the DN used when searching the role DN. Override the baseDN if it is defined

Returns:

roleDN DN used when searching the role DN. Override the baseDN if it is defined

getRoleSearchFilter

String getRoleSearchFilter()

Get the filter used when searching the role

Returns:

roleSearchFilter filter used when searching the role

getAlgorithm

String getAlgorithm()

Get the default algorithm

Returns:

the default algorithm

setInitialContextFactory

void setInitialContextFactory(String initialContextFactory)

Set the initial context factory of this LDAP realm

Parameters:

initialContextFactory - the initial context factory

setProviderUrl

void setProviderUrl(String providerUrl)

Set the Url of the ldap server of this LDAP realm

Parameters:

providerUrl - Url of the ldap server

setSecurityAuthentication

void setSecurityAuthentication(String securityAuthentication)

Set the authentication used during the authentication to the LDAP server of this LDAP realm

Parameters:

securityAuthentication - authentication used during the authentication to the LDAP server

setSecurityPrincipal

void setSecurityPrincipal(String securityPrincipal)

Set the DN of the Principal(username) of this LDAP realm

Parameters:

securityPrincipal - DN of the Principal(username)

setSecurityCredentials

void setSecurityCredentials(String securityCredentials)

Set the Credential(password) of the principal of this LDAP realm

Parameters:

securityCredentials - Credential(password) of the principal

setSecurityProtocol

void setSecurityProtocol(String securityProtocol)

Set the security protocol to use of this LDAP realm

Parameters:

securityProtocol - security protocol to use

setLanguage

void setLanguage(String language)

Set the preferred language to use with the service of this LDAP realm

Parameters:

language - preferred language to use with the service

setReferral

void setReferral(String referral)

Set how referrals encountered by the service provider are to be processed

Parameters:

referral - how referrals encountered by the service provider are to be processed

setStateFactories

void setStateFactories(String stateFactories)

Set the the list of state factories of this LDAP realm

Parameters:

stateFactories - list of state factories

setAuthenticationMode

void setAuthenticationMode(String authenticationMode)

Set the mode for validate the authentication of this LDAP realm

Parameters:

authenticationMode - BIND_AUTHENTICATION_MODE or COMPARE_AUTHENTICATION_MODE

setUserPasswordAttribute

void setUserPasswordAttribute(String userPasswordAttribute)

Set the attribute in order to get the password of this LDAP realm

Parameters:

userPasswordAttribute - attribute in order to get the password of this LDAP realm

setUserRolesAttribute

void setUserRolesAttribute(String userRolesAttribute)

Set the attribute in order to get the user role from the ldap server

Parameters:

userRolesAttribute - attribute in order to get the user role from the ldap server

setRoleNameAttribute

void setRoleNameAttribute(String roleNameAttribute)

Set the role name when performing a lookup on a role

Parameters:

roleNameAttribute - role name when performing a lookup on a role

setBaseDN

void setBaseDN(String baseDN)

Set the DN used for the lookup of this LDAP realm

Parameters:

baseDN - DN used for the lookup

setUserDN

void setUserDN(String userDN)

Set the DN used when searching the user DN. Override the baseDN if it is defined

Parameters:

userDN - DN used when searching the user DN

setUserSearchFilter

void setUserSearchFilter(String userSearchFilter)

Set the filter used when searching the user

Parameters:

userSearchFilter - filter used when searching the user

setRoleDN

void setRoleDN(String roleDN)

Set the DN used when searching the role DN. Override the baseDN if it is defined

Parameters:

roleDN - DN used when searching the role DN. Override the baseDN if it is defined

setRoleSearchFilter

void setRoleSearchFilter(String roleSearchFilter)

Set the filter used when searching the role

Parameters:

roleSearchFilter - filter used when searching the role

setAlgorithm

void setAlgorithm(String algorithm)

Set the default algorithm to use

Parameters:

algorithm - algorithm to be used