jenkins.security

Class SecurityListener

java.lang.Object

jenkins.security.SecurityListener

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

LastGrantedAuthoritiesProperty.SecurityListenerImpl

public abstract class SecurityListener
extends Object
implements ExtensionPoint

Listener notified of various significant events related to security.

Since:

1.548

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
SecurityListener()

Method Summary

Modifier and Type	Method and Description
protected abstract void	authenticated(org.acegisecurity.userdetails.UserDetails details) Fired when a user was successfully authenticated by password.
protected abstract void	failedToAuthenticate(String username) Fired when a user tried to authenticate by password but failed.
protected abstract void	failedToLogIn(String username) Fired when a user has failed to log in via the web UI.
static void	fireAuthenticated(org.acegisecurity.userdetails.UserDetails details)
static void	fireFailedToAuthenticate(String username)
static void	fireFailedToLogIn(String username)
static void	fireLoggedIn(String username)
static void	fireLoggedOut(String username)
protected abstract void	loggedIn(String username) Fired when a user has logged in via the web UI.
protected abstract void	loggedOut(String username) Fired when a user logs out.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityListener

public SecurityListener()

Method Detail

authenticated

protected abstract void authenticated(@Nonnull
                                      org.acegisecurity.userdetails.UserDetails details)

Fired when a user was successfully authenticated by password. This might be via the web UI, or via REST (not with an API token) or CLI (not with an SSH key). Only AbstractPasswordBasedSecurityRealms are considered.

Parameters:

details - details of the newly authenticated user, such as name and groups

failedToAuthenticate

protected abstract void failedToAuthenticate(@Nonnull
                                             String username)

Fired when a user tried to authenticate by password but failed.

Parameters:

username - the user

See Also:

authenticated(org.acegisecurity.userdetails.UserDetails)

loggedIn

protected abstract void loggedIn(@Nonnull
                                 String username)

Fired when a user has logged in via the web UI. Would be called after authenticated(org.acegisecurity.userdetails.UserDetails).

Parameters:

username - the user

failedToLogIn

protected abstract void failedToLogIn(@Nonnull
                                      String username)

Fired when a user has failed to log in via the web UI. Would be called after failedToAuthenticate(java.lang.String).

Parameters:

username - the user

loggedOut

protected abstract void loggedOut(@Nonnull
                                  String username)

Fired when a user logs out.

Parameters:

username - the user

fireAuthenticated

public static void fireAuthenticated(@Nonnull
                                     org.acegisecurity.userdetails.UserDetails details)

Since:

1.569

fireFailedToAuthenticate

public static void fireFailedToAuthenticate(@Nonnull
                                            String username)

Since:

1.569

fireLoggedIn

public static void fireLoggedIn(@Nonnull
                                String username)

Since:

1.569

fireFailedToLogIn

public static void fireFailedToLogIn(@Nonnull
                                     String username)

Since:

1.569

fireLoggedOut

public static void fireLoggedOut(@Nonnull
                                 String username)

Since:

1.569