SecurityRealm (plugin-api 10.3.0.1951 API)

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

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

Since:: 2.14

Constructor Summary

Constructors
Constructor Description

SecurityRealm()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract Authenticator`	`doGetAuthenticator()`
`ExternalGroupsProvider`	`getGroupsProvider()`
`java.lang.String`	`getName()`
`ExternalUsersProvider`	`getUsersProvider()`
`void`	`init()`	Invoked during server startup and can be used to initialize internal state.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SecurityRealm
```
public SecurityRealm()
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns:
    
    unique name of this realm, e.g. "ldap"
  - init
```
public void init()
```
    Invoked during server startup and can be used to initialize internal state.
  - doGetAuthenticator
```
public abstract Authenticator doGetAuthenticator()
```
    Since:
    
    3.1, 10.0 this method does not provide a default implementation anymore
  - getUsersProvider
```
public ExternalUsersProvider getUsersProvider()
```
    Returns:
    
    ExternalUsersProvider associated with this realm, null if not supported
  - getGroupsProvider
```
public ExternalGroupsProvider getGroupsProvider()
```
    Returns:
    
    ExternalGroupsProvider associated with this realm, null if not supported