public class

LDAPSearchControls

extends Object
implements Serializable
java.lang.Object
   ↳ org.mule.module.ldap.api.LDAPSearchControls

Class Overview

This class is the abstraction

Summary

Constants
int OBJECT_SCOPE
int ONELEVEL_SCOPE
int SUBTREE_SCOPE
long serialVersionUID
Fields
private String[] attributesToReturn Attributes to be returned for each entry.
private long maxResults Maximun amount of entries to return (0 is no limit)
private String orderBy Order by attribute name
private int pageSize Page size to retrieve results from LDAP
private boolean returnObject
private int scope
private int timeout Timeout in millisecons.
Public Constructors
LDAPSearchControls()
Public Methods
String[] getAttributesToReturn()
long getMaxResults()
String getOrderBy()
int getPageSize()
int getScope()
int getTimeout()
boolean isOrderBySet()
boolean isPagingEnabled()
boolean isReturnObject()
void setAttributesToReturn(String[] attributesToReturn)
void setMaxResults(long maxResults)
void setOrderBy(String orderBy)
void setPageSize(int pageSize)
void setReturnObject(boolean returnObject)
void setScope(int scope)
void setTimeout(int timeout)
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int OBJECT_SCOPE

Constant Value: 0 (0x00000000)

public static final int ONELEVEL_SCOPE

Constant Value: 1 (0x00000001)

public static final int SUBTREE_SCOPE

Constant Value: 2 (0x00000002)

private static final long serialVersionUID

Constant Value: -5307515256650204659 (0xb657eafe9765fa0d)

Fields

private String[] attributesToReturn

Attributes to be returned for each entry. (null means all)

private long maxResults

Maximun amount of entries to return (0 is no limit)

private String orderBy

Order by attribute name

private int pageSize

Page size to retrieve results from LDAP

private boolean returnObject

private int scope

private int timeout

Timeout in millisecons. (0 is no limit)

Public Constructors

public LDAPSearchControls ()

Public Methods

public String[] getAttributesToReturn ()

Returns
  • Returns the attributesToReturn.

public long getMaxResults ()

Returns
  • Returns the maxResults.

public String getOrderBy ()

public int getPageSize ()

public int getScope ()

Returns
  • Returns the scope.

public int getTimeout ()

Returns
  • Returns the timeout.

public boolean isOrderBySet ()

public boolean isPagingEnabled ()

public boolean isReturnObject ()

Returns
  • Returns the returnObject.

public void setAttributesToReturn (String[] attributesToReturn)

Parameters
attributesToReturn The attributesToReturn to set.

public void setMaxResults (long maxResults)

Parameters
maxResults The maxResults to set.

public void setOrderBy (String orderBy)

Parameters
orderBy

public void setPageSize (int pageSize)

Parameters
pageSize

public void setReturnObject (boolean returnObject)

Parameters
returnObject The returnObject to set.

public void setScope (int scope)

Parameters
scope The scope to set.

public void setTimeout (int timeout)

Parameters
timeout The timeout to set.