Package com.javahollic.jira.emh.api.integration

Interface ITLDAPManager

public interface ITLDAPManager

Method Summary

Modifier and Type	Method	Description
void	deleteAllLdapConfigs()
void	deleteConfig(int id)
void	flushLDAPGroupCache()
LdapItemBean	installConfig(InputStream is)
Map<String,Map<String,List<Object>>>	query(int ldapConfigId, String ldapFilter, String[] requiredReturnAtts)	Query method exposing LDAP query and filter logic to integration testing
IJEMHCachedLDAPDistGroupMembers	queryDistListAddress(int ldapConfigID, String groupAddress)
Set<com.atlassian.jira.user.ApplicationUser>	queryDistListMembership(int ldapConfigId, String[] distListAddresses, String[] requiredReturnAtts, String[] expandAttributes, int maxResults)
LDAPQueryResultList	queryGroupMembership(int ldapConfigId, String ldapFilter, String[] requiredReturnAtts, String[] expandAttributes, long maxResults)
void	updateConfig(LdapItemBean ldapBean)
Map<String,String>	validateLdapConfigurationValid(LdapDetailsDTO dto, String additionalParams)

Method Detail

installConfig

LdapItemBean installConfig(InputStream is)
                    throws RemoteException

Parameters:

is - stream to the resource

Returns:

bean representing the configuration

Throws:

RemoteException - if it breaks

deleteConfig

void deleteConfig(int id)

deleteAllLdapConfigs

void deleteAllLdapConfigs()

validateLdapConfigurationValid

Map<String,String> validateLdapConfigurationValid(LdapDetailsDTO dto,
                                                        String additionalParams)

updateConfig

void updateConfig(LdapItemBean ldapBean)
           throws Exception

Throws:

Exception

query

Map<String,Map<String,List<Object>>> query(int ldapConfigId,
                                                       String ldapFilter,
                                                       String[] requiredReturnAtts)
                                                throws RemoteException

Query method exposing LDAP query and filter logic to integration testing

Parameters:

ldapConfigId - The ldap config entity ID

ldapFilter - The ldap filter to use

requiredReturnAtts - the ldap attributes to return

Returns:

lots of things

Throws:

RemoteException - if it breaks

queryDistListMembership

Set<com.atlassian.jira.user.ApplicationUser> queryDistListMembership(int ldapConfigId,
                                                                     String[] distListAddresses,
                                                                     String[] requiredReturnAtts,
                                                                     String[] expandAttributes,
                                                                     int maxResults)
                                                              throws RemoteException

Parameters:

ldapConfigId - the ldap config ID

distListAddresses - the array of dist list addresses to query

requiredReturnAtts - the ldap attributes to return

expandAttributes - the attributes to expand on, with AD, this will be 'member'

maxResults - how many results to return at maximum

Returns:

set of JIRA users found in the dist list

Throws:

RemoteException - if it breaks

queryGroupMembership

LDAPQueryResultList queryGroupMembership(int ldapConfigId,
                                         String ldapFilter,
                                         String[] requiredReturnAtts,
                                         String[] expandAttributes,
                                         long maxResults)
                                  throws RemoteException

Throws:

RemoteException

queryDistListAddress

IJEMHCachedLDAPDistGroupMembers queryDistListAddress(int ldapConfigID,
                                                     String groupAddress)

flushLDAPGroupCache

void flushLDAPGroupCache()