XNIO API 3.8.13.Final · org.xnio.sasl.SaslUtils · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final byte[]	EMPTY_BYTES A zero-length byte array, useful for sending and receiving empty SASL messages.

Access	Constructor and Description
private	SaslUtils()

Method Summary

Modifier and Type	Method and Description
private static <T> void	add(OptionMap optionMap, Option<T> option, Map<String, Object> map, String propName, T defaultVal)
private static void	addQopList(OptionMap optionMap, Option<Sequence<SaslQop>> option, Map<String, Object> map, String propName)
private static void	addSaslProperties(OptionMap optionMap, Option<Sequence<Property>> option, Map<String, Object> map)
public static Map<String, Object>	Returns: the property map createPropertyMap(final OptionMap the option map optionMap, final boolean `true` if the channel is secure, `false` otherwise secure) Create a SASL property map from an XNIO option map.
public static boolean	Returns: `true` if negotiation is complete and successful, `false` otherwise evaluateChallenge(SaslClient the SASL client to use to evaluate the challenge message client, ByteBuffer the destination buffer into which the response message should be written, if any destination, ByteBuffer the source buffer from which the challenge message should be read source) Evaluate a sasl challenge.
public static byte[]	Returns: `null` if negotiation is complete and successful, or the response otherwise evaluateChallenge(SaslClient the SASL client to use to evaluate the challenge message client, ByteBuffer the source buffer from which the challenge message should be read source) Evaluate a sasl challenge.
public static boolean	Returns: `true` if negotiation is complete and successful, `false` otherwise evaluateResponse(SaslServer the SASL server to use to evaluate the response message server, ByteBuffer the destination buffer into which the response message should be written, if any destination, ByteBuffer the source buffer from which the response message should be read source) Evaluate a sasl response.
public static byte[]	Returns: `true` if negotiation is complete and successful, `false` otherwise evaluateResponse(final SaslServer the SASL server to use to evaluate the response message server, final ByteBuffer the source buffer from which the response message should be read source) Evaluate a sasl response.
private static <T> Iterator<T>	getFactories(Class<T> type, ClassLoader classLoader, boolean includeGlobal)
public static Iterator<SaslClientFactory>	Returns: the `Iterator` of `SaslClientFactory`s getSaslClientFactories(ClassLoader the class loader to use classLoader, boolean `true` to include globally registered providers, `false` to exclude them includeGlobal) Returns an iterator of all of the registered `SaslClientFactory`s where the order is based on the order of the Provider registration and/or class path order.
public static Iterator<SaslClientFactory>	Returns: the `Iterator` of `SaslClientFactory`s getSaslClientFactories() Returns an iterator of all of the registered `SaslClientFactory`s where the order is based on the order of the Provider registration and/or class path order.
public static Iterator<SaslServerFactory>	Returns: the `Iterator` of `SaslServerFactory`s getSaslServerFactories(ClassLoader the class loader to use classLoader, boolean `true` to include globally registered providers, `false` to exclude them includeGlobal) Returns an iterator of all of the registered `SaslServerFactory`s where the order is based on the order of the Provider registration and/or class path order.
public static Iterator<SaslServerFactory>	Returns: the `Iterator` of `SaslServerFactory`s getSaslServerFactories() Returns an iterator of all of the registered `SaslServerFactory`s where the order is based on the order of the Provider registration and/or class path order.
public static void	unwrap(SaslClient the SASL client to unwrap with client, ByteBuffer the buffer into which bytes should be written destination, ByteBuffer the buffers from which bytes should be read source) Unwrap a message.
public static byte[]	Returns: the wrap result unwrap(final SaslClient the SASL client to unwrap with client, final ByteBuffer the buffers from which bytes should be read source) Unwrap a message.
public static void	unwrap(SaslServer the SASL server to unwrap with server, ByteBuffer the buffer into which bytes should be written destination, ByteBuffer the buffers from which bytes should be read source) Unwrap a message.
public static byte[]	Returns: the wrap result unwrap(final SaslServer the SASL server to unwrap with server, final ByteBuffer the buffers from which bytes should be read source) Unwrap a message.
public static void	wrap(SaslClient the SASL client to wrap with client, ByteBuffer the buffer into which bytes should be written destination, ByteBuffer the buffers from which bytes should be read source) Wrap a message.
public static byte[]	Returns: the wrap result wrap(final SaslClient the SASL client to wrap with client, final ByteBuffer the buffers from which bytes should be read source) Wrap a message.
public static void	wrap(SaslServer the SASL server to wrap with server, ByteBuffer the buffer into which bytes should be written destination, ByteBuffer the buffers from which bytes should be read source) Wrap a message.
public static byte[]	Returns: the wrap result wrap(final SaslServer the SASL server to wrap with server, final ByteBuffer the buffers from which bytes should be read source) Wrap a message.

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

EMPTY_BYTES	back to summary
public static final byte[] EMPTY_BYTES A zero-length byte array, useful for sending and receiving empty SASL messages.

SaslUtils	back to summary
private SaslUtils()

Method Detail

add	back to summary
private static <T> void add(OptionMap optionMap, Option<T> option, Map<String, Object> map, String propName, T defaultVal)

addQopList	back to summary
private static void addQopList(OptionMap optionMap, Option<Sequence<SaslQop>> option, Map<String, Object> map, String propName)

addSaslProperties	back to summary
private static void addSaslProperties(OptionMap optionMap, Option<Sequence<Property>> option, Map<String, Object> map)

createPropertyMap back to summary

createPropertyMap	back to summary
public static Map<String, Object> createPropertyMap(final OptionMap optionMap, final boolean secure) Create a SASL property map from an XNIO option map. Parameters optionMap:OptionMap the option map secure:boolean `true` if the channel is secure, `false` otherwise Returns:Map<String, Object> the property map

public static Map<String, Object> createPropertyMap(final OptionMap optionMap, final boolean secure)

Create a SASL property map from an XNIO option map.

Parameters

optionMap:OptionMap: the option map
secure:boolean: true if the channel is secure, false otherwise

Returns:Map<String, Object>

the property map

evaluateChallenge back to summary

evaluateChallenge	back to summary
public static boolean evaluateChallenge(SaslClient client, ByteBuffer destination, ByteBuffer source) throws SaslException Evaluate a sasl challenge. If the result is `false` then the negotiation is not yet complete and the data written into the destination buffer needs to be sent to the server as a response. If the result is `true` then negotiation was successful and no response needs to be sent to the server. The `source` buffer should have its position and remaining length set to encompass exactly one SASL message. The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed. Parameters client:SaslClient the SASL client to use to evaluate the challenge message destination:ByteBuffer the destination buffer into which the response message should be written, if any source:ByteBuffer the source buffer from which the challenge message should be read Returns:boolean `true` if negotiation is complete and successful, `false` otherwise Exceptions SaslException: if negotiation failed or another error occurred

public static boolean evaluateChallenge(SaslClient client, ByteBuffer destination, ByteBuffer source) throws SaslException

Evaluate a sasl challenge. If the result is false then the negotiation is not yet complete and the data written into the destination buffer needs to be sent to the server as a response. If the result is true then negotiation was successful and no response needs to be sent to the server.

The source buffer should have its position and remaining length set to encompass exactly one SASL message. The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed.

Parameters

client:SaslClient: the SASL client to use to evaluate the challenge message
destination:ByteBuffer: the destination buffer into which the response message should be written, if any
source:ByteBuffer: the source buffer from which the challenge message should be read

Returns:boolean

true if negotiation is complete and successful, false otherwise

Exceptions

SaslException:: if negotiation failed or another error occurred

evaluateChallenge back to summary

