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

Access	Constructor and Description
public	SaslWrapper()

Method Summary

Modifier and Type	Method and Description
public static SaslWrapper	Returns: the wrapper create(SaslClient the SASL client saslClient) Create a SASL wrapper for a SASL client.
public static SaslWrapper	Returns: the wrapper create(SaslServer the SASL server saslServer) Create a SASL wrapper for a SASL server.
public abstract byte[]	Returns: the unwrap result unwrap(byte[] the incoming message bytes, int the offset into the byte array off, int the length of the byte array to wrap len) Unwrap a message.
public final byte[]	Returns: the unwrap result unwrap(byte[] the incoming message bytes) Unwrap a message.
public abstract byte[]	Returns: the unwrap result unwrap(ByteBuffer the buffer from which bytes should be read source) Unwrap a message.
public final void	unwrap(ByteBuffer the buffer into which bytes should be written destination, ByteBuffer the buffers from which bytes should be read source) Unwrap a message.
public abstract byte[]	Returns: the wrap result wrap(byte[] the incoming message bytes, int the offset into the byte array off, int the length of the byte array to wrap len) Wrap a message.
public final byte[]	Returns: the wrap result wrap(byte[] the incoming message bytes) Wrap a message.
public abstract byte[]	Returns: the wrap result wrap(ByteBuffer the buffer from which bytes should be read source) Wrap a message.
public final void	wrap(ByteBuffer the buffer into which bytes should be written destination, 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

SaslWrapper	back to summary
public SaslWrapper()

Method Detail

create	back to summary
public static SaslWrapper create(SaslClient saslClient) Create a SASL wrapper for a SASL client. Parameters saslClient:SaslClient the SASL client Returns:SaslWrapper the wrapper

create

back to summary

public static SaslWrapper create(SaslClient saslClient)

Create a SASL wrapper for a SASL client.

Parameters

saslClient:SaslClient: the SASL client

Returns:SaslWrapper

the wrapper

create	back to summary
public static SaslWrapper create(SaslServer saslServer) Create a SASL wrapper for a SASL server. Parameters saslServer:SaslServer the SASL server Returns:SaslWrapper the wrapper

create

back to summary

public static SaslWrapper create(SaslServer saslServer)

Create a SASL wrapper for a SASL server.

Parameters

saslServer:SaslServer: the SASL server

Returns:SaslWrapper

the wrapper

unwrap	back to summary
public abstract byte[] unwrap(byte[] bytes, int off, int len) throws SaslException Unwrap a message. Parameters bytes:byte[] the incoming message off:int the offset into the byte array len:int the length of the byte array to wrap Returns:byte[] the unwrap result Exceptions SaslException: if a problem occurs

unwrap

back to summary

public abstract byte[] unwrap(byte[] bytes, int off, int len) throws SaslException

Unwrap a message.

Parameters

bytes:byte[]: the incoming message
off:int: the offset into the byte array
len:int: the length of the byte array to wrap

Returns:byte[]

the unwrap result

Exceptions

SaslException:: if a problem occurs

unwrap	back to summary
public final byte[] unwrap(byte[] bytes) throws SaslException Unwrap a message. Parameters bytes:byte[] the incoming message Returns:byte[] the unwrap result Exceptions SaslException: if a problem occurs

unwrap

back to summary

public final byte[] unwrap(byte[] bytes) throws SaslException

Unwrap a message.

Parameters

bytes:byte[]: the incoming message

Returns:byte[]

the unwrap result

Exceptions

SaslException:: if a problem occurs

unwrap	back to summary
public abstract byte[] unwrap(ByteBuffer source) throws SaslException Unwrap a message. Parameters source:ByteBuffer the buffer from which bytes should be read Returns:byte[] the unwrap result Exceptions SaslException: if a problem occurs

unwrap

back to summary

public abstract byte[] unwrap(ByteBuffer source) throws SaslException

Unwrap a message.

Parameters

source:ByteBuffer: the buffer from which bytes should be read

Returns:byte[]

the unwrap result

Exceptions

SaslException:: if a problem occurs

unwrap back to summary

unwrap	back to summary
public final void unwrap(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 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 final void unwrap(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

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)

wrap	back to summary
public abstract byte[] wrap(byte[] bytes, int off, int len) throws SaslException Wrap a message. Parameters bytes:byte[] the incoming message off:int the offset into the byte array len:int the length of the byte array to wrap Returns:byte[] the wrap result Exceptions SaslException: if a problem occurs

wrap

back to summary

public abstract byte[] wrap(byte[] bytes, int off, int len) throws SaslException

Wrap a message.

Parameters

bytes:byte[]: the incoming message
off:int: the offset into the byte array
len:int: the length of the byte array to wrap

Returns:byte[]

the wrap result

Exceptions

SaslException:: if a problem occurs

wrap	back to summary
public final byte[] wrap(byte[] bytes) throws SaslException Wrap a message. Parameters bytes:byte[] the incoming message Returns:byte[] the wrap result Exceptions SaslException: if a problem occurs

wrap

back to summary

public final byte[] wrap(byte[] bytes) throws SaslException

Wrap a message.

Parameters

bytes:byte[]: the incoming message

Returns:byte[]

the wrap result

Exceptions

SaslException:: if a problem occurs

wrap	back to summary
public abstract byte[] wrap(ByteBuffer source) throws SaslException Wrap a message. Parameters source:ByteBuffer the buffer from which bytes should be read Returns:byte[] the wrap result Exceptions SaslException: if a problem occurs

wrap

back to summary

public abstract byte[] wrap(ByteBuffer source) throws SaslException

Wrap a message.

Parameters

source:ByteBuffer: the buffer from which bytes should be read

Returns:byte[]

the wrap result

Exceptions

SaslException:: if a problem occurs

wrap back to summary

wrap	back to summary
public final void wrap(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 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)`, `SaslServer#wrap(byte[], int, int)`

public final void wrap(ByteBuffer destination, ByteBuffer source) throws SaslException

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

Parameters

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

public abstract Class SaslWrapper

Constructor Summary

Method Summary

Constructor Detail

Method Detail