OpenJDK 27 · com.sun.security.sasl.ExternalClient · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private boolean	completed
private byte[]	username

Access	Constructor and Description
pack-priv	ExternalClient(String If non-null, used to specify authorization ID. authorizationID) Constructs an External mechanism with optional authorization ID.

Method Summary

Modifier and Type	Method and Description
public void	dispose() Implements javax.security.sasl.SaslClient.dispose. Disposes of any system resources or security-sensitive information the SaslClient might be using.
public byte[]	Returns: The possible empty initial response. evaluateChallenge(byte[] Ignored. challengeData) Implements javax.security.sasl.SaslClient.evaluateChallenge. Processes the challenge data.
public String	Returns: The string "EXTERNAL". getMechanismName() Implements javax.security.sasl.SaslClient.getMechanismName. Retrieves this mechanism's name for initiating the "EXTERNAL" protocol exchange.
public Object	Returns: null No property is applicable to this mechanism. getNegotiatedProperty(String propName) Implements javax.security.sasl.SaslClient.getNegotiatedProperty. Retrieves the negotiated property.
public boolean	hasInitialResponse() Implements javax.security.sasl.SaslClient.hasInitialResponse. This mechanism has an initial response.
public boolean	Returns: true if initial response has been sent; false otherwise. isComplete() Implements javax.security.sasl.SaslClient.isComplete. Returns whether this mechanism is complete.
public byte[]	unwrap(byte[] incoming, int offset, int len) Implements javax.security.sasl.SaslClient.unwrap. Unwraps the incoming buffer.
public byte[]	wrap(byte[] outgoing, int offset, int len) Implements javax.security.sasl.SaslClient.wrap. Wraps the outgoing buffer.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

completed	back to summary
private boolean completed

username	back to summary
private byte[] username

ExternalClient	back to summary
pack-priv ExternalClient(String authorizationID) Constructs an External mechanism with optional authorization ID. Parameters authorizationID:String If non-null, used to specify authorization ID.

Method Detail

dispose	back to summary
public void dispose() throws SaslException Implements javax.security.sasl.SaslClient.dispose. Doc from javax.security.sasl.SaslClient.dispose. Disposes of any system resources or security-sensitive information the SaslClient might be using. Invoking this method invalidates the SaslClient instance. This method is idempotent. Exceptions SaslException: If a problem was encountered while disposing the resources.

dispose

back to summary

public void dispose() throws SaslException

Implements javax.security.sasl.SaslClient.dispose.

Doc from javax.security.sasl.SaslClient.dispose.

Disposes of any system resources or security-sensitive information the SaslClient might be using. Invoking this method invalidates the SaslClient instance. This method is idempotent.

Exceptions

SaslException:: If a problem was encountered while disposing the resources.

evaluateChallenge	back to summary
public byte[] evaluateChallenge(byte[] challengeData) Implements javax.security.sasl.SaslClient.evaluateChallenge. Processes the challenge data. It returns the EXTERNAL mechanism's initial response, which is the authorization id encoded in UTF-8. This is the optional information that is sent along with the SASL command. After this method is called, isComplete() returns true. Parameters challengeData:byte[] Ignored. Returns:byte[] The possible empty initial response. Exceptions IllegalStateException: If authentication has already been called.

evaluateChallenge

back to summary

public byte[] evaluateChallenge(byte[] challengeData)

Implements javax.security.sasl.SaslClient.evaluateChallenge.

Processes the challenge data. It returns the EXTERNAL mechanism's initial response, which is the authorization id encoded in UTF-8. This is the optional information that is sent along with the SASL command. After this method is called, isComplete() returns true.

Parameters

challengeData:byte[]: Ignored.

Returns:byte[]

The possible empty initial response.

Exceptions

IllegalStateException:: If authentication has already been called.

getMechanismName	back to summary
public String getMechanismName() Implements javax.security.sasl.SaslClient.getMechanismName. Retrieves this mechanism's name for initiating the "EXTERNAL" protocol exchange. Returns:String The string "EXTERNAL".

getMechanismName

back to summary

public String getMechanismName()

Implements javax.security.sasl.SaslClient.getMechanismName.

Retrieves this mechanism's name for initiating the "EXTERNAL" protocol exchange.

Returns:String: The string "EXTERNAL".

getNegotiatedProperty back to summary

getNegotiatedProperty	back to summary
public Object getNegotiatedProperty(String propName) Implements javax.security.sasl.SaslClient.getNegotiatedProperty. Retrieves the negotiated property. This method can be called only after the authentication exchange has completed (i.e., when `isComplete()` returns true); otherwise, an `IllegalStateException` is thrown. Returns:Object null No property is applicable to this mechanism. Exceptions IllegalStateException: if this authentication exchange has not completed

public Object getNegotiatedProperty(String propName)

Implements javax.security.sasl.SaslClient.getNegotiatedProperty.

Retrieves the negotiated property. This method can be called only after the authentication exchange has completed (i.e., when isComplete() returns true); otherwise, an IllegalStateException is thrown.

Returns:Object

null No property is applicable to this mechanism.

Exceptions

IllegalStateException:: if this authentication exchange has not completed

hasInitialResponse	back to summary
public boolean hasInitialResponse() Implements javax.security.sasl.SaslClient.hasInitialResponse. This mechanism has an initial response.

hasInitialResponse

back to summary

public boolean hasInitialResponse()

Implements javax.security.sasl.SaslClient.hasInitialResponse.

This mechanism has an initial response.

isComplete	back to summary
public boolean isComplete() Implements javax.security.sasl.SaslClient.isComplete. Returns whether this mechanism is complete. Returns:boolean true if initial response has been sent; false otherwise.

isComplete

back to summary

public boolean isComplete()

Implements javax.security.sasl.SaslClient.isComplete.

Returns whether this mechanism is complete.

Returns:boolean: true if initial response has been sent; false otherwise.

unwrap	back to summary
public byte[] unwrap(byte[] incoming, int offset, int len) throws SaslException Implements javax.security.sasl.SaslClient.unwrap. Unwraps the incoming buffer. Exceptions SaslException: Not applicable to this mechanism.

unwrap

back to summary

public byte[] unwrap(byte[] incoming, int offset, int len) throws SaslException

Implements javax.security.sasl.SaslClient.unwrap.

Unwraps the incoming buffer.

Exceptions

SaslException:: Not applicable to this mechanism.

wrap	back to summary
public byte[] wrap(byte[] outgoing, int offset, int len) throws SaslException Implements javax.security.sasl.SaslClient.wrap. Wraps the outgoing buffer. Exceptions SaslException: Not applicable to this mechanism.

wrap

back to summary

public byte[] wrap(byte[] outgoing, int offset, int len) throws SaslException

Implements javax.security.sasl.SaslClient.wrap.

Wraps the outgoing buffer.

Exceptions

SaslException:: Not applicable to this mechanism.

pack-priv final Class ExternalClient

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail