How to use

getUserDn

method

in

org.apache.shiro.realm.ldap.DefaultLdapRealm

/**
 * Returns the User Distinguished Name (DN) template to use when creating User DNs at runtime - see the
 * {@link #setUserDnTemplate(String) setUserDnTemplate} JavaDoc for a full explanation.
 *
 * @return the User Distinguished Name (DN) template to use when creating User DNs at runtime.
 */
public String getUserDnTemplate() {
  return getUserDn(USERDN_SUBSTITUTION_TOKEN);
}

/**
 * Returns the principal to use when creating the LDAP connection for an authentication attempt.
 * <p/>
 * This implementation uses a heuristic: it checks to see if the specified token's
 * {@link AuthenticationToken#getPrincipal() principal} is a {@code String}, and if so,
 * {@link #getUserDn(String) converts it} from what is
 * assumed to be a raw uid or username {@code String} into a User DN {@code String}.  Almost all LDAP directories
 * expect the authentication connection to present a User DN and not an unqualified username or uid.
 * <p/>
 * If the token's {@code principal} is not a String, it is assumed to already be in the format supported by the
 * underlying {@link LdapContextFactory} implementation and the raw principal is returned directly.
 *
 * @param token the {@link AuthenticationToken} submitted during the authentication process
 * @return the User DN or raw principal to use to acquire the LdapContext.
 * @see LdapContextFactory#getLdapContext(Object, Object)
 */
protected Object getLdapPrincipal(AuthenticationToken token) {
  Object principal = token.getPrincipal();
  if (principal instanceof String) {
    String sPrincipal = (String) principal;
    return getUserDn(sPrincipal);
  }
  return principal;
}

@Test(expected=IllegalArgumentException.class)
public void testGetUserDnNullArgument() {
  realm.getUserDn(null);
}

  @Test
  public void testGetUserDnWithOutPrefixAndSuffix() {
    realm = new DefaultLdapRealm() {
      @Override
      protected String getUserDnPrefix() {
        return null;
      }

      @Override
      protected String getUserDnSuffix() {
        return null;
      }
    };
    String principal = "foo";
    String userDn = realm.getUserDn(principal);
    assertEquals(principal, userDn);
  }
}

/**
 * Returns the User Distinguished Name (DN) template to use when creating User DNs at runtime - see the
 * {@link #setUserDnTemplate(String) setUserDnTemplate} JavaDoc for a full explanation.
 *
 * @return the User Distinguished Name (DN) template to use when creating User DNs at runtime.
 */
public String getUserDnTemplate() {
  return getUserDn(USERDN_SUBSTITUTION_TOKEN);
}

/**
 * Returns the principal to use when creating the LDAP connection for an authentication attempt.
 * <p/>
 * This implementation uses a heuristic: it checks to see if the specified token's
 * {@link AuthenticationToken#getPrincipal() principal} is a {@code String}, and if so,
 * {@link #getUserDn(String) converts it} from what is
 * assumed to be a raw uid or username {@code String} into a User DN {@code String}.  Almost all LDAP directories
 * expect the authentication connection to present a User DN and not an unqualified username or uid.
 * <p/>
 * If the token's {@code principal} is not a String, it is assumed to already be in the format supported by the
 * underlying {@link LdapContextFactory} implementation and the raw principal is returned directly.
 *
 * @param token the {@link AuthenticationToken} submitted during the authentication process
 * @return the User DN or raw principal to use to acquire the LdapContext.
 * @see LdapContextFactory#getLdapContext(Object, Object)
 */
protected Object getLdapPrincipal(AuthenticationToken token) {
  Object principal = token.getPrincipal();
  if (principal instanceof String) {
    String sPrincipal = (String) principal;
    return getUserDn(sPrincipal);
  }
  return principal;
}