evaluateChallenge	back to summary
public static byte[] evaluateChallenge(SaslClient client, ByteBuffer source) throws SaslException Evaluate a sasl challenge. If the result is non-`null` then the negotiation is not yet complete and the data returned needs to be sent to the server as a response. If the result is `null` then negotiation was successful and no response needs to be sent to the server. The `source` buffer should have its position and remaining length set to encompass exactly one SASL message. The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed. Parameters client:SaslClient the SASL client to use to evaluate the challenge message source:ByteBuffer the source buffer from which the challenge message should be read Returns:byte[] `null` if negotiation is complete and successful, or the response otherwise Exceptions SaslException: if negotiation failed or another error occurred

public static byte[] evaluateChallenge(SaslClient client, ByteBuffer source) throws SaslException

Evaluate a sasl challenge. If the result is non-null then the negotiation is not yet complete and the data returned needs to be sent to the server as a response. If the result is null then negotiation was successful and no response needs to be sent to the server.

Parameters

client:SaslClient: the SASL client to use to evaluate the challenge message
source:ByteBuffer: the source buffer from which the challenge message should be read

Returns:byte[]

null if negotiation is complete and successful, or the response otherwise

Exceptions

SaslException:: if negotiation failed or another error occurred

evaluateResponse back to summary

evaluateResponse	back to summary
public static boolean evaluateResponse(SaslServer server, ByteBuffer destination, ByteBuffer source) throws SaslException Evaluate a sasl response. If the result is `false` then the negotiation is not yet complete and the data written into the destination buffer needs to be sent to the server as a response. If the result is `true` then negotiation was successful and no response needs to be sent to the client (other than a successful completion message, depending on the protocol). The `source` buffer should have its position and remaining length set to encompass exactly one SASL message. The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed. Parameters server:SaslServer the SASL server to use to evaluate the response message destination:ByteBuffer the destination buffer into which the response message should be written, if any source:ByteBuffer the source buffer from which the response message should be read Returns:boolean `true` if negotiation is complete and successful, `false` otherwise Exceptions SaslException: if negotiation failed or another error occurred

public static boolean evaluateResponse(SaslServer server, ByteBuffer destination, ByteBuffer source) throws SaslException

Evaluate a sasl response. If the result is false then the negotiation is not yet complete and the data written into the destination buffer needs to be sent to the server as a response. If the result is true then negotiation was successful and no response needs to be sent to the client (other than a successful completion message, depending on the protocol).

Parameters

server:SaslServer: the SASL server to use to evaluate the response message
destination:ByteBuffer: the destination buffer into which the response message should be written, if any
source:ByteBuffer: the source buffer from which the response message should be read

Returns:boolean

true if negotiation is complete and successful, false otherwise

Exceptions

SaslException:: if negotiation failed or another error occurred

evaluateResponse back to summary

evaluateResponse	back to summary
public static byte[] evaluateResponse(final SaslServer server, final ByteBuffer source) throws SaslException Evaluate a sasl response. If the result is non-`null` then the negotiation is not yet complete and the data returned needs to be sent to the server as a response. If the result is `null` then negotiation was successful and no response needs to be sent to the client (other than a successful completion message, depending on the protocol). The `source` buffer should have its position and remaining length set to encompass exactly one SASL message. The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed. Parameters server:SaslServer the SASL server to use to evaluate the response message source:ByteBuffer the source buffer from which the response message should be read Returns:byte[] `true` if negotiation is complete and successful, `false` otherwise Exceptions SaslException: if negotiation failed or another error occurred

public static byte[] evaluateResponse(final SaslServer server, final ByteBuffer source) throws SaslException

Evaluate a sasl response. If the result is non-null then the negotiation is not yet complete and the data returned needs to be sent to the server as a response. If the result is null then negotiation was successful and no response needs to be sent to the client (other than a successful completion message, depending on the protocol).

Parameters

server:SaslServer: the SASL server to use to evaluate the response message
source:ByteBuffer: the source buffer from which the response message should be read

Returns:byte[]

true if negotiation is complete and successful, false otherwise

Exceptions

SaslException:: if negotiation failed or another error occurred

getFactories	back to summary
private static <T> Iterator<T> getFactories(Class<T> type, ClassLoader classLoader, boolean includeGlobal)

