diff --git a/build.gradle b/build.gradle index 6eac48a3..c30b16c6 100644 --- a/build.gradle +++ b/build.gradle @@ -60,7 +60,7 @@ configurations.archives.artifacts.clear() sonarRunner { sonarProperties { - property "sonar.exclusions", "**/generated-src/**;**/itest/**" + property "sonar.exclusions", "file:**/generated-src/**" property "sonar.java.coveragePlugin", "jacoco" property "sonar.jacoco.reportPath", "${buildDir.name}/jacoco.exec" property "sonar.links.homepage", 'https://github.com/SpringSource/spring-ldap' diff --git a/core-tiger/src/main/java/org/springframework/ldap/core/simple/SimpleLdapTemplate.java b/core-tiger/src/main/java/org/springframework/ldap/core/simple/SimpleLdapTemplate.java index bf19e22c..1fc31cff 100644 --- a/core-tiger/src/main/java/org/springframework/ldap/core/simple/SimpleLdapTemplate.java +++ b/core-tiger/src/main/java/org/springframework/ldap/core/simple/SimpleLdapTemplate.java @@ -60,230 +60,164 @@ public class SimpleLdapTemplate implements SimpleLdapOperations { this.ldapOperations = new LdapTemplate(contextSource); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#getLdapOperations - * () - */ + /** + * {@inheritDoc} + */ + @Override public LdapOperations getLdapOperations() { return ldapOperations; } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#lookup(java - * .lang.String, - * org.springframework.ldap.core.simple.ParametrizedContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override @SuppressWarnings("unchecked") public T lookup(String dn, ParameterizedContextMapper mapper) { return (T) ldapOperations.lookup(dn, mapper); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#search(java - * .lang.String, java.lang.String, - * org.springframework.ldap.core.simple.ParametrizedContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override @SuppressWarnings("unchecked") public List search(String base, String filter, ParameterizedContextMapper mapper) { return ldapOperations.search(base, filter, mapper); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#search(java - * .lang.String, java.lang.String, javax.naming.directory.SearchControls, - * org.springframework.ldap.core.simple.ParametrizedContextMapper, - * org.springframework.ldap.core.DirContextProcessor) - */ + /** + * {@inheritDoc} + */ + @Override @SuppressWarnings("unchecked") public List search(String base, String filter, SearchControls controls, ParameterizedContextMapper mapper, DirContextProcessor processor) { return ldapOperations.search(base, filter, controls, mapper, processor); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#lookup(java - * .lang.String) - */ + /** + * {@inheritDoc} + */ + @Override public DirContextOperations lookupContext(String dn) { return ldapOperations.lookupContext(dn); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#modifyAttributes - * (org.springframework.ldap.core.DirContextOperations) - */ + /** + * {@inheritDoc} + */ + @Override public void modifyAttributes(DirContextOperations ctx) { ldapOperations.modifyAttributes(ctx); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#bind(java.lang - * .String, java.lang.Object, javax.naming.directory.Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public void bind(String dn, Object obj, Attributes attributes) { ldapOperations.bind(dn, obj, attributes); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#unbind(java - * .lang.String) - */ + /** + * {@inheritDoc} + */ + @Override public void unbind(String dn) { ldapOperations.unbind(dn); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#bind(javax. - * naming.Name, java.lang.Object, javax.naming.directory.Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public void bind(Name dn, Object obj, Attributes attributes) { ldapOperations.bind(dn, obj, attributes); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#lookup(javax - * .naming.Name, - * org.springframework.ldap.core.simple.ParameterizedContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override @SuppressWarnings("unchecked") public T lookup(Name dn, ParameterizedContextMapper mapper) { return (T) ldapOperations.lookup(dn, mapper); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#lookupContext - * (javax.naming.Name) - */ + /** + * {@inheritDoc} + */ + @Override public DirContextOperations lookupContext(Name dn) { return ldapOperations.lookupContext(dn); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#search(javax - * .naming.Name, java.lang.String, - * org.springframework.ldap.core.simple.ParameterizedContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override @SuppressWarnings("unchecked") public List search(Name base, String filter, ParameterizedContextMapper mapper) { return ldapOperations.search(base, filter, mapper); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#search(javax - * .naming.Name, java.lang.String, javax.naming.directory.SearchControls, - * org.springframework.ldap.core.simple.ParameterizedContextMapper, - * org.springframework.ldap.core.DirContextProcessor) - */ + /** + * {@inheritDoc} + */ + @Override @SuppressWarnings("unchecked") public List search(Name base, String filter, SearchControls controls, ParameterizedContextMapper mapper, DirContextProcessor processor) { return ldapOperations.search(base, filter, controls, mapper, processor); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#unbind(javax - * .naming.Name) - */ + /** + * {@inheritDoc} + */ + @Override public void unbind(Name dn) { ldapOperations.unbind(dn); } - /* - * (non-Javadoc) - * - * @seeorg.springframework.ldap.core.simple.SimpleLdapOperations#bind(org. - * springframework.ldap.core.DirContextOperations) - */ + /** + * {@inheritDoc} + */ + @Override public void bind(DirContextOperations ctx) { ldapOperations.bind(ctx); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#searchForObject - * (java.lang.String, java.lang.String, - * org.springframework.ldap.core.simple.ParameterizedContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override @SuppressWarnings("unchecked") public T searchForObject(String base, String filter, ParameterizedContextMapper mapper) { return (T) ldapOperations.searchForObject(base, filter, mapper); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#searchForObject - * (javax.naming.Name, java.lang.String, - * org.springframework.ldap.core.simple.ParameterizedContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override @SuppressWarnings("unchecked") public T searchForObject(Name base, String filter, ParameterizedContextMapper mapper) { return (T) ldapOperations.searchForObject(base, filter, mapper); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#authenticate - * (java.lang.String, java.lang.String, java.lang.String) - */ + /** + * {@inheritDoc} + */ + @Override public boolean authenticate(String base, String filter, String password) { return ldapOperations.authenticate(base, filter, password); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.simple.SimpleLdapOperations#authenticate - * (javax.naming.Name, java.lang.String, java.lang.String) - */ + /** + * {@inheritDoc} + */ + @Override public boolean authenticate(Name base, String filter, String password) { return ldapOperations.authenticate(base, filter, password); } diff --git a/core/src/main/java/org/springframework/ldap/core/DirContextAdapter.java b/core/src/main/java/org/springframework/ldap/core/DirContextAdapter.java index 2849e0e3..0c70c4bb 100644 --- a/core/src/main/java/org/springframework/ldap/core/DirContextAdapter.java +++ b/core/src/main/java/org/springframework/ldap/core/DirContextAdapter.java @@ -229,10 +229,18 @@ public class DirContextAdapter implements DirContextOperations { } } + /** + * {@inheritDoc} + */ + @Override public boolean isUpdateMode() { return updateMode; } + /** + * {@inheritDoc} + */ + @Override public String[] getNamesOfModifiedAttributes() { List tmpList = new ArrayList(); @@ -273,6 +281,10 @@ public class DirContextAdapter implements DirContextOperations { } } + /** + * {@inheritDoc} + */ + @Override public ModificationItem[] getModificationItems() { if (!updateMode) { return new ModificationItem[0]; @@ -566,10 +578,18 @@ public class DirContextAdapter implements DirContextOperations { return originalAttrs.get(attrId) != null; } + /** + * {@inheritDoc} + */ + @Override public String getStringAttribute(String name) { return (String) getObjectAttribute(name); } + /** + * {@inheritDoc} + */ + @Override public Object getObjectAttribute(String name) { Attribute oneAttr = originalAttrs.get(name); if (oneAttr == null || oneAttr.size() == 0) { // LDAP-215 @@ -583,12 +603,20 @@ public class DirContextAdapter implements DirContextOperations { } } + /** + * {@inheritDoc} + */ + @Override // LDAP-215 public boolean attributeExists(String name) { Attribute oneAttr = originalAttrs.get(name); return oneAttr != null; } - + + /** + * {@inheritDoc} + */ + @Override public void setAttributeValue(String name, Object value) { // new entry if (!updateMode && value != null) { @@ -605,10 +633,18 @@ public class DirContextAdapter implements DirContextOperations { } } + /** + * {@inheritDoc} + */ + @Override public void addAttributeValue(String name, Object value) { addAttributeValue(name, value, DONT_ADD_IF_DUPLICATE_EXISTS); } + /** + * {@inheritDoc} + */ + @Override public void addAttributeValue(String name, Object value, boolean addIfDuplicateExists) { if (!updateMode && value != null) { @@ -644,6 +680,10 @@ public class DirContextAdapter implements DirContextOperations { } } + /** + * {@inheritDoc} + */ + @Override public void removeAttributeValue(String name, Object value) { if (!updateMode && value != null) { Attribute attr = originalAttrs.get(name); @@ -669,10 +709,18 @@ public class DirContextAdapter implements DirContextOperations { } } + /** + * {@inheritDoc} + */ + @Override public void setAttributeValues(String name, Object[] values) { setAttributeValues(name, values, ORDER_DOESNT_MATTER); } + /** + * {@inheritDoc} + */ + @Override public void setAttributeValues(String name, Object[] values, boolean orderMatters) { Attribute a = new NameAwareAttribute(name, orderMatters); @@ -693,6 +741,10 @@ public class DirContextAdapter implements DirContextOperations { } } + /** + * {@inheritDoc} + */ + @Override public void update() { NamingEnumeration attributesEnumeration = null; @@ -724,6 +776,10 @@ public class DirContextAdapter implements DirContextOperations { updatedAttrs = new NameAwareAttributes(); } + /** + * {@inheritDoc} + */ + @Override public String[] getStringAttributes(String name) { try { List objects = collectAttributeValuesAsList(name, String.class); @@ -735,6 +791,10 @@ public class DirContextAdapter implements DirContextOperations { } } + /** + * {@inheritDoc} + */ + @Override public Object[] getObjectAttributes(String name) { try { List list = collectAttributeValuesAsList(name, Object.class); @@ -752,6 +812,9 @@ public class DirContextAdapter implements DirContextOperations { return list; } + /** + * {@inheritDoc} + */ @Override public SortedSet getAttributeSortedStringSet(String name) { try { @@ -788,16 +851,18 @@ public class DirContextAdapter implements DirContextOperations { return originalAttrs; } - /** - * @see javax.naming.directory.DirContext#getAttributes(Name) - */ + /** + * {@inheritDoc} + */ + @Override public Attributes getAttributes(Name name) throws NamingException { return getAttributes(name.toString()); } - /** - * @see javax.naming.directory.DirContext#getAttributes(String) - */ + /** + * {@inheritDoc} + */ + @Override public Attributes getAttributes(String name) throws NamingException { if (StringUtils.hasLength(name)) { throw new NameNotFoundException(); @@ -805,17 +870,19 @@ public class DirContextAdapter implements DirContextOperations { return (Attributes) originalAttrs.clone(); } - /** - * @see javax.naming.directory.DirContext#getAttributes(Name, String[]) - */ + /** + * {@inheritDoc} + */ + @Override public Attributes getAttributes(Name name, String[] attrIds) throws NamingException { return getAttributes(name.toString(), attrIds); } - /** - * @see javax.naming.directory.DirContext#getAttributes(String, String[]) - */ + /** + * {@inheritDoc} + */ + @Override public Attributes getAttributes(String name, String[] attrIds) throws NamingException { if (StringUtils.hasLength(name)) { @@ -834,391 +901,432 @@ public class DirContextAdapter implements DirContextOperations { return a; } - /** - * @see javax.naming.directory.DirContext#modifyAttributes(javax.naming.Name, - * int, javax.naming.directory.Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public void modifyAttributes(Name name, int modOp, Attributes attrs) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#modifyAttributes(String, int, - * Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public void modifyAttributes(String name, int modOp, Attributes attrs) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#modifyAttributes(Name, - * ModificationItem[]) - */ + /** + * {@inheritDoc} + */ + @Override public void modifyAttributes(Name name, ModificationItem[] mods) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#modifyAttributes(String, - * ModificationItem[]) - */ + /** + * {@inheritDoc} + */ + @Override public void modifyAttributes(String name, ModificationItem[] mods) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#bind(Name, Object, Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public void bind(Name name, Object obj, Attributes attrs) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#bind(String, Object, Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public void bind(String name, Object obj, Attributes attrs) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#rebind(Name, Object, Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public void rebind(Name name, Object obj, Attributes attrs) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#rebind(String, Object, Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public void rebind(String name, Object obj, Attributes attrs) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#createSubcontext(Name, Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public DirContext createSubcontext(Name name, Attributes attrs) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#createSubcontext(String, - * Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public DirContext createSubcontext(String name, Attributes attrs) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#getSchema(Name) - */ + /** + * {@inheritDoc} + */ + @Override public DirContext getSchema(Name name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#getSchema(String) - */ + /** + * {@inheritDoc} + */ + @Override public DirContext getSchema(String name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#getSchemaClassDefinition(Name) - */ + /** + * {@inheritDoc} + */ + @Override public DirContext getSchemaClassDefinition(Name name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#getSchemaClassDefinition(String) - */ + /** + * {@inheritDoc} + */ + @Override public DirContext getSchemaClassDefinition(String name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#search(Name, Attributes, String[]) - */ + /** + * {@inheritDoc} + */ + @Override public NamingEnumeration search(Name name, Attributes matchingAttributes, String[] attributesToReturn) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#search(String, Attributes, - * String[]) - */ + /** + * {@inheritDoc} + */ + @Override public NamingEnumeration search(String name, Attributes matchingAttributes, String[] attributesToReturn) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#search(Name, Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public NamingEnumeration search(Name name, Attributes matchingAttributes) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#search(String, Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public NamingEnumeration search(String name, Attributes matchingAttributes) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#search(Name, String, - * SearchControls) - */ + /** + * {@inheritDoc} + */ + @Override public NamingEnumeration search(Name name, String filter, SearchControls cons) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#search(String, String, - * SearchControls) - */ + /** + * {@inheritDoc} + */ + @Override public NamingEnumeration search(String name, String filter, SearchControls cons) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#search(Name, String, Object[], - * SearchControls) - */ + /** + * {@inheritDoc} + */ + @Override public NamingEnumeration search(Name name, String filterExpr, Object[] filterArgs, SearchControls cons) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.directory.DirContext#search(String, String, Object[], - * SearchControls) - */ + /** + * {@inheritDoc} + */ + @Override public NamingEnumeration search(String name, String filterExpr, Object[] filterArgs, SearchControls cons) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#lookup(Name) - */ + /** + * {@inheritDoc} + */ + @Override public Object lookup(Name name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#lookup(String) - */ + /** + * {@inheritDoc} + */ + @Override public Object lookup(String name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#bind(Name, Object) - */ + /** + * {@inheritDoc} + */ + @Override public void bind(Name name, Object obj) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#bind(String, Object) - */ + /** + * {@inheritDoc} + */ + @Override public void bind(String name, Object obj) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#rebind(Name, Object) - */ + /** + * {@inheritDoc} + */ + @Override public void rebind(Name name, Object obj) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#rebind(String, Object) - */ + /** + * {@inheritDoc} + */ + @Override public void rebind(String name, Object obj) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#unbind(Name) - */ + /** + * {@inheritDoc} + */ + @Override public void unbind(Name name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#unbind(String) - */ + /** + * {@inheritDoc} + */ + @Override public void unbind(String name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#rename(Name, Name) - */ + /** + * {@inheritDoc} + */ + @Override public void rename(Name oldName, Name newName) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#rename(String, String) - */ + /** + * {@inheritDoc} + */ + @Override public void rename(String oldName, String newName) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#list(Name) - */ + /** + * {@inheritDoc} + */ + @Override public NamingEnumeration list(Name name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#list(String) - */ + /** + * {@inheritDoc} + */ + @Override public NamingEnumeration list(String name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#listBindings(Name) - */ + /** + * {@inheritDoc} + */ + @Override public NamingEnumeration listBindings(Name name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#listBindings(String) - */ + /** + * {@inheritDoc} + */ + @Override public NamingEnumeration listBindings(String name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#destroySubcontext(Name) - */ + /** + * {@inheritDoc} + */ + @Override public void destroySubcontext(Name name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#destroySubcontext(String) - */ + /** + * {@inheritDoc} + */ + @Override public void destroySubcontext(String name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#createSubcontext(Name) - */ + /** + * {@inheritDoc} + */ + @Override public Context createSubcontext(Name name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#createSubcontext(String) - */ + /** + * {@inheritDoc} + */ + @Override public Context createSubcontext(String name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#lookupLink(Name) - */ + /** + * {@inheritDoc} + */ + @Override public Object lookupLink(Name name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#lookupLink(String) - */ + /** + * {@inheritDoc} + */ + @Override public Object lookupLink(String name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#getNameParser(Name) - */ + /** + * {@inheritDoc} + */ + @Override public NameParser getNameParser(Name name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#getNameParser(String) - */ + /** + * {@inheritDoc} + */ + @Override public NameParser getNameParser(String name) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#composeName(Name, Name) - */ + /** + * {@inheritDoc} + */ + @Override public Name composeName(Name name, Name prefix) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#composeName(String, String) - */ + /** + * {@inheritDoc} + */ + @Override public String composeName(String name, String prefix) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#addToEnvironment(String, Object) - */ + /** + * {@inheritDoc} + */ + @Override public Object addToEnvironment(String propName, Object propVal) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#removeFromEnvironment(String) - */ + /** + * {@inheritDoc} + */ + @Override public Object removeFromEnvironment(String propName) throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#getEnvironment() - */ + /** + * {@inheritDoc} + */ + @Override public Hashtable getEnvironment() throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#close() - */ + /** + * {@inheritDoc} + */ + @Override public void close() throws NamingException { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /** - * @see javax.naming.Context#getNameInNamespace() - */ + /** + * {@inheritDoc} + */ + @Override public String getNameInNamespace() { if(base.size() == 0) { return dn.toString(); @@ -1233,22 +1341,18 @@ public class DirContextAdapter implements DirContextOperations { } } - /* - * (non-Javadoc) - * - * @see org.springframework.ldap.support.DirContextOperations#getDn() - */ + /** + * {@inheritDoc} + */ + @Override public Name getDn() { return LdapUtils.newLdapName(dn); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.support.DirContextOperations#setDn(javax.naming - * .Name) - */ + /** + * {@inheritDoc} + */ + @Override public final void setDn(Name dn) { if (!updateMode) { this.dn = LdapUtils.newLdapName(dn); @@ -1260,6 +1364,9 @@ public class DirContextAdapter implements DirContextOperations { } + /** + * {@inheritDoc} + */ @Override public boolean equals(Object o) { if (this == o) return true; @@ -1278,6 +1385,9 @@ public class DirContextAdapter implements DirContextOperations { return true; } + /** + * {@inheritDoc} + */ @Override public int hashCode() { int result = originalAttrs != null ? originalAttrs.hashCode() : 0; @@ -1290,8 +1400,9 @@ public class DirContextAdapter implements DirContextOperations { } /** - * @see java.lang.Object#toString() - */ + * {@inheritDoc} + */ + @Override public String toString() { StringBuilder builder = new StringBuilder(); builder.append(getClass().getName()); @@ -1335,20 +1446,18 @@ public class DirContextAdapter implements DirContextOperations { return builder.toString(); } - /* - * (non-Javadoc) - * - * @see org.springframework.ldap.core.DirContextOperations#getReferralUrl() - */ + /** + * {@inheritDoc} + */ + @Override public String getReferralUrl() { return referralUrl; } - /* - * (non-Javadoc) - * - * @see org.springframework.ldap.core.DirContextOperations#isReferral() - */ + /** + * {@inheritDoc} + */ + @Override public boolean isReferral() { return StringUtils.hasLength(referralUrl); } diff --git a/core/src/main/java/org/springframework/ldap/core/LdapTemplate.java b/core/src/main/java/org/springframework/ldap/core/LdapTemplate.java index 6338b146..dae224b6 100644 --- a/core/src/main/java/org/springframework/ldap/core/LdapTemplate.java +++ b/core/src/main/java/org/springframework/ldap/core/LdapTemplate.java @@ -117,6 +117,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { this.contextSource = contextSource; } + /** + * {@inheritDoc} + */ @Override public ObjectDirectoryMapper getObjectDirectoryMapper() { return odm; @@ -229,36 +232,30 @@ public class LdapTemplate implements LdapOperations, InitializingBean { this.defaultCountLimit = defaultCountLimit; } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, int, boolean, - * org.springframework.ldap.core.NameClassPairCallbackHandler) - */ + /** + * {@inheritDoc} + */ + @Override public void search(Name base, String filter, int searchScope, boolean returningObjFlag, NameClassPairCallbackHandler handler) { search(base, filter, getDefaultSearchControls(searchScope, returningObjFlag, ALL_ATTRIBUTES), handler); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, int, boolean, - * org.springframework.ldap.core.NameClassPairCallbackHandler) - */ + /** + * {@inheritDoc} + */ + @Override public void search(String base, String filter, int searchScope, boolean returningObjFlag, NameClassPairCallbackHandler handler) { search(base, filter, getDefaultSearchControls(searchScope, returningObjFlag, ALL_ATTRIBUTES), handler); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, javax.naming.directory.SearchControls, - * org.springframework.ldap.core.NameClassPairCallbackHandler) - */ + /** + * {@inheritDoc} + */ + @Override public void search(final Name base, final String filter, final SearchControls controls, NameClassPairCallbackHandler handler) { @@ -274,12 +271,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { search(se, handler); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, javax.naming.directory.SearchControls, - * org.springframework.ldap.core.NameClassPairCallbackHandler) - */ + /** + * {@inheritDoc} + */ + @Override public void search(final String base, final String filter, final SearchControls controls, NameClassPairCallbackHandler handler) { @@ -295,13 +290,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { search(se, handler); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, javax.naming.directory.SearchControls, - * org.springframework.ldap.core.NameClassPairCallbackHandler, - * org.springframework.ldap.core.DirContextProcessor) - */ + /** + * {@inheritDoc} + */ + @Override public void search(final Name base, final String filter, final SearchControls controls, NameClassPairCallbackHandler handler, DirContextProcessor processor) { @@ -317,13 +309,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { search(se, handler, processor); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, javax.naming.directory.SearchControls, - * org.springframework.ldap.core.NameClassPairCallbackHandler, - * org.springframework.ldap.core.DirContextProcessor) - */ + /** + * {@inheritDoc} + */ + @Override public void search(final String base, final String filter, final SearchControls controls, NameClassPairCallbackHandler handler, DirContextProcessor processor) { @@ -363,6 +352,7 @@ public class LdapTemplate implements LdapOperations, InitializingBean { * NameNotFoundException will be ignored. Instead this is interpreted that * no entries were found. */ + @Override public void search(SearchExecutor se, NameClassPairCallbackHandler handler, DirContextProcessor processor) { DirContext ctx = contextSource.getReadOnlyContext(); @@ -445,16 +435,15 @@ public class LdapTemplate implements LdapOperations, InitializingBean { * NameNotFoundException will be ignored. Instead this is interpreted that * no entries were found. */ + @Override public void search(SearchExecutor se, NameClassPairCallbackHandler handler) { search(se, handler, new NullDirContextProcessor()); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, - * org.springframework.ldap.core.NameClassPairCallbackHandler) - */ + /** + * {@inheritDoc} + */ + @Override public void search(Name base, String filter, NameClassPairCallbackHandler handler) { SearchControls controls = getDefaultSearchControls(defaultSearchScope, DONT_RETURN_OBJ_FLAG, ALL_ATTRIBUTES); @@ -464,12 +453,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { search(base, filter, controls, handler); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, - * org.springframework.ldap.core.NameClassPairCallbackHandler) - */ + /** + * {@inheritDoc} + */ + @Override public void search(String base, String filter, NameClassPairCallbackHandler handler) { SearchControls controls = getDefaultSearchControls(defaultSearchScope, DONT_RETURN_OBJ_FLAG, ALL_ATTRIBUTES); @@ -479,180 +466,138 @@ public class LdapTemplate implements LdapOperations, InitializingBean { search(base, filter, controls, handler); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, int, java.lang.String[], - * org.springframework.ldap.core.AttributesMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(Name base, String filter, int searchScope, String[] attrs, AttributesMapper mapper) { return search(base, filter, getDefaultSearchControls(searchScope, DONT_RETURN_OBJ_FLAG, attrs), mapper); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, int, java.lang.String[], - * org.springframework.ldap.core.AttributesMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(String base, String filter, int searchScope, String[] attrs, AttributesMapper mapper) { return search(base, filter, getDefaultSearchControls(searchScope, DONT_RETURN_OBJ_FLAG, attrs), mapper); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, int, org.springframework.ldap.core.AttributesMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(Name base, String filter, int searchScope, AttributesMapper mapper) { - return search(base, filter, searchScope, ALL_ATTRIBUTES, mapper); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, int, org.springframework.ldap.core.AttributesMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(String base, String filter, int searchScope, AttributesMapper mapper) { - return search(base, filter, searchScope, ALL_ATTRIBUTES, mapper); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, org.springframework.ldap.core.AttributesMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(Name base, String filter, AttributesMapper mapper) { - return search(base, filter, defaultSearchScope, mapper); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, org.springframework.ldap.core.AttributesMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(String base, String filter, AttributesMapper mapper) { - return search(base, filter, defaultSearchScope, mapper); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, int, java.lang.String[], - * org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(Name base, String filter, int searchScope, String[] attrs, ContextMapper mapper) { - return search(base, filter, getDefaultSearchControls(searchScope, RETURN_OBJ_FLAG, attrs), mapper); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, int, java.lang.String[], - * org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(String base, String filter, int searchScope, String[] attrs, ContextMapper mapper) { - return search(base, filter, getDefaultSearchControls(searchScope, RETURN_OBJ_FLAG, attrs), mapper); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, int, org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(Name base, String filter, int searchScope, ContextMapper mapper) { - return search(base, filter, searchScope, ALL_ATTRIBUTES, mapper); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, int, org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(String base, String filter, int searchScope, ContextMapper mapper) { - return search(base, filter, searchScope, ALL_ATTRIBUTES, mapper); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(Name base, String filter, ContextMapper mapper) { - return search(base, filter, defaultSearchScope, mapper); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(String base, String filter, ContextMapper mapper) { - return search(base, filter, defaultSearchScope, mapper); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, javax.naming.directory.SearchControls, - * org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(String base, String filter, SearchControls controls, ContextMapper mapper) { - return search(base, filter, controls, mapper, new NullDirContextProcessor()); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, javax.naming.directory.SearchControls, - * org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(Name base, String filter, SearchControls controls, ContextMapper mapper) { - return search(base, filter, controls, mapper, new NullDirContextProcessor()); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, javax.naming.directory.SearchControls, - * org.springframework.ldap.core.AttributesMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(Name base, String filter, SearchControls controls, AttributesMapper mapper) { - return search(base, filter, controls, mapper, new NullDirContextProcessor()); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, javax.naming.directory.SearchControls, - * org.springframework.ldap.core.AttributesMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List search(String base, String filter, SearchControls controls, AttributesMapper mapper) { return search(base, filter, controls, mapper, new NullDirContextProcessor()); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#search(java.lang.String, - * java.lang.String, javax.naming.directory.SearchControls, - * org.springframework.ldap.core.AttributesMapper, - * org.springframework.ldap.core.DirContextProcessor) - */ + /** + * {@inheritDoc} + */ + @Override public List search(String base, String filter, SearchControls controls, AttributesMapper mapper, DirContextProcessor processor) { AttributesMapperCallbackHandler handler = new AttributesMapperCallbackHandler(mapper); @@ -661,15 +606,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { return handler.getList(); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#search(javax.naming.Name, - * java.lang.String, javax.naming.directory.SearchControls, - * org.springframework.ldap.core.AttributesMapper, - * org.springframework.ldap.core.DirContextProcessor) - */ + /** + * {@inheritDoc} + */ + @Override public List search(Name base, String filter, SearchControls controls, AttributesMapper mapper, DirContextProcessor processor) { AttributesMapperCallbackHandler handler = new AttributesMapperCallbackHandler(mapper); @@ -678,6 +618,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { return handler.getList(); } + /** + * {@inheritDoc} + */ + @Override public List search(String base, String filter, SearchControls controls, ContextMapper mapper, DirContextProcessor processor) { assureReturnObjFlagSet(controls); @@ -687,6 +631,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { return handler.getList(); } + /** + * {@inheritDoc} + */ + @Override public List search(Name base, String filter, SearchControls controls, ContextMapper mapper, DirContextProcessor processor) { assureReturnObjFlagSet(controls); @@ -696,6 +644,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { return handler.getList(); } + /** + * {@inheritDoc} + */ + @Override public void list(final String base, NameClassPairCallbackHandler handler) { SearchExecutor searchExecutor = new SearchExecutor() { public NamingEnumeration executeSearch(DirContext ctx) throws javax.naming.NamingException { @@ -706,10 +658,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { search(searchExecutor, handler); } - /* - * @see org.springframework.ldap.core.LdapOperations#list(javax.naming.Name, - * org.springframework.ldap.core.NameClassPairCallbackHandler) - */ + /** + * {@inheritDoc} + */ + @Override public void list(final Name base, NameClassPairCallbackHandler handler) { SearchExecutor searchExecutor = new SearchExecutor() { public NamingEnumeration executeSearch(DirContext ctx) throws javax.naming.NamingException { @@ -720,45 +672,46 @@ public class LdapTemplate implements LdapOperations, InitializingBean { search(searchExecutor, handler); } - /* - * @see org.springframework.ldap.core.LdapOperations#list(java.lang.String, - * org.springframework.ldap.core.NameClassPairMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List list(String base, NameClassPairMapper mapper) { CollectingNameClassPairCallbackHandler handler = new MappingCollectingNameClassPairCallbackHandler(mapper); list(base, handler); return handler.getList(); } - /* - * @see org.springframework.ldap.core.LdapOperations#list(javax.naming.Name, - * org.springframework.ldap.core.NameClassPairMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List list(Name base, NameClassPairMapper mapper) { CollectingNameClassPairCallbackHandler handler = new MappingCollectingNameClassPairCallbackHandler(mapper); list(base, handler); return handler.getList(); } - /* - * @see org.springframework.ldap.core.LdapOperations#list(javax.naming.Name) - */ + /** + * {@inheritDoc} + */ + @Override public List list(final Name base) { return list(base, new DefaultNameClassPairMapper()); } - /* - * @see org.springframework.ldap.core.LdapOperations#list(java.lang.String) - */ + /** + * {@inheritDoc} + */ + @Override public List list(final String base) { return list(base, new DefaultNameClassPairMapper()); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#listBindings(java.lang.String - * , org.springframework.ldap.core.NameClassPairCallbackHandler) - */ + /** + * {@inheritDoc} + */ + @Override public void listBindings(final String base, NameClassPairCallbackHandler handler) { SearchExecutor searchExecutor = new SearchExecutor() { public NamingEnumeration executeSearch(DirContext ctx) throws javax.naming.NamingException { @@ -769,11 +722,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { search(searchExecutor, handler); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#listBindings(javax.naming - * .Name, org.springframework.ldap.core.NameClassPairCallbackHandler) - */ + /** + * {@inheritDoc} + */ + @Override public void listBindings(final Name base, NameClassPairCallbackHandler handler) { SearchExecutor searchExecutor = new SearchExecutor() { public NamingEnumeration executeSearch(DirContext ctx) throws javax.naming.NamingException { @@ -784,78 +736,76 @@ public class LdapTemplate implements LdapOperations, InitializingBean { search(searchExecutor, handler); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#listBindings(java.lang.String - * , org.springframework.ldap.core.NameClassPairMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List listBindings(String base, NameClassPairMapper mapper) { CollectingNameClassPairCallbackHandler handler = new MappingCollectingNameClassPairCallbackHandler(mapper); listBindings(base, handler); return handler.getList(); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#listBindings(javax.naming - * .Name, org.springframework.ldap.core.NameClassPairMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List listBindings(Name base, NameClassPairMapper mapper) { CollectingNameClassPairCallbackHandler handler = new MappingCollectingNameClassPairCallbackHandler(mapper); listBindings(base, handler); return handler.getList(); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#listBindings(java.lang.String - * ) - */ + /** + * {@inheritDoc} + */ + @Override public List listBindings(final String base) { return listBindings(base, new DefaultNameClassPairMapper()); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#listBindings(javax.naming - * .Name) - */ + /** + * {@inheritDoc} + */ + @Override public List listBindings(final Name base) { return listBindings(base, new DefaultNameClassPairMapper()); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#listBindings(java.lang.String - * , org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List listBindings(String base, ContextMapper mapper) { - ContextMapperCallbackHandler handler = new ContextMapperCallbackHandler(mapper); listBindings(base, handler); return handler.getList(); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#listBindings(javax.naming - * .Name, org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public List listBindings(Name base, ContextMapper mapper) { - ContextMapperCallbackHandler handler = new ContextMapperCallbackHandler(mapper); listBindings(base, handler); return handler.getList(); } + /** + * {@inheritDoc} + */ @Override public T executeReadOnly(ContextExecutor ce) { DirContext ctx = contextSource.getReadOnlyContext(); return executeWithContext(ce, ctx); } + /** + * {@inheritDoc} + */ @Override public T executeReadWrite(ContextExecutor ce) { DirContext ctx = contextSource.getReadWriteContext(); @@ -874,10 +824,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { } } - /* - * @see - * org.springframework.ldap.core.LdapOperations#lookup(javax.naming.Name) - */ + /** + * {@inheritDoc} + */ + @Override public Object lookup(final Name dn) { return executeReadOnly(new ContextExecutor() { public Object executeWithContext(DirContext ctx) throws javax.naming.NamingException { @@ -886,10 +836,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#lookup(java.lang.String) - */ + /** + * {@inheritDoc} + */ + @Override public Object lookup(final String dn) { return executeReadOnly(new ContextExecutor() { public Object executeWithContext(DirContext ctx) throws javax.naming.NamingException { @@ -898,11 +848,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#lookup(javax.naming.Name, - * org.springframework.ldap.core.AttributesMapper) - */ + /** + * {@inheritDoc} + */ + @Override public T lookup(final Name dn, final AttributesMapper mapper) { return executeReadOnly(new ContextExecutor() { public T executeWithContext(DirContext ctx) throws javax.naming.NamingException { @@ -912,11 +861,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#lookup(java.lang.String, - * org.springframework.ldap.core.AttributesMapper) - */ + /** + * {@inheritDoc} + */ + @Override public T lookup(final String dn, final AttributesMapper mapper) { return executeReadOnly(new ContextExecutor() { @@ -927,11 +875,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#lookup(javax.naming.Name, - * org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public T lookup(final Name dn, final ContextMapper mapper) { return executeReadOnly(new ContextExecutor() { public T executeWithContext(DirContext ctx) throws javax.naming.NamingException { @@ -941,13 +888,11 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#lookup(java.lang.String, - * org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public T lookup(final String dn, final ContextMapper mapper) { - return executeReadOnly(new ContextExecutor() { public T executeWithContext(DirContext ctx) throws javax.naming.NamingException { Object object = ctx.lookup(dn); @@ -956,13 +901,11 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#lookup(javax.naming.Name, - * java.lang.String[], org.springframework.ldap.core.AttributesMapper) - */ + /** + * {@inheritDoc} + */ + @Override public T lookup(final Name dn, final String[] attributes, final AttributesMapper mapper) { - return executeReadOnly(new ContextExecutor() { public T executeWithContext(DirContext ctx) throws javax.naming.NamingException { Attributes filteredAttributes = ctx.getAttributes(dn, attributes); @@ -971,11 +914,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#lookup(java.lang.String, - * java.lang.String[], org.springframework.ldap.core.AttributesMapper) - */ + /** + * {@inheritDoc} + */ + @Override public T lookup(final String dn, final String[] attributes, final AttributesMapper mapper) { return executeReadOnly(new ContextExecutor() { public T executeWithContext(DirContext ctx) throws javax.naming.NamingException { @@ -985,13 +927,11 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#lookup(javax.naming.Name, - * java.lang.String[], org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public T lookup(final Name dn, final String[] attributes, final ContextMapper mapper) { - return executeReadOnly(new ContextExecutor() { public T executeWithContext(DirContext ctx) throws javax.naming.NamingException { Attributes filteredAttributes = ctx.getAttributes(dn, attributes); @@ -1001,13 +941,11 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#lookup(java.lang.String, - * java.lang.String[], org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public T lookup(final String dn, final String[] attributes, final ContextMapper mapper) { - return executeReadOnly(new ContextExecutor() { public T executeWithContext(DirContext ctx) throws javax.naming.NamingException { Attributes filteredAttributes = ctx.getAttributes(dn, attributes); @@ -1018,11 +956,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#modifyAttributes(javax.naming - * .Name, javax.naming.directory.ModificationItem[]) - */ + /** + * {@inheritDoc} + */ + @Override public void modifyAttributes(final Name dn, final ModificationItem[] mods) { executeReadWrite(new ContextExecutor() { public Object executeWithContext(DirContext ctx) throws javax.naming.NamingException { @@ -1032,13 +969,11 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#modifyAttributes(java.lang - * .String, javax.naming.directory.ModificationItem[]) - */ + /** + * {@inheritDoc} + */ + @Override public void modifyAttributes(final String dn, final ModificationItem[] mods) { - executeReadWrite(new ContextExecutor() { public Object executeWithContext(DirContext ctx) throws javax.naming.NamingException { ctx.modifyAttributes(dn, mods); @@ -1047,12 +982,11 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see org.springframework.ldap.core.LdapOperations#bind(javax.naming.Name, - * java.lang.Object, javax.naming.directory.Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public void bind(final Name dn, final Object obj, final Attributes attributes) { - executeReadWrite(new ContextExecutor() { public Object executeWithContext(DirContext ctx) throws javax.naming.NamingException { ctx.bind(dn, obj, attributes); @@ -1061,12 +995,11 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see org.springframework.ldap.core.LdapOperations#bind(java.lang.String, - * java.lang.Object, javax.naming.directory.Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public void bind(final String dn, final Object obj, final Attributes attributes) { - executeReadWrite(new ContextExecutor() { public Object executeWithContext(DirContext ctx) throws javax.naming.NamingException { ctx.bind(dn, obj, attributes); @@ -1075,27 +1008,26 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#unbind(javax.naming.Name) - */ + /** + * {@inheritDoc} + */ + @Override public void unbind(final Name dn) { doUnbind(dn); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#unbind(java.lang.String) - */ + /** + * {@inheritDoc} + */ + @Override public void unbind(final String dn) { doUnbind(dn); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#unbind(javax.naming.Name, - * boolean) - */ + /** + * {@inheritDoc} + */ + @Override public void unbind(final Name dn, boolean recursive) { if (!recursive) { doUnbind(dn); @@ -1105,11 +1037,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { } } - /* - * @see - * org.springframework.ldap.core.LdapOperations#unbind(java.lang.String, - * boolean) - */ + /** + * {@inheritDoc} + */ + @Override public void unbind(final String dn, boolean recursive) { if (!recursive) { doUnbind(dn); @@ -1191,13 +1122,11 @@ public class LdapTemplate implements LdapOperations, InitializingBean { } } - /* - * @see - * org.springframework.ldap.core.LdapOperations#rebind(javax.naming.Name, - * java.lang.Object, javax.naming.directory.Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public void rebind(final Name dn, final Object obj, final Attributes attributes) { - executeReadWrite(new ContextExecutor() { public Object executeWithContext(DirContext ctx) throws javax.naming.NamingException { ctx.rebind(dn, obj, attributes); @@ -1206,13 +1135,11 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#rebind(java.lang.String, - * java.lang.Object, javax.naming.directory.Attributes) - */ + /** + * {@inheritDoc} + */ + @Override public void rebind(final String dn, final Object obj, final Attributes attributes) { - executeReadWrite(new ContextExecutor() { public Object executeWithContext(DirContext ctx) throws javax.naming.NamingException { ctx.rebind(dn, obj, attributes); @@ -1221,13 +1148,11 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#rename(javax.naming.Name, - * javax.naming.Name) - */ + /** + * {@inheritDoc} + */ + @Override public void rename(final Name oldDn, final Name newDn) { - executeReadWrite(new ContextExecutor() { public Object executeWithContext(DirContext ctx) throws javax.naming.NamingException { ctx.rename(oldDn, newDn); @@ -1236,13 +1161,11 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.ldap.core.LdapOperations#rename(java.lang.String, - * java.lang.String) - */ + /** + * {@inheritDoc} + */ + @Override public void rename(final String oldDn, final String newDn) { - executeReadWrite(new ContextExecutor() { public Object executeWithContext(DirContext ctx) throws javax.naming.NamingException { ctx.rename(oldDn, newDn); @@ -1251,10 +1174,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } - /* - * @see - * org.springframework.beans.factory.InitializingBean#afterPropertiesSet() - */ + /** + * {@inheritDoc} + */ + @Override public void afterPropertiesSet() throws Exception { Assert.notNull(contextSource, "Property 'contextSource' must be set."); } @@ -1355,10 +1278,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { this.mapper = mapper; } - /* - * @seeorg.springframework.ldap.CollectingNameClassPairCallbackHandler# - * getObjectFromNameClassPair(javax.naming.NameClassPair) - */ + /** + * {@inheritDoc} + */ public T getObjectFromNameClassPair(NameClassPair nameClassPair) { try { return mapper.mapFromNameClassPair(nameClassPair); @@ -1369,34 +1291,26 @@ public class LdapTemplate implements LdapOperations, InitializingBean { } } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#lookupContext(javax.naming - * .Name) - */ + /** + * {@inheritDoc} + */ + @Override public DirContextOperations lookupContext(Name dn) { return (DirContextOperations) lookup(dn); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#lookupContext(java.lang. - * String) - */ + /** + * {@inheritDoc} + */ + @Override public DirContextOperations lookupContext(String dn) { return (DirContextOperations) lookup(dn); } - /* - * (non-Javadoc) - * - * @seeorg.springframework.ldap.core.LdapOperations#modifyAttributes(org. - * springframework.ldap.core.DirContextOperations) - */ + /** + * {@inheritDoc} + */ + @Override public void modifyAttributes(DirContextOperations ctx) { Name dn = ctx.getDn(); if (dn != null && ctx.isUpdateMode()) { @@ -1407,12 +1321,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { } } - /* - * (non-Javadoc) - * - * @seeorg.springframework.ldap.core.LdapOperations#bind(org. - * springframework.ldap.core.DirContextOperations) - */ + /** + * {@inheritDoc} + */ + @Override public void bind(DirContextOperations ctx) { Name dn = ctx.getDn(); if (dn != null && !ctx.isUpdateMode()) { @@ -1424,11 +1336,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { } - /* - * @see - * org.springframework.ldap.core.LdapOperations#rebind(org.springframework. - * ldap.core.DirContextOperations) - */ + /** + * {@inheritDoc} + */ + @Override public void rebind(DirContextOperations ctx) { Name dn = ctx.getDn(); if (dn != null && !ctx.isUpdateMode()) { @@ -1440,107 +1351,75 @@ public class LdapTemplate implements LdapOperations, InitializingBean { } } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#authenticate(javax.naming - * .Name, java.lang.String, java.lang.String) - */ + /** + * {@inheritDoc} + */ + @Override public boolean authenticate(Name base, String filter, String password) { return authenticate(base, filter, password, new NullAuthenticatedLdapEntryContextCallback(), new NullAuthenticationErrorCallback()); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#authenticate(java.lang.String - * , java.lang.String, java.lang.String) - */ + /** + * {@inheritDoc} + */ + @Override public boolean authenticate(String base, String filter, String password) { return authenticate(LdapUtils.newLdapName(base), filter, password, new NullAuthenticatedLdapEntryContextCallback(), new NullAuthenticationErrorCallback()); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#authenticate(java.lang.String - * , java.lang.String, java.lang.String, - * org.springframework.ldap.core.AuthenticatedLdapEntryContextCallback) - */ + /** + * {@inheritDoc} + */ + @Override public boolean authenticate(String base, String filter, String password, AuthenticatedLdapEntryContextCallback callback) { return authenticate(LdapUtils.newLdapName(base), filter, password, callback, new NullAuthenticationErrorCallback()); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#authenticate(javax.naming - * .Name, java.lang.String, java.lang.String, - * org.springframework.ldap.core.AuthenticatedLdapEntryContextCallback) - */ + /** + * {@inheritDoc} + */ + @Override public boolean authenticate(Name base, String filter, String password, final AuthenticatedLdapEntryContextCallback callback) { return authenticate(base, filter, password, callback, new NullAuthenticationErrorCallback()); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#authenticate(java.lang.String - * , java.lang.String, java.lang.String, - * org.springframework.ldap.core.AuthenticationErrorCallback) - */ + /** + * {@inheritDoc} + */ + @Override public boolean authenticate(String base, String filter, String password, AuthenticationErrorCallback errorCallback) { return authenticate(LdapUtils.newLdapName(base), filter, password, new NullAuthenticatedLdapEntryContextCallback(), errorCallback); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#authenticate(javax.naming - * .Name, java.lang.String, java.lang.String, - * org.springframework.ldap.core.AuthenticationErrorCallback) - */ + /** + * {@inheritDoc} + */ + @Override public boolean authenticate(Name base, String filter, String password, final AuthenticationErrorCallback errorCallback) { return authenticate(base, filter, password, new NullAuthenticatedLdapEntryContextCallback(), errorCallback); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#authenticate(java.lang.String - * , java.lang.String, java.lang.String, - * org.springframework.ldap.core.AuthenticatedLdapEntryContextCallback, - * org.springframework.ldap.core.AuthenticationErrorCallback) - */ + /** + * {@inheritDoc} + */ + @Override public boolean authenticate(String base, String filter, String password, final AuthenticatedLdapEntryContextCallback callback, final AuthenticationErrorCallback errorCallback) { return authenticate(LdapUtils.newLdapName(base), filter, password, callback, errorCallback); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#authenticate(javax.naming - * .Name, java.lang.String, java.lang.String, - * org.springframework.ldap.core.AuthenticatedLdapEntryContextCallback, - * org.springframework.ldap.core.AuthenticationErrorCallback) - */ + /** + * {@inheritDoc} + */ + @Override public boolean authenticate(Name base, String filter, String password, final AuthenticatedLdapEntryContextCallback callback, final AuthenticationErrorCallback errorCallback) { @@ -1588,6 +1467,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { } } + /** + * {@inheritDoc} + */ @Override public T authenticate(LdapQuery query, String password, AuthenticatedLdapEntryContextMapper mapper) { SearchControls searchControls = searchControlsForQuery(query, RETURN_OBJ_FLAG); @@ -1618,6 +1500,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { return mapperCallback.collectedObject; } + /** + * {@inheritDoc} + */ @Override public void authenticate(LdapQuery query, String password) { authenticate(query, @@ -1625,13 +1510,10 @@ public class LdapTemplate implements LdapOperations, InitializingBean { new NullAuthenticatedLdapEntryContextCallback()); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#searchForObject(javax.naming - * .Name, java.lang.String, org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public T searchForObject(Name base, String filter, ContextMapper mapper) { return searchForObject(base, filter, @@ -1639,17 +1521,18 @@ public class LdapTemplate implements LdapOperations, InitializingBean { mapper); } - /* - * (non-Javadoc) - * - * @see - * org.springframework.ldap.core.LdapOperations#searchForObject(java.lang - * .String, java.lang.String, org.springframework.ldap.core.ContextMapper) - */ + /** + * {@inheritDoc} + */ + @Override public T searchForObject(String base, String filter, ContextMapper mapper) { return searchForObject(LdapUtils.newLdapName(base), filter, mapper); } + /** + * {@inheritDoc} + */ + @Override public T searchForObject (Name base, String filter, SearchControls searchControls, ContextMapper mapper) { List result = search(base, filter, searchControls, mapper); @@ -1663,6 +1546,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { return result.get(0); } + /** + * {@inheritDoc} + */ @Override public T searchForObject(String base, String filter, SearchControls searchControls, ContextMapper mapper) { return searchForObject(LdapUtils.newLdapName(base), filter, searchControls, mapper); @@ -1698,12 +1584,18 @@ public class LdapTemplate implements LdapOperations, InitializingBean { this.mapper = mapper; } + /** + * {@inheritDoc} + */ @Override public void executeWithContext(DirContext ctx, LdapEntryIdentification ldapEntryIdentification) { collectedObject = mapper.mapWithContext(ctx, ldapEntryIdentification); } } + /** + * {@inheritDoc} + */ @Override public void search(LdapQuery query, NameClassPairCallbackHandler callbackHandler) { SearchControls searchControls = searchControlsForQuery(query, DONT_RETURN_OBJ_FLAG); @@ -1713,6 +1605,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { callbackHandler); } + /** + * {@inheritDoc} + */ @Override public List search(LdapQuery query, ContextMapper mapper) { SearchControls searchControls = searchControlsForQuery(query, RETURN_OBJ_FLAG); @@ -1744,6 +1639,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { return searchControls; } + /** + * {@inheritDoc} + */ @Override public List search(LdapQuery query, AttributesMapper mapper) { SearchControls searchControls = searchControlsForQuery(query, DONT_RETURN_OBJ_FLAG); @@ -1754,6 +1652,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { mapper); } + /** + * {@inheritDoc} + */ @Override public DirContextOperations searchForContext(LdapQuery query) { return searchForObject(query, new ContextMapper() { @@ -1764,6 +1665,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { }); } + /** + * {@inheritDoc} + */ @Override public T searchForObject(LdapQuery query, ContextMapper mapper) { SearchControls searchControls = searchControlsForQuery(query, DONT_RETURN_OBJ_FLAG); @@ -1774,6 +1678,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { mapper); } + /** + * {@inheritDoc} + */ @Override public T findByDn(Name dn, final Class clazz) { if (LOG.isDebugEnabled()) { @@ -1800,6 +1707,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { return result; } + /** + * {@inheritDoc} + */ @Override public void create(Object entry) { Assert.notNull(entry, "Entry must not be null"); @@ -1822,6 +1732,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { bind(context); } + /** + * {@inheritDoc} + */ @Override public void update(Object entry) { Assert.notNull(entry, "Entry must not be null"); @@ -1864,6 +1777,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { } } + /** + * {@inheritDoc} + */ @Override public void delete(Object entry) { Assert.notNull(entry, "Entry must not be null"); @@ -1880,11 +1796,17 @@ public class LdapTemplate implements LdapOperations, InitializingBean { unbind(id); } + /** + * {@inheritDoc} + */ @Override public List findAll(Name base, SearchControls searchControls, final Class clazz) { return find(base, null, searchControls, clazz); } + /** + * {@inheritDoc} + */ @Override public List findAll(Class clazz) { return findAll(LdapUtils.emptyLdapName(), @@ -1892,6 +1814,9 @@ public class LdapTemplate implements LdapOperations, InitializingBean { clazz); } + /** + * {@inheritDoc} + */ @Override public List find(Name base, Filter filter, SearchControls searchControls, final Class clazz) { Filter finalFilter = odm.filterFor(clazz, filter); @@ -1921,12 +1846,18 @@ public class LdapTemplate implements LdapOperations, InitializingBean { return result; } + /** + * {@inheritDoc} + */ @Override public List find(LdapQuery query, Class clazz) { SearchControls searchControls = searchControlsForQuery(query, RETURN_OBJ_FLAG); return find(query.base(), query.filter(), searchControls, clazz); } + /** + * {@inheritDoc} + */ @Override public T findOne(LdapQuery query, Class clazz) { List result = find(query, clazz); diff --git a/test/integration-tests/build.gradle b/test/integration-tests/build.gradle index c7bbd6d0..241eb2fe 100644 --- a/test/integration-tests/build.gradle +++ b/test/integration-tests/build.gradle @@ -97,7 +97,7 @@ dependencies { } test { - jvmArgs "-javaagent:${configurations.jacoco.asPath}=destfile=../../core/build/jacoco.exec,includes=${project.group}.*" + jvmArgs "-javaagent:${configurations.jacoco.asPath}=destfile=$projectDir/../../core/build/jacoco.exec,includes=${project.group}.*" systemProperties = System.properties }