LDAP-263: Minor javadoc polishing.

This commit is contained in:
Mattias Hellborg Arthursson
2013-09-25 12:40:45 +02:00
parent 4f8f3bfd41
commit 5b388cb5c6
4 changed files with 20 additions and 10 deletions

View File

@@ -1527,6 +1527,7 @@ public interface LdapOperations {
* @throws NamingException if something went wrong in authentication.
*
* @since 2.0
* @see org.springframework.ldap.query.LdapQueryBuilder
*/
<T> T authenticate(LdapQuery query, String password, AuthenticatedLdapEntryContextMapper<T> mapper);
@@ -1551,6 +1552,7 @@ public interface LdapOperations {
* @throws NamingException if something went wrong in authentication.
*
* @since 2.0
* @see org.springframework.ldap.query.LdapQueryBuilder
*/
void authenticate(LdapQuery query, String password);
@@ -1628,12 +1630,14 @@ public interface LdapOperations {
*
* @throws NamingException if any error occurs.
* @since 2.0
* @see org.springframework.ldap.query.LdapQueryBuilder
*/
<T> List<T> search(LdapQuery query, ContextMapper<T> mapper);
/**
* Perform a search with parameters from the specified LdapQuery. The Attributes of the found entrieswill be supplied to the
* <code>AttributesMapper</code> for processing, and all returned objects will be collected in a list to be returned.
* Perform a search with parameters from the specified LdapQuery. The Attributes of the found entries will be
* supplied to the <code>AttributesMapper</code> for processing, and all
* returned objects will be collected in a list to be returned.
*
* @param query the LDAP query specification.
* @param mapper the <code>Attributes</code> to supply all found Attributes to.
@@ -1642,6 +1646,7 @@ public interface LdapOperations {
*
* @throws NamingException if any error occurs.
* @since 2.0
* @see org.springframework.ldap.query.LdapQueryBuilder
*/
<T> List<T> search(LdapQuery query, AttributesMapper<T> mapper);
@@ -1650,10 +1655,11 @@ public interface LdapOperations {
* query and return the found entry as a DirContextOperation instance. If no entry is found or if there
* are more than one matching entry, an
* {@link IncorrectResultSizeDataAccessException} is thrown.
* @param query the DN to use as the base of the search.
* @param query the LDAP query specification.
* @return the single entry matching the query as a DirContextOperations instance.
* @throws IncorrectResultSizeDataAccessException if the result is not one unique entry
* @since 2.0
* @see org.springframework.ldap.query.LdapQueryBuilder
*/
DirContextOperations searchForContext(LdapQuery query);
@@ -1667,6 +1673,7 @@ public interface LdapOperations {
* criteria.
* @throws IncorrectResultSizeDataAccessException if the result is not one unique entry
* @since 2.0
* @see org.springframework.ldap.query.LdapQueryBuilder
*/
<T> T searchForObject(LdapQuery query, ContextMapper<T> mapper);
}

View File

@@ -45,6 +45,7 @@ import java.text.MessageFormat;
* defaults will be used. Filter conditions must always be specified.
* </p>
* @author Mattias Hellborg Arthursson
* @since 2.0
*
* @see javax.naming.directory.SearchControls
* @see org.springframework.ldap.core.LdapOperations#search(LdapQuery, org.springframework.ldap.core.AttributesMapper)

View File

@@ -22,6 +22,7 @@ import javax.naming.directory.SearchControls;
* Type safe definitions of search scopes.
*
* @author Mattias Hellborg Arthursson
* @since 2.0
*/
public enum SearchScope {
/**

View File

@@ -48,7 +48,7 @@ public interface OdmManager {
* @param dn The distinguished name of the entry to read from the LDAP directory.
* @return The entry as read from the directory
*
* @exception org.springframework.ldap.NamingException on error.
* @throws org.springframework.ldap.NamingException on error.
*/
<T> T read(Class<T> clazz, Name dn);
@@ -57,7 +57,7 @@ public interface OdmManager {
*
* @param entry The entry to be create, it must <em>not</em> already exist in the directory.
*
* @exception org.springframework.ldap.NamingException on error.
* @throws org.springframework.ldap.NamingException on error.
*/
void create(Object entry);
@@ -66,7 +66,7 @@ public interface OdmManager {
*
* @param entry The entry to update, it must already exist in the directory.
*
* @exception org.springframework.ldap.NamingException on error.
* @throws org.springframework.ldap.NamingException on error.
*/
void update(Object entry);
@@ -75,7 +75,7 @@ public interface OdmManager {
*
* @param entry The entry to delete, it must already exist in the directory.
*
* @exception org.springframework.ldap.NamingException on error.
* @throws org.springframework.ldap.NamingException on error.
*/
void delete(Object entry);
@@ -89,7 +89,7 @@ public interface OdmManager {
* @return All entries that are of the type represented by the given
* Java class
*
* @exception org.springframework.ldap.NamingException on error.
* @throws org.springframework.ldap.NamingException on error.
*/
<T> List<T> findAll(Class<T> clazz, Name base, SearchControls searchControls);
@@ -106,7 +106,7 @@ public interface OdmManager {
* @param searchControls The scope of the search.
* @return All matching entries.
*
* @exception org.springframework.ldap.NamingException on error.
* @throws org.springframework.ldap.NamingException on error.
*
* @see <a href="http://java.sun.com/products/jndi/tutorial/basics/directory/filter.html">Sun's JNDI tutorial description of search filters.</a>
* @see <a href="http://www.rfc-editor.org/rfc/rfc4515.txt">LDAP: String Representation of Search Filters RFC.</a>
@@ -124,7 +124,8 @@ public interface OdmManager {
* @param query the LDAP query specification
* @return All matching entries.
*
* @exception org.springframework.ldap.NamingException on error.
* @throws org.springframework.ldap.NamingException on error.
* @see org.springframework.ldap.query.LdapQueryBuilder
*/
<T> List<T> search(Class<T> clazz, LdapQuery query);
}