getSaslClientFactories back to summary

getSaslClientFactories	back to summary
public static Iterator<SaslClientFactory> getSaslClientFactories(ClassLoader classLoader, boolean includeGlobal) Returns an iterator of all of the registered `SaslClientFactory`s where the order is based on the order of the Provider registration and/or class path order. Class path providers are listed before global providers; in the event of a name conflict, the class path provider is preferred. Parameters classLoader:ClassLoader the class loader to use includeGlobal:boolean `true` to include globally registered providers, `false` to exclude them Returns:Iterator<SaslClientFactory> the `Iterator` of `SaslClientFactory`s

public static Iterator<SaslClientFactory> getSaslClientFactories(ClassLoader classLoader, boolean includeGlobal)

Returns an iterator of all of the registered SaslClientFactorys where the order is based on the order of the Provider registration and/or class path order. Class path providers are listed before global providers; in the event of a name conflict, the class path provider is preferred.

Parameters

classLoader:ClassLoader: the class loader to use
includeGlobal:boolean: true to include globally registered providers, false to exclude them

Returns:Iterator<SaslClientFactory>

the Iterator of SaslClientFactorys

getSaslClientFactories back to summary

getSaslClientFactories	back to summary
public static Iterator<SaslClientFactory> getSaslClientFactories() Returns an iterator of all of the registered `SaslClientFactory`s where the order is based on the order of the Provider registration and/or class path order. Returns:Iterator<SaslClientFactory> the `Iterator` of `SaslClientFactory`s

public static Iterator<SaslClientFactory> getSaslClientFactories()

Returns an iterator of all of the registered SaslClientFactorys where the order is based on the order of the Provider registration and/or class path order.

Returns:Iterator<SaslClientFactory>: the Iterator of SaslClientFactorys

getSaslServerFactories back to summary

getSaslServerFactories	back to summary
public static Iterator<SaslServerFactory> getSaslServerFactories(ClassLoader classLoader, boolean includeGlobal) Returns an iterator of all of the registered `SaslServerFactory`s where the order is based on the order of the Provider registration and/or class path order. Class path providers are listed before global providers; in the event of a name conflict, the class path provider is preferred. Parameters classLoader:ClassLoader the class loader to use includeGlobal:boolean `true` to include globally registered providers, `false` to exclude them Returns:Iterator<SaslServerFactory> the `Iterator` of `SaslServerFactory`s

public static Iterator<SaslServerFactory> getSaslServerFactories(ClassLoader classLoader, boolean includeGlobal)

Returns an iterator of all of the registered SaslServerFactorys where the order is based on the order of the Provider registration and/or class path order. Class path providers are listed before global providers; in the event of a name conflict, the class path provider is preferred.

Parameters

classLoader:ClassLoader: the class loader to use
includeGlobal:boolean: true to include globally registered providers, false to exclude them

Returns:Iterator<SaslServerFactory>

the Iterator of SaslServerFactorys

getSaslServerFactories back to summary

getSaslServerFactories	back to summary
public static Iterator<SaslServerFactory> getSaslServerFactories() Returns an iterator of all of the registered `SaslServerFactory`s where the order is based on the order of the Provider registration and/or class path order. Returns:Iterator<SaslServerFactory> the `Iterator` of `SaslServerFactory`s

public static Iterator<SaslServerFactory> getSaslServerFactories()

Returns an iterator of all of the registered SaslServerFactorys where the order is based on the order of the Provider registration and/or class path order.

Returns:Iterator<SaslServerFactory>: the Iterator of SaslServerFactorys

unwrap back to summary

unwrap	back to summary
public static void unwrap(SaslClient client, ByteBuffer destination, ByteBuffer source) throws SaslException Unwrap a message. Unwrapping occurs from the source buffer to the destination idea. The `source` buffer should have its position and remaining length set to encompass exactly one SASL message (without the length field). The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed. Parameters client:SaslClient the SASL client to unwrap with destination:ByteBuffer the buffer into which bytes should be written source:ByteBuffer the buffers from which bytes should be read Exceptions SaslException: if a SASL error occurs See Also `SaslClient#unwrap(byte[], int, int)`

