org.apache.directory.server.config.beans

Class InterceptorBean

java.lang.Object

org.apache.directory.server.config.beans.AdsBaseBean

org.apache.directory.server.config.beans.InterceptorBean

All Implemented Interfaces:

java.lang.Comparable<InterceptorBean>

Direct Known Subclasses:

AuthenticationInterceptorBean, HashInterceptorBean

public class InterceptorBean
extends AdsBaseBean
implements java.lang.Comparable<InterceptorBean>

A class used to store the Interceptors configuration.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	interceptorClassName The interceptor FQCN
private java.lang.String	interceptorId The Interceptor ID
private int	interceptorOrder The interceptor position in the chain

Constructor Summary

Constructors

Constructor and Description
InterceptorBean() Creates a new InterceptorBean

Method Summary

Modifier and Type	Method and Description
int	compareTo(InterceptorBean o) Compares the order of the interceptor with the given one
java.lang.String	getInterceptorClassName()
java.lang.String	getInterceptorId()
int	getInterceptorOrder()
void	setInterceptorClassName(java.lang.String interceptorClassName)
void	setInterceptorId(java.lang.String id)
void	setInterceptorOrder(int interceptorOrder)
java.lang.String	toString()
java.lang.String	toString(java.lang.String tabs)

Methods inherited from class org.apache.directory.server.config.beans.AdsBaseBean

getDescription, getDn, isDisabled, isEnabled, setDescription, setDn, setEnabled, toString, toString, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

interceptorId

@ConfigurationElement(attributeType="ads-interceptorId",
                      isRdn=true)
private java.lang.String interceptorId

The Interceptor ID

interceptorClassName

@ConfigurationElement(attributeType="ads-interceptorClassName")
private java.lang.String interceptorClassName

The interceptor FQCN

interceptorOrder

@ConfigurationElement(attributeType="ads-interceptorOrder")
private int interceptorOrder

The interceptor position in the chain

Constructor Detail

InterceptorBean

public InterceptorBean()

Creates a new InterceptorBean

Method Detail

compareTo

public int compareTo(InterceptorBean o)

Compares the order of the interceptor with the given one

Specified by:

compareTo in interface java.lang.Comparable<InterceptorBean>

Parameters:

o - An interceptor

Returns:

-1 if the current interceptor is below the given one, 1 if it's above, 0 if it's equal

getInterceptorId

public java.lang.String getInterceptorId()

Returns:

the id

setInterceptorId

public void setInterceptorId(java.lang.String id)

Parameters:

id - the id to set

getInterceptorOrder

public int getInterceptorOrder()

Returns:

the interceptor Order

setInterceptorOrder

public void setInterceptorOrder(int interceptorOrder)

Parameters:

interceptorOrder - the interceptor Order to set

getInterceptorClassName

public java.lang.String getInterceptorClassName()

Returns:

the interceptor ClassName

setInterceptorClassName

public void setInterceptorClassName(java.lang.String interceptorClassName)

Parameters:

interceptorClassName - the interceptor ClassName to set

toString

public java.lang.String toString(java.lang.String tabs)

Overrides:

toString in class AdsBaseBean

toString

public java.lang.String toString()

Overrides:

toString in class AdsBaseBean