InterceptParam (Radiant Logic, Inc.)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable<java.lang.Object,java.lang.Object>
  - - java.util.Properties
    - - com.rli.vds.util.InterceptParam

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>
```
public class InterceptParam
extends java.util.Properties
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`
`static java.lang.String`	`STR_ACTION`
`static java.lang.String`	`STR_ASSOCIATIONURLS`
`static java.lang.String`	`STR_ATTRS`
`static java.lang.String`	`STR_BASEDN`
`static java.lang.String`	`STR_CALLJOIN`
`static java.lang.String`	`STR_CLIENTIP`
`static java.lang.String`	`STR_COMMAND`
`static java.lang.String`	`STR_CONNECTIONSTRING`
`static java.lang.String`	`STR_CONTROLS`
`static java.lang.String`	`STR_DISTINCT`
`static java.lang.String`	`STR_DN`
`static java.lang.String`	`STR_ERRORCODE`
`static java.lang.String`	`STR_ERRORMESSAGE`
`static java.lang.String`	`STR_FILTER`
`static java.lang.String`	`STR_IRL`
`static java.lang.String`	`STR_JAVACLASS`
`static java.lang.String`	`STR_KEYCOLUMNS`
`static java.lang.String`	`STR_KEYFIELDS`
`static java.lang.String`	`STR_MAPATTRS`
`static java.lang.String`	`STR_NAME`
`static java.lang.String`	`STR_NEWRDN`
`static java.lang.String`	`STR_OBJECTCLASS`
`static java.lang.String`	`STR_OPERATIONID`
`static java.lang.String`	`STR_OUTPUTCOLUMNS`
`static java.lang.String`	`STR_OUTPUTFIELDS`
`static java.lang.String`	`STR_PASSWORD`
`static java.lang.String`	`STR_PRINCIPALNAME`
`static java.lang.String`	`STR_RESULTCOUNT`
`static java.lang.String`	`STR_SASLMECHANISM`
`static java.lang.String`	`STR_SCOPE`
`static java.lang.String`	`STR_SCRIPTNAME`
`static java.lang.String`	`STR_SERVICEPARAMETER`
`static java.lang.String`	`STR_SIZELIMIT`
`static java.lang.String`	`STR_STATUS`
`static java.lang.String`	`STR_TYPENAME`
`static java.lang.String`	`STR_USERID`
`static java.lang.String`	`STR_VBASEDN`

Fields inherited from class java.util.Properties
defaults

Constructor Summary

Constructors
Constructor and Description

InterceptParam()

InterceptParam(java.lang.String action)