public static void unwrap(SaslClient client, ByteBuffer destination, ByteBuffer source) throws SaslException

Unwrap a message. Unwrapping occurs from the source buffer to the destination idea.

The source buffer should have its position and remaining length set to encompass exactly one SASL message (without the length field). The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed.

Parameters

client:SaslClient: the SASL client to unwrap with
destination:ByteBuffer: the buffer into which bytes should be written
source:ByteBuffer: the buffers from which bytes should be read

Exceptions

SaslException:: if a SASL error occurs

See Also

SaslClient#unwrap(byte[], int, int)

unwrap back to summary

unwrap	back to summary
public static byte[] unwrap(final SaslClient client, final ByteBuffer source) throws SaslException Unwrap a message. Unwrapping occurs from the source buffer to the destination idea. The `source` buffer should have its position and remaining length set to encompass exactly one SASL message (without the length field). The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed. Parameters client:SaslClient the SASL client to unwrap with source:ByteBuffer the buffers from which bytes should be read Returns:byte[] the wrap result Exceptions SaslException: if a SASL error occurs See Also `SaslClient#unwrap(byte[], int, int)`

public static byte[] unwrap(final SaslClient client, final ByteBuffer source) throws SaslException

Unwrap a message. Unwrapping occurs from the source buffer to the destination idea.

Parameters

client:SaslClient: the SASL client to unwrap with
source:ByteBuffer: the buffers from which bytes should be read

Returns:byte[]

the wrap result

Exceptions

SaslException:: if a SASL error occurs

See Also

SaslClient#unwrap(byte[], int, int)

unwrap back to summary

unwrap	back to summary
public static void unwrap(SaslServer server, ByteBuffer destination, ByteBuffer source) throws SaslException Unwrap a message. Unwrapping occurs from the source buffer to the destination idea. The `source` buffer should have its position and remaining length set to encompass exactly one SASL message (without the length field). The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed. Parameters server:SaslServer the SASL server to unwrap with destination:ByteBuffer the buffer into which bytes should be written source:ByteBuffer the buffers from which bytes should be read Exceptions SaslException: if a SASL error occurs See Also `SaslServer#unwrap(byte[], int, int)`

public static void unwrap(SaslServer server, ByteBuffer destination, ByteBuffer source) throws SaslException

Unwrap a message. Unwrapping occurs from the source buffer to the destination idea.

Parameters

server:SaslServer: the SASL server to unwrap with
destination:ByteBuffer: the buffer into which bytes should be written
source:ByteBuffer: the buffers from which bytes should be read

Exceptions

SaslException:: if a SASL error occurs

See Also

SaslServer#unwrap(byte[], int, int)

unwrap back to summary

unwrap	back to summary
public static byte[] unwrap(final SaslServer server, final ByteBuffer source) throws SaslException Unwrap a message. Unwrapping occurs from the source buffer to the destination idea. The `source` buffer should have its position and remaining length set to encompass exactly one SASL message (without the length field). The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed. Parameters server:SaslServer the SASL server to unwrap with source:ByteBuffer the buffers from which bytes should be read Returns:byte[] the wrap result Exceptions SaslException: if a SASL error occurs See Also `SaslServer#unwrap(byte[], int, int)`

public static byte[] unwrap(final SaslServer server, final ByteBuffer source) throws SaslException

Unwrap a message. Unwrapping occurs from the source buffer to the destination idea.

Parameters

server:SaslServer: the SASL server to unwrap with
source:ByteBuffer: the buffers from which bytes should be read

Returns:byte[]

the wrap result

Exceptions

SaslException:: if a SASL error occurs

See Also

SaslServer#unwrap(byte[], int, int)

wrap back to summary

