DefaultPrincipalExtractor (Search Guard Suite - Security 7.6.1-41.2.0 API)

java.lang.Object
- com.floragunn.searchguard.ssl.transport.DefaultPrincipalExtractor

All Implemented Interfaces:: PrincipalExtractor

public class DefaultPrincipalExtractor
extends Object
implements PrincipalExtractor

Nested Class Summary
- Nested classes/interfaces inherited from interface com.floragunn.searchguard.ssl.transport.PrincipalExtractor
  PrincipalExtractor.Type

Field Summary

Fields
Modifier and Type Field Description

protected org.apache.logging.log4j.Logger log

Constructor Summary

Constructors
Constructor Description

DefaultPrincipalExtractor()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`extractPrincipal(X509Certificate x509Certificate, PrincipalExtractor.Type type)`	Extract the principal name Please note that this method gets called for principal extraction of other nodes as well as transport clients.

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

- Field Detail
  - log
```
protected final org.apache.logging.log4j.Logger log
```
- Constructor Detail
  - DefaultPrincipalExtractor
```
public DefaultPrincipalExtractor()
```
- Method Detail
  - extractPrincipal
```
public String extractPrincipal(X509Certificate x509Certificate,
                               PrincipalExtractor.Type type)
```
    Description copied from interface: PrincipalExtractor
    
    Extract the principal name Please note that this method gets called for principal extraction of other nodes as well as transport clients. It's up to the implementer to distinguish between them and handle them appropriately. Implementations must be public classes with a default public default constructor.
    
    Specified by:
    
    extractPrincipal in interface PrincipalExtractor
    
    Parameters:
    
    x509Certificate - The first X509 certificate in the peer certificate chain This can be null, in this case the method must also return null.
    
    Returns:
    
    The principal as string. This may be null in case where x509Certificate is null or the principal cannot be extracted because of any other circumstances.