de.innovationgate.wga.server.api

Class Auth

java.lang.Object

de.innovationgate.wga.server.api.Auth

public class Auth
extends java.lang.Object

An object for providing services regarding user authentication. This is normally created on behalf of a domain. However the deprecated method WGA.auth() returns an object without a domain in context which therefor will not be able to provide domain-specific services.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyAccessFilter(java.lang.String filter) Applies an access filter to the current user on the current domain.
void	applyAccessFilter(java.lang.String filter, Database db) Applies an access filter to the current user only on given database This will implicitly reopen an open session on that database, so that the filter is immediately active
void	changeSessionPassword(java.lang.String newPassword) Change a password that is used to authenticate on the domain for the current session This method should be used on "password self service" applications where users are able to change their login password on the authentication backend.
void	changeSessionPassword(java.lang.String domain, java.lang.String newPassword) Change a password that is used to authenticate on a domain for the current session This method should be used on "password self service" applications where users are able to change their login password on the authentication backend.
java.lang.String	fetchEMail(java.lang.String user) Fetches the eMail address for a user from the authentication backend This is a service whose availability depends on the Authentication source in use but should be available for most.
java.util.List<de.innovationgate.webgate.api.auth.UserGroupInfo>	findUsersAndGroups(java.lang.String query) Searches for users and groups on the authentication backend This is an optional service of authentication sources that allows to search for users and groups that are known to the backend by providing a query.
java.lang.String	getAccessFilter() Returns the currently active access filter uid for the domain, null if there is none
java.lang.String	getAccessFilter(Database db) Returns the currently active access filter uid on the given database, null if there is none
java.lang.String	getAuthenticationType() Returns the type of authentication that the user used to authenticate to the current domain. null if the user is not logged in.
java.lang.String	getLoginName() Returns the name by which the user is logged into this domain, null if he isn't
de.innovationgate.webgate.api.auth.AuthenticationModule	getModule() Returns the WGAPI authentication module backing this authentication
java.lang.Object	getSessionCredentials() Returns the credentials by which the current user is logged in to this domain When using regular user/password authentication this will return a string password.
java.lang.String	getSessionUser() Returns the user name by which the current user is logged in to the current domain This is the user name as it came from the authentication process, for example via a manual login on some login page.
boolean	isAnonymous() Returns if the user is currently anonymous
boolean	login(java.lang.String user, de.innovationgate.webgate.api.auth.CustomCredentials creds) Login to the domain with user/password credentials
boolean	login(java.lang.String user, de.innovationgate.webgate.api.auth.CustomCredentials creds, java.lang.String domain) Login to a domain with user/password credentials
boolean	login(java.lang.String user, java.lang.String password) Login to the domain with plain user/password
boolean	login(java.lang.String user, java.lang.String password, java.lang.String domain) Login to a domain with plain user/password
boolean	logout() Logout from the domain
boolean	logout(java.lang.String domain) Logout from a domain
de.innovationgate.webgate.api.auth.UserGroupInfo	lookupDN(java.lang.String dn) Looks up user information by a distinguished user name
void	removeAccessFilter() Removes a currently active access filter on the domain
void	removeAccessFilter(Database db) Removes a currently active access filter on the given database
void	waitForUpdates(int timeoutSeconds) Waits until updates on the authentication content store of the current domain are effective This is a rather special method for use in the UI of authentication applications, whose content stores store data about users and groups for login.
void	waitForUpdates(de.innovationgate.webgate.api.WGDatabase db, int timeoutSeconds) Waits until updates on an authentication content store are effective This is a rather special method for use in the UI of authentication applications, whose content stores store data about users and groups for login.

Methods inherited from class java.lang.Object

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

Method Detail

login

public boolean login(java.lang.String user,
            java.lang.String password)
              throws de.innovationgate.webgate.api.WGException

Login to the domain with plain user/password

Parameters:

user - The user name

password - The password

Returns:

true if the login succeeded

Throws:

LoginException

de.innovationgate.webgate.api.WGAPIException

UnavailableResourceException

de.innovationgate.webgate.api.WGException

login

public boolean login(java.lang.String user,
            java.lang.String password,
            java.lang.String domain)
              throws de.innovationgate.webgate.api.WGException

Login to a domain with plain user/password

Parameters:

user - The user name

password - The password

domain - The domain to login to

Returns:

true if the login succeeded

Throws:

LoginException

de.innovationgate.webgate.api.WGAPIException

UnavailableResourceException

de.innovationgate.webgate.api.WGException

login

public boolean login(java.lang.String user,
            de.innovationgate.webgate.api.auth.CustomCredentials creds)
              throws de.innovationgate.webgate.api.WGException

Login to the domain with user/password credentials

Parameters:

user - The user name

creds - The credentials

Returns:

true if the login succeeded

Throws:

LoginException

de.innovationgate.webgate.api.WGAPIException

UnavailableResourceException

de.innovationgate.webgate.api.WGException

login

public boolean login(java.lang.String user,
            de.innovationgate.webgate.api.auth.CustomCredentials creds,
            java.lang.String domain)
              throws de.innovationgate.webgate.api.WGException

Login to a domain with user/password credentials

Parameters:

user - The user name

creds - The credentials

domain - The domain to login to

Returns:

true if the login succeeded

Throws:

LoginException

de.innovationgate.webgate.api.WGAPIException

UnavailableResourceException

de.innovationgate.webgate.api.WGException

logout

public boolean logout(java.lang.String domain)
               throws de.innovationgate.webgate.api.WGException

Logout from a domain

Parameters:

domain - The domain to logout from

Returns:

Always true

Throws:

de.innovationgate.webgate.api.WGAPIException

UnavailableResourceException

de.innovationgate.webgate.api.WGException

logout

public boolean logout()
               throws de.innovationgate.webgate.api.WGException

Logout from the domain

Returns:

Always true

Throws:

de.innovationgate.webgate.api.WGAPIException

UnavailableResourceException

de.innovationgate.webgate.api.WGException

changeSessionPassword

public void changeSessionPassword(java.lang.String domain,
                         java.lang.String newPassword)
                           throws de.innovationgate.webgate.api.WGException

Change a password that is used to authenticate on a domain for the current session This method should be used on "password self service" applications where users are able to change their login password on the authentication backend. After that is done his old password, which he has used before to login to the system, is still stored and present on his web session but no longer matches the changed password. Calling this method after the password change will also change the stored password on the web session and therefor prevent the user from being logged out.

Parameters:

domain - The domain

newPassword - The new password to use

Throws:

UnavailableResourceException

de.innovationgate.webgate.api.WGException

changeSessionPassword

public void changeSessionPassword(java.lang.String newPassword)
                           throws de.innovationgate.webgate.api.WGException

Change a password that is used to authenticate on the domain for the current session This method should be used on "password self service" applications where users are able to change their login password on the authentication backend. After that is done his old password, which he has used before to login to the system, is still stored and present on his web session but no longer matches the changed password. Calling this method after the password change will also change the stored password on the web session and therefor prevent the user from being logged out.

Parameters:

newPassword - The new password to use

Throws:

UnavailableResourceException

de.innovationgate.webgate.api.WGException

waitForUpdates

public void waitForUpdates(de.innovationgate.webgate.api.WGDatabase db,
                  int timeoutSeconds)
                    throws de.innovationgate.webgate.api.WGException

Waits until updates on an authentication content store are effective This is a rather special method for use in the UI of authentication applications, whose content stores store data about users and groups for login. If a TMLScript process updates login data of the currently logged in user - for example a password - it should stop execution until the authentication backend picks up that change (which mostly happens after a short delay). Only after that it can continue safely, knowing that it can use the updated login data. Therefor after change of authentication data this method should get called, which waits for the authentication backend of the current domain to pick up updates. A timeout prevents this methods from waiting endlessly in the case of an error.

Parameters:

db - The authentication content store

timeoutSeconds -

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

waitForUpdates

public void waitForUpdates(int timeoutSeconds)
                    throws de.innovationgate.webgate.api.WGException

Waits until updates on the authentication content store of the current domain are effective This is a rather special method for use in the UI of authentication applications, whose content stores store data about users and groups for login. If a TMLScript process updates login data of the currently logged in user - for example a password - it should stop execution until the authentication backend picks up that change (which mostly happens after a short delay). Only after that it can continue safely, knowing that it can use the updated login data. Therefor after change of authentication data this method should get called, which waits for the authentication backend of the current domain to pick up updates. A timeout prevents this methods from waiting endlessly in the case of an error.

Parameters:

timeoutSeconds -

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

lookupDN

public de.innovationgate.webgate.api.auth.UserGroupInfo lookupDN(java.lang.String dn)
                                                          throws de.innovationgate.webgate.api.WGException

Looks up user information by a distinguished user name

Parameters:

dn - The distinguished user name

Returns:

Information bean about the user

Throws:

WGAServerException

de.innovationgate.webgate.api.WGQueryException

de.innovationgate.webgate.api.WGException

fetchEMail

public java.lang.String fetchEMail(java.lang.String user)
                            throws de.innovationgate.webgate.api.WGException

Fetches the eMail address for a user from the authentication backend This is a service whose availability depends on the Authentication source in use but should be available for most. Given any user name it returns the eMail adress for that user from the underlying system.

Parameters:

user - Any user name

Returns:

The mail address when it could be found, otherwise null

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

findUsersAndGroups

public java.util.List<de.innovationgate.webgate.api.auth.UserGroupInfo> findUsersAndGroups(java.lang.String query)
                                                                                    throws de.innovationgate.webgate.api.WGException

Searches for users and groups on the authentication backend This is an optional service of authentication sources that allows to search for users and groups that are known to the backend by providing a query. In most cases the query is interpreted as containing a port of the user/group name.

Parameters:

query - The query

Returns:

Result information of the query

Throws:

WGAServerException

de.innovationgate.webgate.api.WGQueryException

de.innovationgate.webgate.api.WGException

getModule

public de.innovationgate.webgate.api.auth.AuthenticationModule getModule()

Returns the WGAPI authentication module backing this authentication

getSessionUser

public java.lang.String getSessionUser()
                                throws de.innovationgate.webgate.api.WGException

Returns the user name by which the current user is logged in to the current domain This is the user name as it came from the authentication process, for example via a manual login on some login page. This is not necessarily the qualified name. In case of an anonymous user this is "anonymous".

Throws:

UnavailableResourceException

de.innovationgate.webgate.api.WGException

getSessionCredentials

public java.lang.Object getSessionCredentials()
                                       throws de.innovationgate.webgate.api.WGException

Returns the credentials by which the current user is logged in to this domain When using regular user/password authentication this will return a string password. If the user is anonymous this returns null.

Throws:

UnavailableResourceException

de.innovationgate.webgate.api.WGException

applyAccessFilter

public void applyAccessFilter(java.lang.String filter)
                       throws de.innovationgate.webgate.api.WGException

Applies an access filter to the current user on the current domain. This will implicitly reopen open sessions on all databases of the domain, so that the filter is immediately active

Parameters:

filter - The uid of the filter do apply

Throws:

de.innovationgate.webgate.api.WGException

applyAccessFilter

public void applyAccessFilter(java.lang.String filter,
                     Database db)
                       throws de.innovationgate.webgate.api.WGException

Applies an access filter to the current user only on given database This will implicitly reopen an open session on that database, so that the filter is immediately active

Parameters:

filter - The uid of the filter do apply

db - The database on which the filter should be applied

Throws:

de.innovationgate.webgate.api.WGException

getAccessFilter

public java.lang.String getAccessFilter()
                                 throws de.innovationgate.webgate.api.WGException

Returns the currently active access filter uid for the domain, null if there is none

Throws:

de.innovationgate.webgate.api.WGException

getAccessFilter

public java.lang.String getAccessFilter(Database db)
                                 throws de.innovationgate.webgate.api.WGException

Returns the currently active access filter uid on the given database, null if there is none

Throws:

de.innovationgate.webgate.api.WGException

removeAccessFilter

public void removeAccessFilter()
                        throws de.innovationgate.webgate.api.WGException

Removes a currently active access filter on the domain

Throws:

de.innovationgate.webgate.api.WGException

removeAccessFilter

public void removeAccessFilter(Database db)
                        throws de.innovationgate.webgate.api.WGException

Removes a currently active access filter on the given database

Parameters:

db - The database to remove the filter from

Throws:

de.innovationgate.webgate.api.WGException

getLoginName

public java.lang.String getLoginName()
                              throws de.innovationgate.webgate.api.WGException

Returns the name by which the user is logged into this domain, null if he isn't

Throws:

de.innovationgate.webgate.api.WGException

getAuthenticationType

public java.lang.String getAuthenticationType()
                                       throws de.innovationgate.webgate.api.WGException

Returns the type of authentication that the user used to authenticate to the current domain. null if the user is not logged in. Valid values: "password" (classic login via username/password), "cert" (client certificate), "request" (request metadata, like on most SSO solutions)

Throws:

de.innovationgate.webgate.api.WGException

isAnonymous

public boolean isAnonymous()
                    throws de.innovationgate.webgate.api.WGException

Returns if the user is currently anonymous

Throws:

de.innovationgate.webgate.api.WGException