wrap	back to summary
public static void wrap(SaslClient client, ByteBuffer destination, ByteBuffer source) throws SaslException Wrap a message. Wrapping occurs from the source buffer to the destination idea. The `source` buffer should have its position and remaining length set to encompass exactly one SASL message (without the length field). The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed. Parameters client:SaslClient the SASL client to wrap with destination:ByteBuffer the buffer into which bytes should be written source:ByteBuffer the buffers from which bytes should be read Exceptions SaslException: if a SASL error occurs See Also `SaslClient#wrap(byte[], int, int)`

public static void wrap(SaslClient client, ByteBuffer destination, ByteBuffer source) throws SaslException

Wrap a message. Wrapping occurs from the source buffer to the destination idea.

Parameters

client:SaslClient: the SASL client to wrap with
destination:ByteBuffer: the buffer into which bytes should be written
source:ByteBuffer: the buffers from which bytes should be read

Exceptions

SaslException:: if a SASL error occurs

See Also

SaslClient#wrap(byte[], int, int)

wrap back to summary

wrap	back to summary
public static byte[] wrap(final SaslClient client, final ByteBuffer source) throws SaslException Wrap a message. Wrapping occurs from the source buffer to the destination idea. The `source` buffer should have its position and remaining length set to encompass exactly one SASL message (without the length field). The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed. Parameters client:SaslClient the SASL client to wrap with source:ByteBuffer the buffers from which bytes should be read Returns:byte[] the wrap result Exceptions SaslException: if a SASL error occurs See Also `SaslClient#wrap(byte[], int, int)`

public static byte[] wrap(final SaslClient client, final ByteBuffer source) throws SaslException

Wrap a message. Wrapping occurs from the source buffer to the destination idea.

Parameters

client:SaslClient: the SASL client to wrap with
source:ByteBuffer: the buffers from which bytes should be read

Returns:byte[]

the wrap result

Exceptions

SaslException:: if a SASL error occurs

See Also

SaslClient#wrap(byte[], int, int)

wrap back to summary

wrap	back to summary
public static void wrap(SaslServer server, ByteBuffer destination, ByteBuffer source) throws SaslException Wrap a message. Wrapping occurs from the source buffer to the destination idea. The `source` buffer should have its position and remaining length set to encompass exactly one SASL message (without the length field). The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed. Parameters server:SaslServer the SASL server to wrap with destination:ByteBuffer the buffer into which bytes should be written source:ByteBuffer the buffers from which bytes should be read Exceptions SaslException: if a SASL error occurs See Also `SaslServer#wrap(byte[], int, int)`

public static void wrap(SaslServer server, ByteBuffer destination, ByteBuffer source) throws SaslException

Wrap a message. Wrapping occurs from the source buffer to the destination idea.

Parameters

server:SaslServer: the SASL server to wrap with
destination:ByteBuffer: the buffer into which bytes should be written
source:ByteBuffer: the buffers from which bytes should be read

Exceptions

SaslException:: if a SASL error occurs

See Also

SaslServer#wrap(byte[], int, int)

wrap back to summary

wrap	back to summary
public static byte[] wrap(final SaslServer server, final ByteBuffer source) throws SaslException Wrap a message. Wrapping occurs from the source buffer to the destination idea. The `source` buffer should have its position and remaining length set to encompass exactly one SASL message (without the length field). The SASL message itself does not encode any length information so it is up to the protocol implementer to ensure that the message is properly framed. Parameters server:SaslServer the SASL server to wrap with source:ByteBuffer the buffers from which bytes should be read Returns:byte[] the wrap result Exceptions SaslException: if a SASL error occurs See Also `SaslServer#wrap(byte[], int, int)`

public static byte[] wrap(final SaslServer server, final ByteBuffer source) throws SaslException

Wrap a message. Wrapping occurs from the source buffer to the destination idea.

Parameters

server:SaslServer: the SASL server to wrap with
source:ByteBuffer: the buffers from which bytes should be read

Returns:byte[]

the wrap result

Exceptions

SaslException:: if a SASL error occurs

See Also

SaslServer#wrap(byte[], int, int)

public final Class SaslUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail