org.apache.directory.server.ldap.handlers.sasl

Class SaslFilter

java.lang.Object

org.apache.mina.core.filterchain.IoFilterAdapter

org.apache.directory.server.ldap.handlers.sasl.SaslFilter

All Implemented Interfaces:

org.apache.mina.core.filterchain.IoFilter

public class SaslFilter
extends org.apache.mina.core.filterchain.IoFilterAdapter

An IoFilterAdapter that handles integrity and confidentiality protection for a SASL bound session. The SaslFilter must be constructed with a SASL context that has completed SASL negotiation. Some SASL mechanisms, such as CRAM-MD5, only support authentication and thus do not need this filter. DIGEST-MD5 and GSSAPI do support message integrity and confidentiality and, therefore, do need this filter.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.mina.core.filterchain.IoFilter

org.apache.mina.core.filterchain.IoFilter.NextFilter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DISABLE_SECURITY_LAYER_ONCE A session attribute key that makes next one write request bypass this filter (not adding a security layer).
private static org.slf4j.Logger	LOG
private javax.security.sasl.SaslServer	saslServer

Constructor Summary

Constructors

Constructor and Description
SaslFilter(javax.security.sasl.SaslServer saslServer) Creates a new instance of SaslFilter.

Method Summary

Modifier and Type	Method and Description
void	filterWrite(org.apache.mina.core.filterchain.IoFilter.NextFilter nextFilter, org.apache.mina.core.session.IoSession session, org.apache.mina.core.write.WriteRequest writeRequest)
void	messageReceived(org.apache.mina.core.filterchain.IoFilter.NextFilter nextFilter, org.apache.mina.core.session.IoSession session, java.lang.Object message)

Methods inherited from class org.apache.mina.core.filterchain.IoFilterAdapter

destroy, exceptionCaught, filterClose, init, inputClosed, messageSent, onPostAdd, onPostRemove, onPreAdd, onPreRemove, sessionClosed, sessionCreated, sessionIdle, sessionOpened, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LOG

private static final org.slf4j.Logger LOG

DISABLE_SECURITY_LAYER_ONCE

public static final java.lang.String DISABLE_SECURITY_LAYER_ONCE

A session attribute key that makes next one write request bypass this filter (not adding a security layer). This is a marker attribute, which means that you can put whatever as its value. (Boolean.TRUE is preferred.) The attribute is automatically removed from the session attribute map as soon as IoSession.write(Object) is invoked, and therefore should be put again if you want to make more messages bypass this filter.

saslServer

private javax.security.sasl.SaslServer saslServer

Constructor Detail

SaslFilter

public SaslFilter(javax.security.sasl.SaslServer saslServer)

Creates a new instance of SaslFilter. The SaslFilter must be constructed with a SASL context that has completed SASL negotiation. The SASL context will be used to provide message integrity and, optionally, message confidentiality.

Parameters:

saslServer - The initialized SASL context.

Method Detail

messageReceived

public void messageReceived(org.apache.mina.core.filterchain.IoFilter.NextFilter nextFilter,
                            org.apache.mina.core.session.IoSession session,
                            java.lang.Object message)
                     throws javax.security.sasl.SaslException

Specified by:

messageReceived in interface org.apache.mina.core.filterchain.IoFilter

Overrides:

messageReceived in class org.apache.mina.core.filterchain.IoFilterAdapter

Throws:

javax.security.sasl.SaslException

filterWrite

public void filterWrite(org.apache.mina.core.filterchain.IoFilter.NextFilter nextFilter,
                        org.apache.mina.core.session.IoSession session,
                        org.apache.mina.core.write.WriteRequest writeRequest)
                 throws javax.security.sasl.SaslException

Specified by:

filterWrite in interface org.apache.mina.core.filterchain.IoFilter

Overrides:

filterWrite in class org.apache.mina.core.filterchain.IoFilterAdapter

Throws:

javax.security.sasl.SaslException