net.sourceforge.heracles.api
Class Heracles

java.lang.Object
  net.sourceforge.heracles.api.Heracles

Direct Known Subclasses:

HeraclesImpl

public abstract class Heracles
extends java.lang.Object

Title: Heracles.java
Description: This Class is the api of the heracles project
Java Version: JDK 1.5

Author:

Philipp Gantert version 1.0

Field Summary

private static Heracles

heracles

Constructor Summary

Heracles()

Method Summary

abstract LdapUser	authAdvanced(java.lang.String username, java.lang.String password) This method takes the usersername and the password as Strings and does the authentication.
abstract void	authSimple(java.lang.String username, java.lang.String password) This method takes the usersername and the password as Strings and does the authentication.
static Heracles	getHeracles() Clients get over this method an instance of the heracles project api
abstract java.util.List<LdapUser>	searchInLdap(java.lang.String domainName, java.lang.String where, java.lang.String like) This method could be used to search in the ldap for something, the result will be come as a List.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

heracles

private static Heracles heracles

Constructor Detail

Heracles

public Heracles()

Method Detail

authSimple

public abstract void authSimple(java.lang.String username,
                                java.lang.String password)
                         throws javax.security.auth.login.LoginException,
                                HeraclesException

This method takes the usersername and the password as Strings and does the authentication. If the authetication fail an exception will return.

Parameters:

username -

password -

Throws:

javax.security.auth.login.LoginException

HeraclesException

authAdvanced

public abstract LdapUser authAdvanced(java.lang.String username,
                                      java.lang.String password)
                               throws javax.security.auth.login.LoginException,
                                      javax.naming.NamingException,
                                      HeraclesException

This method takes the usersername and the password as Strings and does the authentication. If the authetication fail an exception will return. Is the authentication successfull the methode will return a LDAP-User Object. This Object includes by example the groups of which it is member of

Parameters:

username -

password -

Returns:

LdapUser

Throws:

javax.security.auth.login.LoginException

javax.naming.NamingException

HeraclesException

searchInLdap

public abstract java.util.List<LdapUser> searchInLdap(java.lang.String domainName,
                                                      java.lang.String where,
                                                      java.lang.String like)
                                               throws javax.naming.NamingException,
                                                      HeraclesException

This method could be used to search in the ldap for something, the result will be come as a List. Maybe there are more then one result. This list inludes LDAP-User Object where be found for the searched String.

Parameters:

where - specified the ldap attribut

like - specified the search string

domainName - specified the domain of the search

Returns:

List

Throws:

javax.naming.NamingException

HeraclesException

getHeracles

public static Heracles getHeracles()

Clients get over this method an instance of the heracles project api

Returns:

Heracles