Constructors
Constructor and Description
`InterceptParam()`
`InterceptParam(java.lang.String action)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addSearchResult(javax.naming.directory.SearchResult sr)` add SearchResult to current result
`void`	`addServiceparameterValue(java.lang.String attributeName, java.lang.String value)`
`void`	`cancelExternalJoin()` cancel external join execution
`void`	`cloneCompoundObject()` call this method if interception/custom script has to modify metadata found in CompoundObject, metadata change can impact: attribute name/remapped names/attribute behavior/xjoins/computed attributes WARNING: can cost up to few mili seconds.
`void`	`commitCommandVdapUrlUpdates()` required to commit changes made on command using VDAPUrl2 object getCommandVdapUrl()
`static javax.naming.directory.SearchResult`	`doXjoinAndGlobalComputed(InterceptParam prop, javax.naming.directory.SearchResult anEntry)` do external join and computed expression at composed entry level.
`static LDAPEntry`	`doXjoinGlobalInterception(InterceptParam prop, LDAPEntry entry)` do external join and computed expression at composed entry level.
`java.lang.String`	`getAction()` RLIConstants.STR_ACTION_ATTR_*
`java.lang.String`	`getAssociationurls()` xjoin definition
`javax.naming.directory.Attributes`	`getAttributes()` attributes to insert
`static java.lang.String`	`getAttributesInLDIF(java.lang.String dn, LDAPAttributeSet attrs)` Gets the attributes in LDIF format.
`javax.naming.directory.Attribute`	`getAttributeToInsert(java.lang.String attrName)` only used for insert() request.
`javax.naming.directory.Attribute`	`getAttributeToInsertOrUpdate(java.lang.String attrName)` only used for insert() request.
`java.lang.String`	`getAttrs()` requested attributes for current query (separated by ',')
`java.lang.String`	`getBaseDn()` base DN to search on backend (ldap backend only)
`java.lang.String`	`getBindDN()` getbindDN: the DN of the user connected to VDS
`java.lang.String`	`getCalljoin()`
`javax.security.cert.X509Certificate[]`	`getCertificates()` get client certificate(s) for authentication...
`java.lang.String`	`getClientIP()`
`java.lang.String`	`getCommand()` command to be executed on backend (SQL for SQL backends, LDAP query for LDAP/Custom backends)
`VDAPUrl2`	`getCommandVdapUrl()` return VDAP url object, allow an easy manipulation of the String command.
`CompoundObject`	`getCompositeObject()` Deprecated.
`CompoundObject`	`getCompoundObject()`
`InternalAttribute`	`getComputedAttr(java.lang.String attributeName)` return computed attribute
`java.lang.String`	`getConnectionstring()`
`java.lang.String`	`getConnectionstringCustomJavaClassName()` Java class name used in connection string.
`java.lang.String`	`getConnectionstringJdbcDriverClassName()` JdbcDriverClassName used in connection string.
`ConnString2`	`getConnectionstringObject()` connection information for backend
`java.lang.String`	`getConnectionstringPassword()` return Password used in connection string.
`java.lang.String`	`getConnectionstringUrl()` return url used in connection string.
`java.lang.String`	`getConnectionstringUsername()` return username used in connection string.
`javax.naming.ldap.Control[]`	`getControls()`
`byte[]`	`getCredentials()` get client credentials for authentication...
`java.lang.String`	`getDistinct()`
`java.lang.String`	`getDn()` virtual DN requested
`java.lang.String`	`getErrorcode()`
`java.lang.String`	`getErrormessage()`
`java.lang.String`	`getFilter()` LDAP: filter to be sent to LDAP backend; RDBMS/CUSTOM: filter received for current query
`java.lang.String`	`getHostName()` return backend host name.
`java.lang.String`	`getHostPort()` return backend host port.
`java.lang.String`	`getIrl()`
`java.lang.String[]`	`getIrlAttrRequest()`
`int`	`getIrlScopeInt()`
`java.lang.String`	`getJavaclass()`
`java.lang.String`	`getKeycolumns()`
`java.lang.String`	`getKeyfields()`
`java.lang.String`	`getMapattrs()`
`java.util.Map`	`getMapInterceptionParameters()` parameters as defined in Service Parameters at node level.
`DvxTreeNode`	`getMetaNode()` return current metanode for node having interception
`javax.naming.directory.ModificationItem`	`getModificationItem(java.lang.String attrName)` ignore case.
`java.util.List<javax.naming.directory.ModificationItem>`	`getModifications()`
`java.lang.String`	`getName()`
`java.lang.String`	`getNewRDN()`
`java.lang.String`	`getObjectclass()`
`javax.naming.directory.Attribute`	`getObjectclassattribute()` Get objectclass as a multivalue attribute
`java.lang.String`	`getOperationID()` operation id for current VDS request
`LDAPModification[]`	`getOriginalLDAPModifications()`
`java.lang.String`	`getOutputcolumns()`
`java.lang.String`	`getOutputfields()`
`int`	`getPageSize()` Gets page size (used for SCIM2)
`java.lang.String`	`getPassword()` password of remote VDS client
`java.lang.String`	`getPrincipalname()`
`int`	`getResultcount()`
`java.lang.Object`	`getResultSet_Object()` Resultset could be a List or NamingEnumeration
`java.util.List<javax.naming.directory.SearchResult>`	`getResultSet()`
`java.lang.String`	`getSaslmechanism()`
`java.lang.String`	`getScope()` LDAP: scope to be sent to backend, RDBMS/CUSTOM: scope for current virtual query
`int`	`getScopeInt()` LDAP: scope to be sent to backend, RDBMS/CUSTOM: scope for current virtual query
`java.lang.String`	`getScriptname()`
`java.lang.String`	`getServiceparameter()`
`java.lang.String`	`getServiceparameterValue(java.lang.String attributeName)`
`int`	`getSizelimit()` size limit to be sent to backend
`java.lang.String`	`getStatus()`
`java.lang.String`	`getSuperiorDN()`
`int`	`getTimelimit()` time limit in second to be sent to backend
`java.lang.String`	`getTypename()`
`java.lang.String`	`getUserid()` username of remote VDS client
`VDAPUrl2`	`getVdapIrl()` return VDAP url object, allow an easy manipulation of the String command.
`java.lang.String`	`getVirtualBaseDn()`
`boolean`	`isCompoundObjectCloned()` compound object was cloned in interception/custom script.
`boolean`	`isConnectionStringChanged()`
`boolean`	`isDeleteOldRDN()`
`boolean`	`isNoLogging()`
`boolean`	`isSecure()` return backend secure mode.
`void`	`removeAttributeToInsert(java.lang.String attrName)` remove attribute to insert.
`void`	`removeModificationItem(java.lang.String attrName)` remove attribute to modify.
`void`	`setAction(java.lang.String val)`
`void`	`setAssociationurls(java.lang.String val)` xjoin definition
`void`	`setAttributes(javax.naming.directory.Attributes attrs)` attributes to insert
`void`	`setAttrs(java.lang.String val)` requested attributes for current query (separated by ',')
`void`	`setBaseDn(java.lang.String val)` base DN to search on backend (ldap backend only)
`void`	`setBindDN(java.lang.String val)`
`void`	`setCalljoin(java.lang.String val)`
`void`	`setCertificates(javax.security.cert.X509Certificate[] certs)`
`void`	`setCommand(java.lang.String val)` command to be executed on backend (SQL for SQL backends, LDAP query for LDAP/Custom backends)
`void`	`setCommandVDAPUrl2(VDAPUrl2 val)`
`void`	`setCompositeObject(CompoundObject compositeObject)` Deprecated.
`void`	`setCompoundObject(CompoundObject compositeObject)` set CO for current interception (will store a clone)
`void`	`setCompoundObjectEntry(CompoundObjectEntry coEntry)`
`void`	`setConnectionstring(ConnString2 connString2)`
`void`	`setConnectionstring(java.lang.String val)`
`void`	`setConnectionstringCustomJavaClassName(java.lang.String fullJavaClassName)` set Java class name used in connection string.
`void`	`setConnectionstringJdbcDriverClassName(java.lang.String val)` set JdbcDriverClassName used in connection string.
`void`	`setConnectionstringPassword(java.lang.String val)` set url used in connection string.
`void`	`setConnectionstringUrl(java.lang.String val)` set url used in connection string.
`void`	`setConnectionstringUsername(java.lang.String val)` set url used in connection string.
`void`	`setControl(javax.naming.ldap.Control control)`
`void`	`setControls(javax.naming.ldap.Control[] controls)`
`void`	`setCredentials(byte[] credentials)`
`void`	`setDeleteOldRDN(boolean val)`
`void`	`setDistinct(java.lang.String val)`
`void`	`setDn(java.lang.String val)` virtual DN requested
`void`	`setErrorcode(int val)`
`void`	`setErrorcode(java.lang.String val)`
`void`	`setErrorcodeZero()` set error code to zero, no error.
`void`	`setErrormessage(java.lang.String val)`
`void`	`setFilter(java.lang.String val)` LDAP: filter to be sent to LDAP backend; RDBMS/CUSTOM: filter received for current query
`void`	`setHostName(java.lang.String hostName)` use this method only with ldap command
`void`	`setHostPort(java.lang.String hostPort)` use this method only with ldap command
`void`	`setIrl(java.lang.Object val)`
`void`	`setJavaclass(java.lang.String val)`
`void`	`setKeycolumns(java.lang.String val)`
`void`	`setKeyfields(java.lang.String val)`
`void`	`setMapattrs(java.lang.String val)`
`void`	`setMetaNode(DvxTreeNode metaNode)` set current metanode for node having interception
`void`	`setModifications(java.util.List<javax.naming.directory.ModificationItem> mods)`
`void`	`setName(java.lang.String val)`
`void`	`setNewRDN(java.lang.String val)`
`void`	`setNoLogging(boolean noLogging)`
`void`	`setObjectclass(java.lang.String val)`
`void`	`setObjectclassattribute(javax.naming.directory.Attribute attr)` Set objectclass as a multivalue attribute
`void`	`setOriginalLDAPModifications(LDAPModification[] originalLDAPModification)`
`void`	`setOutputcolumns(java.lang.String val)`
`void`	`setOutputfields(java.lang.String val)`
`void`	`setPassword(java.lang.String val)` password of remote VDS client
`void`	`setPrincipalname(java.lang.String val)`
`java.lang.Object`	`setProperty(java.lang.String key, java.lang.String value)`
`void`	`setResultcount(int val)`
`void`	`setResultSet_Object(java.lang.Object theresult)` Resultset could be a List or NamingEnumeration
`void`	`setResultSet(java.util.List<javax.naming.directory.SearchResult> theresult)`
`void`	`setScope(java.lang.String val)` LDAP: scope to be sent to backend, RDBMS/CUSTOM: scope for current virtual query
`void`	`setScopeInt(int val)` LDAP: scope to be sent to backend, RDBMS/CUSTOM: scope for current virtual query
`void`	`setScriptname(java.lang.String val)`
`void`	`setSecure(boolean isSecure)` use this method only with ldap command
`void`	`setServiceparameter(java.lang.String val)`
`void`	`setSizelimit(int val)` size limit to be sent to backend
`void`	`setStatus(java.lang.String val)`
`void`	`setStatusFailed()` the engine will stop the current request and forward a failed message as a response to the initial request.
`void`	`setStatusFailed(int ldapErrorCode)` the engine will stop the current request and forward a failed message as a response to the initial request.
`void`	`setStatusNo()` the engine will stop the current request and forward a failed message as a response to the initial request.
`void`	`setStatusOk()` execution was successful and the request is considered as done, a successful response is to send to the client.
`void`	`setStatusProcceed()` Deprecated.
`void`	`setStatusProceed()` the engine has still to process the request after interception.
`void`	`setStatusProcessResult()` the engine will call the process result interception for each entry returned for the current request.
`void`	`setStatusYes()` execution was successful and the request is considered as done, a successful response is to send to the client.
`void`	`setSuperiorDN(java.lang.String val)`
`void`	`setTimelimit(int val)` time limit in second to be sent to backend
`void`	`setTypename(java.lang.String val)` Set the typename
`void`	`setUserid(java.lang.String val)` username of remote VDS client
`void`	`setVirtualBaseDn(java.lang.String val)`

