PrincipalExtractor (Search Guard Suite - Security 7.10.2-52.5.0 API)

All Known Implementing Classes:

DefaultPrincipalExtractor
```
public interface PrincipalExtractor
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class PrincipalExtractor.Type

Method Summary

All Methods Instance Methods Abstract 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.

- Method Detail
  - extractPrincipal
```
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. 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.
    
    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.