Authenticator (sonar-plugin-api 8.9)

java.lang.Object
- org.sonar.api.security.Authenticator

@ServerSide
@ExtensionPoint
public abstract class Authenticator
extends java.lang.Object

Since:: 3.1
See Also:: SecurityRealm

- Nested Class Summary
  
  Nested Classes
  Modifier and Type Class Description
  
  static class Authenticator.Context
- Constructor Summary
  
  Constructors
  Constructor Description
  
  Authenticator()
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  abstract boolean doAuthenticate(Authenticator.Context context)
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Authenticator
```
public Authenticator()
```
- Method Detail
  - doAuthenticate
```
public abstract boolean doAuthenticate(Authenticator.Context context)
```
    Returns:
    
    true if user was successfully authenticated with specified credentials, false otherwise
    
    Throws:
    
    java.lang.RuntimeException - in case of unexpected error such as connection failure