Methods inherited from class java.util.Properties
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable
clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - STR_CLIENTIP
```
public static final java.lang.String STR_CLIENTIP
```
    See Also:
    
    Constant Field Values
  - STR_SASLMECHANISM
```
public static final java.lang.String STR_SASLMECHANISM
```
    See Also:
    
    Constant Field Values
  - STR_OPERATIONID
```
public static final java.lang.String STR_OPERATIONID
```
    See Also:
    
    Constant Field Values
  - STR_VBASEDN
```
public static final java.lang.String STR_VBASEDN
```
    See Also:
    
    Constant Field Values
  - STR_BASEDN
```
public static final java.lang.String STR_BASEDN
```
    See Also:
    
    Constant Field Values
  - STR_RESULTCOUNT
```
public static final java.lang.String STR_RESULTCOUNT
```
    See Also:
    
    Constant Field Values
  - STR_SIZELIMIT
```
public static final java.lang.String STR_SIZELIMIT
```
    See Also:
    
    Constant Field Values
  - STR_ERRORMESSAGE
```
public static final java.lang.String STR_ERRORMESSAGE
```
    See Also:
    
    Constant Field Values
  - STR_ERRORCODE
```
public static final java.lang.String STR_ERRORCODE
```
    See Also:
    
    Constant Field Values
  - STR_STATUS
```
public static final java.lang.String STR_STATUS
```
    See Also:
    
    Constant Field Values
  - STR_PASSWORD
```
public static final java.lang.String STR_PASSWORD
```
    See Also:
    
    Constant Field Values
  - STR_USERID
```
public static final java.lang.String STR_USERID
```
    See Also:
    
    Constant Field Values
  - STR_ACTION
```
public static final java.lang.String STR_ACTION
```
    See Also:
    
    Constant Field Values
  - STR_CALLJOIN
```
public static final java.lang.String STR_CALLJOIN
```
    See Also:
    
    Constant Field Values
  - STR_JAVACLASS
```
public static final java.lang.String STR_JAVACLASS
```
    See Also:
    
    Constant Field Values
  - STR_NEWRDN
```
public static final java.lang.String STR_NEWRDN
```
    See Also:
    
    Constant Field Values
  - STR_DN
```
public static final java.lang.String STR_DN
```
    See Also:
    
    Constant Field Values
  - STR_DISTINCT
```
public static final java.lang.String STR_DISTINCT
```
    See Also:
    
    Constant Field Values
  - STR_IRL
```
public static final java.lang.String STR_IRL
```
    See Also:
    
    Constant Field Values
  - STR_ASSOCIATIONURLS
```
public static final java.lang.String STR_ASSOCIATIONURLS
```
    See Also:
    
    Constant Field Values
  - STR_MAPATTRS
```
public static final java.lang.String STR_MAPATTRS
```
    See Also:
    
    Constant Field Values
  - STR_KEYCOLUMNS
```
public static final java.lang.String STR_KEYCOLUMNS
```
    See Also:
    
    Constant Field Values
  - STR_SCRIPTNAME
```
public static final java.lang.String STR_SCRIPTNAME
```
    See Also:
    
    Constant Field Values
  - STR_SERVICEPARAMETER
```
public static final java.lang.String STR_SERVICEPARAMETER
```
    See Also:
    
    Constant Field Values
  - STR_PRINCIPALNAME
```
public static final java.lang.String STR_PRINCIPALNAME
```
    See Also:
    
    Constant Field Values
  - STR_FILTER
```
public static final java.lang.String STR_FILTER
```
    See Also:
    
    Constant Field Values
  - STR_ATTRS
```
public static final java.lang.String STR_ATTRS
```
    See Also:
    
    Constant Field Values
  - STR_SCOPE
```
public static final java.lang.String STR_SCOPE
```
    See Also:
    
    Constant Field Values
  - STR_NAME
```
public static final java.lang.String STR_NAME
```
    See Also:
    
    Constant Field Values
  - STR_OUTPUTCOLUMNS
```
public static final java.lang.String STR_OUTPUTCOLUMNS
```
    See Also:
    
    Constant Field Values
  - STR_OUTPUTFIELDS
```
public static final java.lang.String STR_OUTPUTFIELDS
```
    See Also:
    
    Constant Field Values
  - STR_KEYFIELDS
```
public static final java.lang.String STR_KEYFIELDS
```
    See Also:
    
    Constant Field Values
  - STR_TYPENAME
```
public static final java.lang.String STR_TYPENAME
```
    See Also:
    
    Constant Field Values
  - STR_OBJECTCLASS
```
public static final java.lang.String STR_OBJECTCLASS
```
    See Also:
    
    Constant Field Values
  - STR_COMMAND
```
public static final java.lang.String STR_COMMAND
```
    See Also:
    
    Constant Field Values
  - STR_CONNECTIONSTRING
```
public static final java.lang.String STR_CONNECTIONSTRING
```
    See Also:
    
    Constant Field Values
  - STR_CONTROLS
```
public static final java.lang.String STR_CONTROLS
```
    See Also:
    
    Constant Field Values
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - InterceptParam
```
public InterceptParam()
```
  - InterceptParam
```
public InterceptParam(java.lang.String action)
```
- Method Detail
  - getConnectionstring
```
public java.lang.String getConnectionstring()
```
    Returns:
    
    Returns the Connectionstring.
  - getConnectionstringObject
```
public ConnString2 getConnectionstringObject()
```
    connection information for backend
    
    Returns:
  - getCommand
```
public java.lang.String getCommand()
```
    command to be executed on backend (SQL for SQL backends, LDAP query for LDAP/Custom backends)
    
    Returns:
    
    Returns the Command.
  - getCommandVdapUrl
```
public VDAPUrl2 getCommandVdapUrl()
```
    return VDAP url object, allow an easy manipulation of the String command.
    
    Returns:
  - commitCommandVdapUrlUpdates
```
public void commitCommandVdapUrlUpdates()
```
    required to commit changes made on command using VDAPUrl2 object getCommandVdapUrl()
  - getHostName
```
public java.lang.String getHostName()
```
    return backend host name.
    
    Returns:
  - setHostName
```
public void setHostName(java.lang.String hostName)
```
    use this method only with ldap command
    
    Parameters:
    
    hostName -
  - getHostPort
```
public java.lang.String getHostPort()
```
    return backend host port.
    
    Returns:
  - setHostPort
```
public void setHostPort(java.lang.String hostPort)
```
    use this method only with ldap command
    
    Parameters:
    
    hostPort -
  - isSecure
```
public boolean isSecure()
```
    return backend secure mode.
    
    Returns:
  - setSecure
```
public void setSecure(boolean isSecure)
```
    use this method only with ldap command
    
    Parameters:
    
    hostPort -
  - getObjectclass
```
public java.lang.String getObjectclass()
```
    Returns:
    
    Returns the Objectclass.
  - setObjectclass
```
public void setObjectclass(java.lang.String val)
```
    Parameters:
    
    val - The objectclass to set.
  - getObjectclassattribute
```
public javax.naming.directory.Attribute getObjectclassattribute()
```
    Get objectclass as a multivalue attribute
  - setObjectclassattribute
```
public void setObjectclassattribute(javax.naming.directory.Attribute attr)
```
    Set objectclass as a multivalue attribute
    
    Parameters:
    
    attr - The objectclass to set
  - getTypename
```
public java.lang.String getTypename()
```
    Returns:
    
    Returns the typename.
  - setTypename
```
public void setTypename(java.lang.String val)
```
    Set the typename
    
    Parameters:
    
    val - the Typename to set.
  - getKeyfields
```
public java.lang.String getKeyfields()
```
    Returns:
    
    Returns the Keyfields.
  - setKeyfields
```
public void setKeyfields(java.lang.String val)
```
    Parameters:
    
    val - The keyfields to set.
  - getOutputfields
```
public java.lang.String getOutputfields()
```
    Returns:
    
    Returns the Outputfields.
  - setOutputfields
```
public void setOutputfields(java.lang.String val)
```
    Parameters:
    
    val - The outputfields to set.
  - getOutputcolumns
```
public java.lang.String getOutputcolumns()
```
    Returns:
    
    Returns the Outputcolumns.
  - setOutputcolumns
```
public void setOutputcolumns(java.lang.String val)
```
    Parameters:
    
    val - The outputcolumns to set.
  - getName
```
public java.lang.String getName()
```
    Returns:
    
    Returns the object Name.
  - setName
```
public void setName(java.lang.String val)
```
    Parameters:
    
    val - The object name to set.
  - getScope
```
public java.lang.String getScope()
```
    LDAP: scope to be sent to backend, RDBMS/CUSTOM: scope for current virtual query
    
    Returns:
    
    Returns the Scope.
  - getScopeInt
```
public int getScopeInt()
```
    LDAP: scope to be sent to backend, RDBMS/CUSTOM: scope for current virtual query
    
    Returns:
    
    Returns the Scope.
  - getAttrs
```
public java.lang.String getAttrs()
```
    requested attributes for current query (separated by ',')
    
    Returns:
    
    Returns the Attrs.
  - getFilter
```
public java.lang.String getFilter()
```
    LDAP: filter to be sent to LDAP backend; RDBMS/CUSTOM: filter received for current query
    
    Returns:
    
    Returns the Filter.
  - setPrincipalname
```
public void setPrincipalname(java.lang.String val)
```
    Parameters:
    
    val - The principalname to set.
  - getServiceparameter
```
public java.lang.String getServiceparameter()
```
    Returns:
    
    Returns the Serviceparameter.
  - getServiceparameterValue
```
public java.lang.String getServiceparameterValue(java.lang.String attributeName)
```
    Returns:
    
    Returns the Serviceparameter value for attribute
  - addServiceparameterValue
```
public void addServiceparameterValue(java.lang.String attributeName,
                                     java.lang.String value)
```
  - setServiceparameter
```
public void setServiceparameter(java.lang.String val)
```
    Parameters:
    
    val - The serviceparameter to set.
  - getScriptname
```
public java.lang.String getScriptname()
```
    Returns:
    
    Returns the Scriptname.
  - setScriptname
```
public void setScriptname(java.lang.String val)
```
    Parameters:
    
    val - The scriptname to set.
  - getKeycolumns
```
public java.lang.String getKeycolumns()
```
    Returns:
    
    Returns the Keycolumns.
  - setKeycolumns
```
public void setKeycolumns(java.lang.String val)
```
    Parameters:
    
    val - The keycolumns to set.
  - getMapattrs
```
public java.lang.String getMapattrs()
```
    Returns:
    
    Returns the Mapattrs.
  - setMapattrs
```
public void setMapattrs(java.lang.String val)
```
    Parameters:
    
    val - The mapattrs to set.
  - getAssociationurls
```
public java.lang.String getAssociationurls()
```
    xjoin definition
    
    Returns:
    
    Returns the Associationurls.
  - setAssociationurls
```
public void setAssociationurls(java.lang.String val)
```
    xjoin definition
    
    Parameters:
    
    val - The associationurls to set.
  - getIrl
```
public java.lang.String getIrl()
```
    Returns:
    
    Returns the Irl.
  - getIrlAttrRequest
```
public java.lang.String[] getIrlAttrRequest()
```
    Returns:
    
    attr requested in search request sent to VDS
  - getIrlScopeInt
```
public int getIrlScopeInt()
```
    Returns:
    
    Returns the Irl. scope
  - setIrl
```
public void setIrl(java.lang.Object val)
```
    Parameters:
    
    val - The irl to set. virtual cmd received for current operation.
  - getDistinct
```
public java.lang.String getDistinct()
```
    Returns:
    
    Returns the Distinct.
  - setDistinct
```
public void setDistinct(java.lang.String val)
```
    Parameters:
    
    val - The distinct to set.
  - getDn
```
public java.lang.String getDn()
```
    virtual DN requested
    
    Returns:
    
    Returns the Dn.
  - setDn
```
public void setDn(java.lang.String val)
```
    virtual DN requested
    
    Parameters:
    
    val - The dn to set.
  - getNewRDN
```
public java.lang.String getNewRDN()
```
    Returns:
    
    Returns the NewRDN.
  - setNewRDN
```
public void setNewRDN(java.lang.String val)
```
    Parameters:
    
    val - The newRDN to set.
  - getSuperiorDN
```
public java.lang.String getSuperiorDN()
```
    Returns:
    
    Returns the superiorDN.
  - setSuperiorDN
```
public void setSuperiorDN(java.lang.String val)
```
    Parameters:
    
    val - The superiorDN to set.
  - isDeleteOldRDN
```
public boolean isDeleteOldRDN()
```
    Returns:
    
    Returns the deleteOldRDN.
  - setDeleteOldRDN
```
public void setDeleteOldRDN(boolean val)
```
    Parameters:
    
    val - The DeleteOldRDN to set.
  - getJavaclass
```
public java.lang.String getJavaclass()
```
    Returns:
    
    Returns the Javaclass.
  - setJavaclass
```
public void setJavaclass(java.lang.String val)
```
    Parameters:
    
    val - The javaclass to set.
  - getCalljoin
```
public java.lang.String getCalljoin()
```
    Returns:
    
    Returns the Calljoin.
  - setCalljoin
```
public void setCalljoin(java.lang.String val)
```
    Parameters:
    
    val - The calljoin to set. "yes" or "no"
  - getComputedAttr
```
public InternalAttribute getComputedAttr(java.lang.String attributeName)
```
    return computed attribute
    
    Parameters:
    
    attributeName -
    
    Returns:
  - cancelExternalJoin
```
public void cancelExternalJoin()
```
    cancel external join execution
  - getAction
```
public java.lang.String getAction()
```
    RLIConstants.STR_ACTION_ATTR_*
    
    Returns:
    
    Returns the Action.
  - setAction
```
public void setAction(java.lang.String val)
```
    Parameters:
    
    val - The action to set.
  - getUserid
```
public java.lang.String getUserid()
```
    username of remote VDS client
    
    Returns:
    
    Returns the Userid.
  - setUserid
```
public void setUserid(java.lang.String val)
```
    username of remote VDS client
    
    Parameters:
    
    val - The userid to set.
  - setBindDN
```
public void setBindDN(java.lang.String val)
```
  - getBindDN
```
public java.lang.String getBindDN()
```
    getbindDN: the DN of the user connected to VDS
    
    Returns:
    
    the DN of the user connected (can be null)
  - getPassword
```
public java.lang.String getPassword()
```
    password of remote VDS client
    
    Returns:
    
    Returns the Password.
  - setPassword
```
public void setPassword(java.lang.String val)
```
    password of remote VDS client
    
    Parameters:
    
    val - The password to set.
  - getStatus
```
public java.lang.String getStatus()
```
    Returns:
    
    Returns the Status.
  - setStatus
```
public void setStatus(java.lang.String val)
```
    Parameters:
    
    val - The status to set.
  - setStatusYes
```
public void setStatusYes()
```
    execution was successful and the request is considered as done, a successful response is to send to the client.
  - setStatusOk
```
public void setStatusOk()
```
    execution was successful and the request is considered as done, a successful response is to send to the client.
  - setStatusFailed
```
public void setStatusFailed()
```
    the engine will stop the current request and forward a failed message as a response to the initial request.
  - setStatusFailed
```
public void setStatusFailed(int ldapErrorCode)
```
    the engine will stop the current request and forward a failed message as a response to the initial request.
    
    Parameters:
    
    ldapErrorCode - see LDAPException
  - setStatusNo
```
public void setStatusNo()
```
    the engine will stop the current request and forward a failed message as a response to the initial request.
  - setStatusProceed
```
public void setStatusProceed()
```
    the engine has still to process the request after interception. Interception parameters could have been modified by the interception and the engine will use these new value to process the request.
  - setStatusProcceed
```
@Deprecated
public void setStatusProcceed()
```
    Deprecated.
    
    Use setStatusProceed(). the engine has still to process the request after interception. Interception parameters could have been modified by the interception and the engine will use these new value to process the request.
  - setStatusProcessResult
```
public void setStatusProcessResult()
```
    the engine will call the process result interception for each entry returned for the current request. (only returned by select interception)
  - getErrorcode
```
public java.lang.String getErrorcode()
```
    Returns:
    
    Returns the Errorcode.
  - setErrorcode
```
public void setErrorcode(java.lang.String val)
```
    Parameters:
    
    val - The errorcode to set.
  - setErrorcode
```
public void setErrorcode(int val)
```
    Parameters:
    
    val - The errorcode to set.
  - setErrorcodeZero
```
public void setErrorcodeZero()
```
    set error code to zero, no error.
  - getErrormessage
```
public java.lang.String getErrormessage()
```
    Returns:
    
    Returns the Errormessage.
  - setErrormessage
```
public void setErrormessage(java.lang.String val)
```
    Parameters:
    
    val - The errormessage to set.
  - getSizelimit
```
public int getSizelimit()
```
    size limit to be sent to backend
    
    Returns:
    
    Returns the Sizelimit.
  - setSizelimit
```
public void setSizelimit(int val)
```
    size limit to be sent to backend
    
    Parameters:
    
    val - The sizelimit to set.
  - getTimelimit
```
public int getTimelimit()
```
    time limit in second to be sent to backend
    
    Returns:
    
    Returns the timelimit.
  - setTimelimit
```
public void setTimelimit(int val)
```
    time limit in second to be sent to backend
    
    Parameters:
    
    val - The timelimit to set.
  - getControls
```
public javax.naming.ldap.Control[] getControls()
```
  - setControls
```
public void setControls(javax.naming.ldap.Control[] controls)
```
  - setControl
```
public void setControl(javax.naming.ldap.Control control)
```
  - getResultcount
```
public int getResultcount()
```
    Returns:
    
    Returns the Resultcount.
  - setResultcount
```
public void setResultcount(int val)
```
    Parameters:
    
    val - The resultcount to set.
  - getModifications
```
public java.util.List<javax.naming.directory.ModificationItem> getModifications()
```
    Returns:
    
    Returns the Midifications.
  - setModifications
```
public void setModifications(java.util.List<javax.naming.directory.ModificationItem> mods)
```
    Parameters:
    
    mods - The modifications to set.
  - getAttributes
```
public javax.naming.directory.Attributes getAttributes()
```
    attributes to insert
    
    Returns:
    
    Returns the Attributes.
  - setAttributes
```
public void setAttributes(javax.naming.directory.Attributes attrs)
```
    attributes to insert
    
    Parameters:
    
    attrs - The attrs to set.
  - getResultSet
```
public java.util.List<javax.naming.directory.SearchResult> getResultSet()
```
    Returns:
    
    Returns the ResultSet.
  - setResultSet
```
public void setResultSet(java.util.List<javax.naming.directory.SearchResult> theresult)
```
    Parameters:
    
    theresult - The result to set.
  - addSearchResult
```
public void addSearchResult(javax.naming.directory.SearchResult sr)
```
    add SearchResult to current result
    
    Parameters:
    
    sr -
  - getResultSet_Object
```
public java.lang.Object getResultSet_Object()
```
    Resultset could be a List or NamingEnumeration
    
    Returns:
  - setResultSet_Object
```
public void setResultSet_Object(java.lang.Object theresult)
```
    Resultset could be a List or NamingEnumeration
    
    Parameters:
    
    theresult -
  - getBaseDn
```
public java.lang.String getBaseDn()
```
    base DN to search on backend (ldap backend only)
    
    Returns:
    
    Returns the BaseDn (LDAP proxy remote LDAP basedn).
  - getVirtualBaseDn
```
public java.lang.String getVirtualBaseDn()
```
    Returns:
    
    Returns the Virtual BaseDn of an LDAP proxy).
  - getOperationID
```
public java.lang.String getOperationID()
```
    operation id for current VDS request
    
    Returns:
    
    Returns the operationID (global interception available in select / processresult only).
  - getSaslmechanism
```
public java.lang.String getSaslmechanism()
```
    Returns:
    
    Returns the sasl mechanism used for authentication (global interception only). valid values : "SIMPLE" , "NTLM", "GSSAPI", "GSS-SPNEGO" , "DIGEST-MD5" , "EXTERNAL"
  - getClientIP
```
public java.lang.String getClientIP()
```
    Returns:
    
    Returns the clientIP associated with the connection. available only in Global Interception scripts. Returns null otherwise
  - setVirtualBaseDn
```
public void setVirtualBaseDn(java.lang.String val)
```
    Parameters:
    
    val - The virtual BaseDN to set (N/A for script).
  - getCredentials
```
public byte[] getCredentials()
```
    get client credentials for authentication...
    
    Returns:
    
    null or byte[]
  - setCredentials
```
public void setCredentials(byte[] credentials)
```
  - getCertificates
```
public javax.security.cert.X509Certificate[] getCertificates()
```
    get client certificate(s) for authentication...
    
    Returns:
    
    null or array of javax.security.cert.X509Certificate
  - setCertificates
```
public void setCertificates(javax.security.cert.X509Certificate[] certs)
```
  - getPrincipalname
```
public java.lang.String getPrincipalname()
```
    Returns:
    
    Returns the Principalname.
  - getAttributesInLDIF
```
public static java.lang.String getAttributesInLDIF(java.lang.String dn,
                                                   LDAPAttributeSet attrs)
```
    Gets the attributes in LDIF format.
    
    Parameters:
    
    dn -
    
    attrs -
    
    Returns:
  - setProperty
```
public java.lang.Object setProperty(java.lang.String key,
                                    java.lang.String value)
```
    Overrides:
    
    setProperty in class java.util.Properties
  - setBaseDn
```
public void setBaseDn(java.lang.String val)
```
    base DN to search on backend (ldap backend only)
    
    Parameters:
    
    val - The BaseDN to set (N/A for script).
  - setScope
```
public void setScope(java.lang.String val)
```
    LDAP: scope to be sent to backend, RDBMS/CUSTOM: scope for current virtual query
    
    Parameters:
    
    val - The scope to set.
  - setScopeInt
```
public void setScopeInt(int val)
```
    LDAP: scope to be sent to backend, RDBMS/CUSTOM: scope for current virtual query
    
    Parameters:
    
    val - The scope to set.
  - setFilter
```
public void setFilter(java.lang.String val)
```
    LDAP: filter to be sent to LDAP backend; RDBMS/CUSTOM: filter received for current query
    
    Parameters:
    
    val - The filter to set.
  - setAttrs
```
public void setAttrs(java.lang.String val)
```
    requested attributes for current query (separated by ',')
    
    Parameters:
    
    val - The attrs to set.
  - setCommandVDAPUrl2
```
public void setCommandVDAPUrl2(VDAPUrl2 val)
```
    Parameters:
    
    val - The command to set.
  - setCommand
```
public void setCommand(java.lang.String val)
```
    command to be executed on backend (SQL for SQL backends, LDAP query for LDAP/Custom backends)
    
    Parameters:
    
    val - The command to set.
  - isConnectionStringChanged
```
public boolean isConnectionStringChanged()
```
  - setConnectionstring
```
public void setConnectionstring(java.lang.String val)
```
    Parameters:
    
    val - The connectionstring to set.
  - setConnectionstring
```
public void setConnectionstring(ConnString2 connString2)
```
  - getConnectionstringUrl
```
public java.lang.String getConnectionstringUrl()
```
    return url used in connection string. connection string must have been previously initialized.
    
    Parameters:
    
    val -
  - setConnectionstringUrl
```
public void setConnectionstringUrl(java.lang.String val)
```
    set url used in connection string. connection string must have been previously initialized.
    
    Parameters:
    
    val -
  - getConnectionstringUsername
```
public java.lang.String getConnectionstringUsername()
```
    return username used in connection string. connection string must have been previously initialized.
    
    Parameters:
    
    val -
  - setConnectionstringUsername
```
public void setConnectionstringUsername(java.lang.String val)
```
    set url used in connection string. connection string must have been previously initialized.
    
    Parameters:
    
    val -
  - getConnectionstringPassword
```
public java.lang.String getConnectionstringPassword()
```
    return Password used in connection string. connection string must have been previously initialized.
    
    Parameters:
    
    val -
  - setConnectionstringPassword
```
public void setConnectionstringPassword(java.lang.String val)
```
    set url used in connection string. connection string must have been previously initialized.
    
    Parameters:
    
    val -
  - getConnectionstringJdbcDriverClassName
```
public java.lang.String getConnectionstringJdbcDriverClassName()
```
    JdbcDriverClassName used in connection string.
    
    Returns:
  - setConnectionstringJdbcDriverClassName
```
public void setConnectionstringJdbcDriverClassName(java.lang.String val)
```
    set JdbcDriverClassName used in connection string. connection string must have been previously initialized.
    
    Parameters:
    
    val -
  - getConnectionstringCustomJavaClassName
```
public java.lang.String getConnectionstringCustomJavaClassName()
```
    Java class name used in connection string.
    
    Returns:
  - setConnectionstringCustomJavaClassName
```
public void setConnectionstringCustomJavaClassName(java.lang.String fullJavaClassName)
```
    set Java class name used in connection string. connection string must have been previously initialized.
    
    Parameters:
    
    fullJavaClassName - package name + class name (no file extension)
  - getAttributeToInsert
