SASLExternalMechanism (Smack 4.4.7 API)

java.lang.Object
- org.jivesoftware.smack.sasl.SASLMechanism
- - org.jivesoftware.smack.sasl.javax.SASLJavaXMechanism
  - - org.jivesoftware.smack.sasl.javax.SASLExternalMechanism

All Implemented Interfaces:

java.lang.Comparable<SASLMechanism>
```
public class SASLExternalMechanism
extends SASLJavaXMechanism
```
Implementation of the SASL EXTERNAL mechanism. To effectively use this mechanism, Java must be configured to properly supply a client SSL certificate (of some sort) to the server. It is up to the implementer to determine how to do this. Here is one method: Create a java keystore with your SSL certificate in it: keytool -genkey -alias username -dname "cn=username,ou=organizationalUnit,o=organizationaName,l=locality,s=state,c=country" Next, set the System Properties:
- javax.net.ssl.keyStore to the location of the keyStore
- javax.net.ssl.keyStorePassword to the password of the keyStore
- javax.net.ssl.trustStore to the location of the trustStore
- javax.net.ssl.trustStorePassword to the the password of the trustStore
Then, when the server requests or requires the client certificate, java will simply provide the one in the keyStore. Also worth noting is the EXTERNAL mechanism in Smack is not enabled by default. To enable it, the implementer will need to call SASLAuthentication.supportSASLMechamism("EXTERNAL");

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String NAME
- Fields inherited from class org.jivesoftware.smack.sasl.javax.SASLJavaXMechanism
  sc
- Fields inherited from class org.jivesoftware.smack.sasl.SASLMechanism
  authenticationId, authorizationId, connection, connectionConfiguration, CRAMMD5, DIGESTMD5, EXTERNAL, GSSAPI, host, password, PLAIN, serviceName, sslSession

Constructor Summary

Constructors
Constructor Description

SASLExternalMechanism()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`authzidSupported()`
`java.lang.String`	`getName()`	Returns the common name of the SASL mechanism.
`int`	`getPriority()`	Get the priority of this SASL mechanism.
`SASLExternalMechanism`	`newInstance()`
`boolean`	`requiresPassword()`

Methods inherited from class org.jivesoftware.smack.sasl.javax.SASLJavaXMechanism
authenticateInternal, authenticateInternal, checkIfSuccessfulOrThrow, evaluateChallenge, getAuthenticationText, getSaslProps, getServerName

Methods inherited from class org.jivesoftware.smack.sasl.SASLMechanism
afterFinalSaslChallenge, authenticate, authenticate, challengeReceived, compareTo, instanceForAuthentication, isAuthenticationSuccessful, isFinished, saslPrep, setException, throwExceptionIfRequired, toBytes, toString

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

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SASLExternalMechanism
```
public SASLExternalMechanism()
```
- Method Detail
  - authzidSupported
```
public boolean authzidSupported()
```
    Overrides:
    
    authzidSupported in class SASLMechanism
  - getName
```
public java.lang.String getName()
```
    Description copied from class: SASLMechanism
    
    Returns the common name of the SASL mechanism. E.g.: PLAIN, DIGEST-MD5 or GSSAPI.
    
    Specified by:
    
    getName in class SASLJavaXMechanism
    
    Returns:
    
    the common name of the SASL mechanism.
  - getPriority
```
public int getPriority()
```
    Description copied from class: SASLMechanism
    
    Get the priority of this SASL mechanism. Lower values mean higher priority.
    
    Specified by:
    
    getPriority in class SASLMechanism
    
    Returns:
    
    the priority of this SASL mechanism.
  - newInstance
```
public SASLExternalMechanism newInstance()
```
    Specified by:
    
    newInstance in class SASLMechanism
  - requiresPassword
```
public boolean requiresPassword()
```
    Overrides:
    
    requiresPassword in class SASLMechanism