Package com.isode.dsapi.util.data
Class DataNodeDSAPIReader
java.lang.Object
com.isode.util.data.DataReader
com.isode.util.data.DataNodeReader
com.isode.dsapi.util.data.DataNodeDSAPIReader
public class DataNodeDSAPIReader
extends com.isode.util.data.DataNodeReader
DataNodeDSAPIReader allows to read other than String data types
(especially DS API related data types) from DataNode.
- Since:
- 16.0
- Author:
- mst
-
Constructor Summary
ConstructorsConstructorDescriptionDataNodeDSAPIReader
(com.isode.util.data.DataNode node) Constructs a DataNodeDSAPIReader -
Method Summary
Modifier and TypeMethodDescriptionReturns single DN associated with given name.Returns single DN associated with given name.Returns all DNs associated with given name.Returns all DNs associated with given name.getLDAPFilter
(String name, String defValue) Returns single LDAP filter associated with given name.getLDAPFilterList
(String name, String... defValues) Returns all LDAP filters associated with given name.Methods inherited from class com.isode.util.data.DataNodeReader
getNode
Methods inherited from class com.isode.util.data.DataReader
addListener, decode, getBoolean, getBoolean, getBoolean, getInteger, getInteger, getInteger, getInteger, getLong, getLong, getString, getString, getString, getStringList, getValue, getValues, notifyRead, removeListener
-
Constructor Details
-
DataNodeDSAPIReader
public DataNodeDSAPIReader(com.isode.util.data.DataNode node) Constructs a DataNodeDSAPIReader- Parameters:
node
- (null
allowed)
-
-
Method Details
-
getDN
public DN getDN(String name, String description, DN defValue) throws com.isode.util.data.DataAccessException, com.isode.util.data.DataBadArgumentException, com.isode.util.data.DataBadValueException, com.isode.util.data.DataCodecException, com.isode.util.data.DataMultipleValueException Returns single DN associated with given name.- Parameters:
name
- (notnull
)description
- used in place of name in error reports and notifications (null
allowed - than name will be used)defValue
- default value returned when there is no value associated (null
allowed)- Returns:
- single DN
(may be
null
if defValue isnull
or defined value is empty) - Throws:
com.isode.util.data.DataAccessException
- on access problemscom.isode.util.data.DataBadArgumentException
- on bad namecom.isode.util.data.DataBadValueException
- on unexpected/bad valuecom.isode.util.data.DataCodecException
- on decoding problemscom.isode.util.data.DataMultipleValueException
- when multiple values found
-
getDN
public DN getDN(String name, DN defValue) throws com.isode.util.data.DataAccessException, com.isode.util.data.DataBadArgumentException, com.isode.util.data.DataBadValueException, com.isode.util.data.DataCodecException, com.isode.util.data.DataMultipleValueException Returns single DN associated with given name.- Parameters:
name
- (notnull
)defValue
- default value returned when there is no value associated (null
allowed)- Returns:
- single DN
(may be
null
if defValue isnull
or defined value is empty) - Throws:
com.isode.util.data.DataAccessException
- on access problemscom.isode.util.data.DataBadArgumentException
- on bad namecom.isode.util.data.DataBadValueException
- on unexpected/bad valuecom.isode.util.data.DataCodecException
- on decoding problemscom.isode.util.data.DataMultipleValueException
- when multiple values found
-
getDNList
public List<DN> getDNList(String name, String description, DN... defValues) throws com.isode.util.data.DataAccessException, com.isode.util.data.DataBadArgumentException, com.isode.util.data.DataBadValueException, com.isode.util.data.DataCodecException, com.isode.util.data.DataMultipleValueException Returns all DNs associated with given name.- Parameters:
name
- (notnull
)description
- used in place of name in error reports and notifications (null
allowed - than name will be used)defValues
- default values returned when there is no other values associated (null
allowed)- Returns:
- values list (not
null
but list may be empty or may containnull
values) - Throws:
com.isode.util.data.DataAccessException
- on access problemscom.isode.util.data.DataBadArgumentException
- on bad namecom.isode.util.data.DataBadValueException
- on unexpected/bad valuecom.isode.util.data.DataCodecException
- on decoding problemscom.isode.util.data.DataMultipleValueException
- when multiple values found
-
getDNList
public List<DN> getDNList(String name, DN... defValues) throws com.isode.util.data.DataAccessException, com.isode.util.data.DataBadArgumentException, com.isode.util.data.DataBadValueException, com.isode.util.data.DataCodecException, com.isode.util.data.DataMultipleValueException Returns all DNs associated with given name.- Parameters:
name
- (notnull
)defValues
- default values returned when there is no other values associated (null
allowed)- Returns:
- values list (not
null
but list may be empty or may containnull
values) - Throws:
com.isode.util.data.DataAccessException
- on access problemscom.isode.util.data.DataBadArgumentException
- on bad namecom.isode.util.data.DataBadValueException
- on unexpected/bad valuecom.isode.util.data.DataCodecException
- on decoding problemscom.isode.util.data.DataMultipleValueException
- when multiple values found
-
getLDAPFilterList
public List<String> getLDAPFilterList(String name, String... defValues) throws com.isode.util.data.DataAccessException, com.isode.util.data.DataBadArgumentException, com.isode.util.data.DataBadValueException, com.isode.util.data.DataCodecException Returns all LDAP filters associated with given name. If there are no values defined returns defValues.- Parameters:
name
- (notnull
)defValues
- (null
allowed - ignored)- Returns:
- values list (not
null
but list may be empty or may containnull
values) - Throws:
com.isode.util.data.DataAccessException
- on access problemscom.isode.util.data.DataBadArgumentException
- on bad namecom.isode.util.data.DataBadValueException
- on unexpected/bad valuecom.isode.util.data.DataCodecException
- on decoding problems- Since:
- 16.2
-
getLDAPFilter
public String getLDAPFilter(String name, String defValue) throws com.isode.util.data.DataAccessException, com.isode.util.data.DataBadArgumentException, com.isode.util.data.DataBadValueException, com.isode.util.data.DataCodecException, com.isode.util.data.DataMultipleValueException Returns single LDAP filter associated with given name.- Parameters:
name
- (notnull
)defValue
- default value returned when there is no value associated (null
allowed)- Returns:
- single LDAP filter
(may be
null
if defValue isnull
or defined value is empty) - Throws:
com.isode.util.data.DataAccessException
- on access problemscom.isode.util.data.DataBadArgumentException
- on bad namecom.isode.util.data.DataBadValueException
- on unexpected/bad valuecom.isode.util.data.DataCodecException
- on decoding problemscom.isode.util.data.DataMultipleValueException
- when multiple values found- Since:
- 16.2
-