```
public javax.naming.directory.Attribute getAttributeToInsert(java.lang.String attrName)
```
    only used for insert() request. note: ignore case for attr name
    
    Parameters:
    
    attrName -
    
    Returns:
  - getAttributeToInsertOrUpdate
```
public javax.naming.directory.Attribute getAttributeToInsertOrUpdate(java.lang.String attrName)
```
    only used for insert() request. note: ignore case for attr name
    
    Parameters:
    
    attrName -
    
    Returns:
  - removeAttributeToInsert
```
public void removeAttributeToInsert(java.lang.String attrName)
```
    remove attribute to insert. only used for insert() request. note: ignore case for attr name
    
    Parameters:
    
    attrName -
  - getModificationItem
```
public javax.naming.directory.ModificationItem getModificationItem(java.lang.String attrName)
```
    ignore case.
  - removeModificationItem
```
public void removeModificationItem(java.lang.String attrName)
```
    remove attribute to modify. only used for update() request. note: ignore case for attr name
    
    Parameters:
    
    attrName -
  - getVdapIrl
```
public VDAPUrl2 getVdapIrl()
```
    return VDAP url object, allow an easy manipulation of the String command.
    
    Returns:
  - getMetaNode
```
public DvxTreeNode getMetaNode()
```
    return current metanode for node having interception
    
    Returns:
  - setMetaNode
```
public void setMetaNode(DvxTreeNode metaNode)
```
    set current metanode for node having interception
    
    Parameters:
    
    metaNode -
  - getMapInterceptionParameters
```
public java.util.Map getMapInterceptionParameters()
```
    parameters as defined in Service Parameters at node level. key: str attr. name; value: str value. Attr names are indexed to lower case.
    
    Returns:
  - getCompositeObject
```
@Deprecated
public CompoundObject getCompositeObject()
```
    Deprecated.
    
    use getCompoundObject()
    
    Returns:
  - getCompoundObject
```
public CompoundObject getCompoundObject()
```
  - setCompositeObject
```
@Deprecated
public void setCompositeObject(CompoundObject compositeObject)
```
    Deprecated.
    
    Use setCompoundObject() set CO for current interception (will store a clone)
    
    Parameters:
    
    compositeObject -
  - setCompoundObject
```
public void setCompoundObject(CompoundObject compositeObject)
```
    set CO for current interception (will store a clone)
    
    Parameters:
    
    compositeObject -
  - isCompoundObjectCloned
```
public boolean isCompoundObjectCloned()
```
    compound object was cloned in interception/custom script. It means metadata could have been updated and new coupound object should be use for metadata for current query
    
    Returns:
  - cloneCompoundObject
```
public void cloneCompoundObject()
```
    call this method if interception/custom script has to modify metadata found in CompoundObject, metadata change can impact: attribute name/remapped names/attribute behavior/xjoins/computed attributes WARNING: can cost up to few mili seconds.
  - setCompoundObjectEntry
```
public void setCompoundObjectEntry(CompoundObjectEntry coEntry)
```
  - doXjoinAndGlobalComputed
```
public static javax.naming.directory.SearchResult doXjoinAndGlobalComputed(InterceptParam prop,
                                                                           javax.naming.directory.SearchResult anEntry)
                                                                    throws LDAPException
```
    do external join and computed expression at composed entry level.
    
    Returns:
    
    Throws:
    
    LDAPException
  - doXjoinGlobalInterception
```
public static LDAPEntry doXjoinGlobalInterception(InterceptParam prop,
                                                  LDAPEntry entry)
                                           throws LDAPException
```
    do external join and computed expression at composed entry level.
    
    Returns:
    
    Throws:
    
    LDAPException
  - setOriginalLDAPModifications
```
public void setOriginalLDAPModifications(LDAPModification[] originalLDAPModification)
```
  - getOriginalLDAPModifications
```
public LDAPModification[] getOriginalLDAPModifications()
```
  - isNoLogging
```
public boolean isNoLogging()
```
  - setNoLogging
```
public void setNoLogging(boolean noLogging)
```
  - getPageSize
```
public int getPageSize()
```
    Gets page size (used for SCIM2)
    
    Returns:
    
    page size.

Class InterceptParam

Field Summary

Fields inherited from class java.util.Properties

Constructor Summary

Method Summary

Methods inherited from class java.util.Properties

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

Field Detail

STR_CLIENTIP

STR_SASLMECHANISM

STR_OPERATIONID

STR_VBASEDN

STR_BASEDN

STR_RESULTCOUNT

STR_SIZELIMIT

STR_ERRORMESSAGE

STR_ERRORCODE

STR_STATUS

STR_PASSWORD

STR_USERID

STR_ACTION

STR_CALLJOIN

STR_JAVACLASS

STR_NEWRDN

STR_DN

STR_DISTINCT

STR_IRL

STR_ASSOCIATIONURLS

STR_MAPATTRS

STR_KEYCOLUMNS

STR_SCRIPTNAME

STR_SERVICEPARAMETER

STR_PRINCIPALNAME

STR_FILTER

STR_ATTRS

STR_SCOPE

STR_NAME

STR_OUTPUTCOLUMNS

STR_OUTPUTFIELDS

STR_KEYFIELDS

STR_TYPENAME

STR_OBJECTCLASS

STR_COMMAND

STR_CONNECTIONSTRING

STR_CONTROLS

serialVersionUID

Constructor Detail

InterceptParam

InterceptParam

Method Detail

getConnectionstring

getConnectionstringObject

getCommand

getCommandVdapUrl

commitCommandVdapUrlUpdates

getHostName

setHostName

getHostPort

setHostPort

isSecure

setSecure

getObjectclass

setObjectclass

getObjectclassattribute

setObjectclassattribute

getTypename

setTypename

getKeyfields

setKeyfields

getOutputfields

setOutputfields

getOutputcolumns

setOutputcolumns

getName

setName

getScope

getScopeInt

getAttrs

getFilter