|
Sun Adapter for LDAP API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.stc.connector.ldapadapter.appconn.LDAPSearchControlsImpl
public class LDAPSearchControlsImpl
This class is used to set the controls to be used while executing a search operation. Currently only SortControl & PagedResultsControl are supported.
Constructor Summary | |
---|---|
protected |
LDAPSearchControlsImpl(LDAPClientApplicationImpl app)
Creates a new instance of LDAPSearchControls |
Method Summary | |
---|---|
java.util.HashMap |
getControls()
Method to retrieve the Controls set |
boolean |
getPageControlCriticality()
Method to retrieve the criticality set for the PagedResultsControl |
int |
getPageSize()
Method to retrieve the page size set for the search operation |
java.lang.String |
getSortAttributes()
Method to retrieve the list of attributes based on which the result is to be sorted |
boolean |
getSortControlCriticality()
Method to retrieve the criticality set for the SortControl |
static byte[] |
parseControls(javax.naming.ldap.Control[] controls)
|
void |
removePagedResultsControl()
Method to remove the PagedResultsControl from the context |
void |
removeSortControl()
Method to remove the SortControl from the context |
void |
reset()
Method to reset the values |
void |
setPageControlCriticality(boolean pageControlCriticality)
Method to set the criticality for the PagedResultsControl. |
void |
setPagedResultsControl()
Method to set the PagedResultsControl to the context. |
void |
setPageSize(int pageSize)
Method to set the page size for the search operation |
void |
setSortAttributes(java.lang.String sortAttributes)
Method to set the list of attributes based on which the result is to be sorted |
void |
setSortControl()
Method to set the SortControl to the context. |
void |
setSortControlCriticality(boolean sortControlCriticality)
Method to set the criticality for the SortControl. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected LDAPSearchControlsImpl(LDAPClientApplicationImpl app)
app
- The LDAP client application associated with this LDAPSearchControls
instance.Method Detail |
---|
public void reset()
LDAPSearchControls
reset
in interface LDAPSearchControls
public java.lang.String getSortAttributes() throws LDAPApplicationException
getSortAttributes
in interface LDAPSearchControls
LDAPApplicationException
- if there is no connection is available to the LDAP server.public void setSortAttributes(java.lang.String sortAttributes) throws LDAPApplicationException
setSortAttributes
in interface LDAPSearchControls
a
- String that contains the list of attributes delimited by '|' symbol.
LDAPApplicationException
- if there is no connection is available to the LDAP server.public boolean getSortControlCriticality() throws LDAPApplicationException
getSortControlCriticality
in interface LDAPSearchControls
LDAPApplicationException
- if there is no connection is available to the LDAP server.public void setSortControlCriticality(boolean sortControlCriticality) throws LDAPApplicationException
setSortControlCriticality
in interface LDAPSearchControls
true
- for setting the SortControl as CRITICAL
LDAPApplicationException
- if there is no connection is available to the LDAP server.public int getPageSize() throws LDAPApplicationException
getPageSize
in interface LDAPSearchControls
LDAPApplicationException
- if there is no connection is available to the LDAP server.public void setPageSize(int pageSize) throws LDAPApplicationException
setPageSize
in interface LDAPSearchControls
an
- integer value representing the page size
LDAPApplicationException
- if there is no connection is available to the LDAP server.public boolean getPageControlCriticality() throws LDAPApplicationException
getPageControlCriticality
in interface LDAPSearchControls
LDAPApplicationException
- if there is no connection is available to the LDAP server.public void setPageControlCriticality(boolean pageControlCriticality) throws LDAPApplicationException
setPageControlCriticality
in interface LDAPSearchControls
true
- for setting the PagedResultsControl as CRITICAL
LDAPApplicationException
- if there is no connection is available to the LDAP server.public void setSortControl() throws LDAPApplicationException
LDAPApplicationException
- if there is no connection is available to the LDAP server.public void setPagedResultsControl() throws LDAPApplicationException
LDAPApplicationException
- if there is no connection is available to the LDAP server.public void removeSortControl() throws LDAPApplicationException
removeSortControl
in interface LDAPSearchControls
LDAPApplicationException
- if there is no connection is available to the LDAP server.public void removePagedResultsControl() throws LDAPApplicationException
removePagedResultsControl
in interface LDAPSearchControls
LDAPApplicationException
- if there is no connection is available to the LDAP server.public java.util.HashMap getControls() throws LDAPApplicationException
getControls
in interface LDAPSearchControls
LDAPApplicationException
- if there is no connection is available to the LDAP server.public static byte[] parseControls(javax.naming.ldap.Control[] controls) throws javax.naming.NamingException
javax.naming.NamingException
|
Sun Adapter for LDAP API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |