LDAPProps (Plugins 9.0.01-SNAPSHOT API)

java.lang.Object
- com.bmc.arsys.plugins.arealdap.LDAPProps

All Implemented Interfaces:

LDAPConstants

Direct Known Subclasses:

SSOLDAPProps
```
public class LDAPProps
extends Object
implements LDAPConstants
```

Field Summary
- Fields inherited from interface com.bmc.arsys.plugins.arealdap.LDAPConstants
  AR_LICENSE_TYPE_FIXED, AR_LICENSE_TYPE_FLOATING, AR_LICENSE_TYPE_NONE, AR_LICENSE_TYPE_RESTRICTED_READ, AR_NOTIFY_NONE, AR_NOTIFY_VIA_DEFAULT, AR_NOTIFY_VIA_EMAIL, AR_NOTIFY_VIA_NOTIFIER, AREA_LDAP_BIND_PASSWORD, AREA_LDAP_BIND_USER, AREA_LDAP_CHASE_REFERRAL, AREA_LDAP_CONNECT_TIMEOUT, AREA_LDAP_GROUP_CONTAINER, AREA_LDAP_GROUP_NONE, AREA_LDAP_HOSTNAME, AREA_LDAP_PORT, AREA_LDAP_USE_SSL, AREA_LDAP_USER_BASE, AREA_LDAP_USER_FILTER, AREA_LOGIN_FAILED, AREA_LOGIN_LOCK_OUT, AREA_LOGIN_SUCCESS, AREA_LOGIN_UNKNOWN_USER, EA_RPC_TIMEOUT, LDAP_AUTH_AUTH_SERVER, LDAP_AUTH_BIND_PASSWORD, LDAP_AUTH_BIND_USER, LDAP_AUTH_CERTPATH, LDAP_AUTH_CHASE_REFERRAL, LDAP_AUTH_CONNECT_TIMEOUT, LDAP_AUTH_DEFAULT_GROUPS, LDAP_AUTH_EMAIL, LDAP_AUTH_EMAIL_DEFAULT, LDAP_AUTH_GROUP_FILTER, LDAP_AUTH_GROUPBASE, LDAP_AUTH_HOST, LDAP_AUTH_LIC, LDAP_AUTH_LIC_DEFAULT, LDAP_AUTH_LICAPP, LDAP_AUTH_LICAPP_DEFAULT, LDAP_AUTH_LICFTS, LDAP_AUTH_LICFTS_DEFAULT, LDAP_AUTH_LICMASK, LDAP_AUTH_LICMASK_DEFAULT, LDAP_AUTH_LICRES1, LDAP_AUTH_LICRES1_DEFAULT, LDAP_AUTH_NOTIFYMETH, LDAP_AUTH_NOTIFYMETH_DEFAULT, LDAP_AUTH_PASSWORD, LDAP_AUTH_PORT, LDAP_AUTH_ROLES, LDAP_AUTH_ROLES_DEFAULT, LDAP_AUTH_USE_GROUPS, LDAP_AUTH_USER_DN, LDAP_AUTH_USER_FILTER, LDAP_AUTH_USERBASE, LDAP_AUTH_USESSL, SSO_LDAP_AUTH_AUTH_SERVER, SSO_LDAP_AUTH_BIND_PASSWORD, SSO_LDAP_AUTH_BIND_USER, SSO_LDAP_AUTH_CERTPATH, SSO_LDAP_AUTH_CHASE_REFERRAL, SSO_LDAP_AUTH_CONNECT_TIMEOUT, SSO_LDAP_AUTH_DEFAULT_GROUPS, SSO_LDAP_AUTH_EMAIL, SSO_LDAP_AUTH_EMAIL_DEFAULT, SSO_LDAP_AUTH_GROUP_FILTER, SSO_LDAP_AUTH_GROUPBASE, SSO_LDAP_AUTH_HOST, SSO_LDAP_AUTH_KEY, SSO_LDAP_AUTH_LIC, SSO_LDAP_AUTH_LIC_DEFAULT, SSO_LDAP_AUTH_LICAPP, SSO_LDAP_AUTH_LICAPP_DEFAULT, SSO_LDAP_AUTH_LICFTS, SSO_LDAP_AUTH_LICFTS_DEFAULT, SSO_LDAP_AUTH_LICMASK, SSO_LDAP_AUTH_LICMASK_DEFAULT, SSO_LDAP_AUTH_LICRES1, SSO_LDAP_AUTH_LICRES1_DEFAULT, SSO_LDAP_AUTH_NOTIFYMETH, SSO_LDAP_AUTH_NOTIFYMETH_DEFAULT, SSO_LDAP_AUTH_PASSWORD, SSO_LDAP_AUTH_PORT, SSO_LDAP_AUTH_ROLES, SSO_LDAP_AUTH_ROLES_DEFAULT, SSO_LDAP_AUTH_USE_GROUPS, SSO_LDAP_AUTH_USER_DN, SSO_LDAP_AUTH_USER_FILTER, SSO_LDAP_AUTH_USERBASE, SSO_LDAP_AUTH_USESSL, SSO_LDAP_SSO_VENDOR, SSO_VENDOR_BMC, SSO_VENDOR_BMC_STRING, SSO_VENDOR_ORACLE, SSO_VENDOR_ORACLE_STRING

Constructor Summary

Constructors
Constructor and Description

LDAPProps()

Constructors
Constructor and Description
`LDAPProps()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAuthHost()`
`int`	`getAuthPort()`
`String`	`getBindPasswd()`
`String`	`getBindUser()`
`String`	`getCertKeyStore()`
`String`	`getChaseReferral()`
`String`	`getDefaultEmail()`
`String`	`getDefaultGroups()`
`String`	`getDefaultLicenseApp()`
`int`	`getDefaultLicenseMask()`
`int`	`getDefaultLicenseType()`
`int`	`getDefaultNotifyMech()`
`int`	`getDefaultReservedLicense()`
`String`	`getDefaultRoles()`
`String`	`getEmailAttribName()`
`String`	`getGroupBase()`
`String`	`getGroupFilter()`
`String`	`getLicenseAppAttribName()`
`String`	`getLicenseFTSAttribName()`
`String`	`getLicenseMaskAttribName()`
`String`	`getLicenseRes1AttribName()`
`String`	`getLicenseTypeAttribName()`
`String`	`getNotifyMeth()`
`String`	`getRolesAttribName()`
`int`	`getTimeout()`
`String`	`getURL()`
`int`	`getUseGroups()`
`String`	`getUserBase()`
`String`	`getUserFilter()`
`boolean`	`init(com.bmc.arsys.pluginsvr.plugins.ARPluginContext pluginContext, int i)`
`void`	`setAuthHost(String authHost)`
`void`	`setAuthPort(int authPort)`
`void`	`setBindPasswd(String bindPasswd)`
`void`	`setBindUser(String bindUser)`
`void`	`setCertKeyStore(String storePath)`
`void`	`setChaseReferral(String chaseReferral)`
`void`	`setDefaultEmail(String defaultEmail)`
`void`	`setDefaultGroups(String defaultGroups)`
`void`	`setDefaultLicenseApp(String defaultLicenseApp)`
`void`	`setDefaultLicenseMask(int defaultLicenseMask)`
`void`	`setDefaultLicenseType(int defaultLicenseType)`
`void`	`setDefaultNotifyMech(String defaultNotifyMech)`
`void`	`setDefaultReservedLicense(int defaultReservedLicense)`
`void`	`setDefaultRoles(String defaultRoles)`
`void`	`setEmailAttribName(String emailAttribName)`
`void`	`setGroupBase(String groupBase)`
`void`	`setGroupFilter(String groupFilter)`
`void`	`setLicenseAppAttribName(String licenseAppAttribName)`
`void`	`setLicenseFTSAttribName(String licenseFTSAttribName)`
`void`	`setLicenseMaskAttribName(String licenseMaskAttribName)`
`void`	`setLicenseRes1AttribName(String licenseRes1AttribName)`
`void`	`setLicenseTypeAttribName(String licenseTypeAttribName)`
`void`	`setNotifyMeth(String notifyMeth)`
`void`	`setRolesAttribName(String rolesAttribName)`
`void`	`setTimeout(String extAuthTimeout, String connectTimeout)` There are 2 time out settings 1) External Authentication Timeout 2) LDAP failover timeout Use the one whichever is less .
`void`	`setURL(String uRL)`
`void`	`setUseGroups(String useGroups)`
`void`	`setUserBase(String userBase)`
`void`	`setUserFilter(String userFilter)`
`void`	`setUseSSL(String useSSL)`
`boolean`	`useSSL()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LDAPProps
```
public LDAPProps()
```
- Method Detail
  - init
```
public boolean init(com.bmc.arsys.pluginsvr.plugins.ARPluginContext pluginContext,
                    int i)
             throws com.bmc.arsys.arencrypt.AREncryptionException
```
    Throws:
    
    com.bmc.arsys.arencrypt.AREncryptionException
  - setAuthHost
```
public void setAuthHost(String authHost)
```
  - getAuthHost
```
public String getAuthHost()
```
  - setAuthPort
```
public void setAuthPort(int authPort)
```
  - getAuthPort
```
public int getAuthPort()
```
  - setBindUser
```
public void setBindUser(String bindUser)
```
    Parameters:
    
    bindUser - the bindUser to set
  - getBindUser
```
public String getBindUser()
```
    Returns:
    
    the bindUser
  - setBindPasswd
```
public void setBindPasswd(String bindPasswd)
                   throws com.bmc.arsys.arencrypt.AREncryptionException
```
    Parameters:
    
    bindPasswd - the bindPasswd to set
    
    Throws:
    
    com.bmc.arsys.arencrypt.AREncryptionException
  - getBindPasswd
```
public String getBindPasswd()
```
    Returns:
    
    the bindPasswd
  - setURL
```
public void setURL(String uRL)
```
    Parameters:
    
    uRL - the uRL to set
  - getURL
```
public String getURL()
```
    Returns:
    
    the uRL
  - setTimeout
```
public void setTimeout(String extAuthTimeout,
                       String connectTimeout)
```
    There are 2 time out settings 1) External Authentication Timeout 2) LDAP failover timeout Use the one whichever is less . If none is set use the default time out ie 40.
    
    Parameters:
    
    string - the timeout to set
  - getTimeout
```
public int getTimeout()
```
    Returns:
    
    the timeout
  - setUserBase
```
public void setUserBase(String userBase)
```
    Parameters:
    
    userBase - the userBase to set
  - getUserBase
```
public String getUserBase()
```
    Returns:
    
    the userBase
  - setUserFilter
```
public void setUserFilter(String userFilter)
```
    Parameters:
    
    userFilter - the userFilter to set
  - getUserFilter
```
public String getUserFilter()
```
    Returns:
    
    the userFilter
  - setChaseReferral
```
public void setChaseReferral(String chaseReferral)
```
    Parameters:
    
    chaseReferral - the chaseReferral to set
  - getChaseReferral
```
public String getChaseReferral()
```
    Returns:
    
    the chaseReferral
  - setUseSSL
```
public void setUseSSL(String useSSL)
```
    Parameters:
    
    useSSL - the useSSL to set
  - useSSL
```
public boolean useSSL()
```
    Returns:
    
    the useSSL
  - setCertKeyStore
```
public void setCertKeyStore(String storePath)
```
    Parameters:
    
    useSSL - the useSSL to set
  - getCertKeyStore
```
public String getCertKeyStore()
```
    Returns:
    
    the useSSL
  - setEmailAttribName
```
public void setEmailAttribName(String emailAttribName)
```
    Parameters:
    
    emailAttribName - the emailAttribName to set
  - getEmailAttribName
```
public String getEmailAttribName()
```
    Returns:
    
    the emailAttribName
  - setUseGroups
```
public void setUseGroups(String useGroups)
```
    Parameters:
    
    useGroups - the useGroups to set
  - getUseGroups
```
public int getUseGroups()
```
    Returns:
    
    the useGroups
  - setRolesAttribName
```
public void setRolesAttribName(String rolesAttribName)
```
    Parameters:
    
    rolesAttribName - the rolesAttribName to set
  - getRolesAttribName
```
public String getRolesAttribName()
```
    Returns:
    
    the rolesAttribName
  - setNotifyMeth
```
public void setNotifyMeth(String notifyMeth)
```
    Parameters:
    
    notifyMeth - the notifyMeth to set
  - getNotifyMeth
```
public String getNotifyMeth()
```
    Returns:
    
    the notifyMeth
  - setLicenseMaskAttribName
```
public void setLicenseMaskAttribName(String licenseMaskAttribName)
```
    Parameters:
    
    licenseMaskAttribName - the licenseMaskAttribName to set
  - getLicenseMaskAttribName
```
public String getLicenseMaskAttribName()
```
    Returns:
    
    the licenseMaskAttribName
  - setDefaultLicenseType
```
public void setDefaultLicenseType(int defaultLicenseType)
```
    Parameters:
    
    defaultLicenseType - the defaultLicenseType to set
  - getDefaultLicenseType
```
public int getDefaultLicenseType()
```
    Returns:
    
    the defaultLicenseType
  - setDefaultReservedLicense
```
public void setDefaultReservedLicense(int defaultReservedLicense)
```
    Parameters:
    
    defaultReservedLicense - the defaultReservedLicense to set
  - getDefaultReservedLicense
```
public int getDefaultReservedLicense()
```
    Returns:
    
    the defaultReservedLicense
  - setLicenseTypeAttribName
```
public void setLicenseTypeAttribName(String licenseTypeAttribName)
```
    Parameters:
    
    licenseTypeAttribName - the licenseTypeAttribName to set
  - setDefaultLicenseMask
```
public void setDefaultLicenseMask(int defaultLicenseMask)
```
    Parameters:
    
    licenseTypeAttribName - the licenseTypeAttribName to set
  - getDefaultLicenseMask
```
public int getDefaultLicenseMask()
```
  - getLicenseTypeAttribName
```
public String getLicenseTypeAttribName()
```
    Returns:
    
    the licenseTypeAttribName
  - setDefaultEmail
```
public void setDefaultEmail(String defaultEmail)
```
    Parameters:
    
    defaultEmail - the defaultEmail to set
  - getDefaultEmail
```
public String getDefaultEmail()
```
    Returns:
    
    the defaultEmail
  - setDefaultNotifyMech
```
public void setDefaultNotifyMech(String defaultNotifyMech)
```
    Parameters:
    
    defaultNotifyMech - the defaultNotifyMech to set
  - getDefaultNotifyMech
```
public int getDefaultNotifyMech()
```
    Returns:
    
    the defaultNotifyMech
  - setDefaultRoles
```
public void setDefaultRoles(String defaultRoles)
```
    Parameters:
    
    defaultRoles - the defaultRoles to set
  - getDefaultRoles
```
public String getDefaultRoles()
```
    Returns:
    
    the defaultRoles
  - setLicenseFTSAttribName
```
public void setLicenseFTSAttribName(String licenseFTSAttribName)
```
    Parameters:
    
    licenseFTSAttribName - the licenseFTSAttribName to set
  - getLicenseFTSAttribName
```
public String getLicenseFTSAttribName()
```
    Returns:
    
    the licenseFTSAttribName
  - setLicenseRes1AttribName
```
public void setLicenseRes1AttribName(String licenseRes1AttribName)
```
    Parameters:
    
    licenseRes1AttribName - the licenseRes1AttribName to set
  - getLicenseRes1AttribName
```
public String getLicenseRes1AttribName()
```
    Returns:
    
    the licenseRes1AttribName
  - setLicenseAppAttribName
```
public void setLicenseAppAttribName(String licenseAppAttribName)
```
    Parameters:
    
    licenseAppAttribName - the licenseAppAttribName to set
  - getLicenseAppAttribName
```
public String getLicenseAppAttribName()
```
    Returns:
    
    the licenseAppAttribName
  - setDefaultLicenseApp
```
public void setDefaultLicenseApp(String defaultLicenseApp)
```
    Parameters:
    
    defaultLicenseApp - the defaultLicenseApp to set
  - getDefaultLicenseApp
```
public String getDefaultLicenseApp()
```
    Returns:
    
    the defaultLicenseApp
  - setGroupBase
```
public void setGroupBase(String groupBase)
```
    Parameters:
    
    groupBase - the groupBase to set
  - getGroupBase
```
public String getGroupBase()
```
    Returns:
    
    the groupBase
  - setGroupFilter
```
public void setGroupFilter(String groupFilter)
```
    Parameters:
    
    groupFilter - the groupFilter to set
  - getGroupFilter
```
public String getGroupFilter()
```
    Returns:
    
    the groupFilter
  - setDefaultGroups
```
public void setDefaultGroups(String defaultGroups)
```
    Parameters:
    
    defaultGroups - the defaultGroups to set
  - getDefaultGroups
```
public String getDefaultGroups()
```
    Returns:
    
    the defaultGroups

Class LDAPProps

Field Summary

Fields inherited from interface com.bmc.arsys.plugins.arealdap.LDAPConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LDAPProps

Method Detail

init

setAuthHost

getAuthHost

setAuthPort

getAuthPort

setBindUser

getBindUser

setBindPasswd

getBindPasswd

setURL

getURL

setTimeout

getTimeout

setUserBase

getUserBase

setUserFilter

getUserFilter

setChaseReferral

getChaseReferral

setUseSSL

useSSL

setCertKeyStore

getCertKeyStore

setEmailAttribName

getEmailAttribName

setUseGroups

getUseGroups

setRolesAttribName

getRolesAttribName

setNotifyMeth

getNotifyMeth

setLicenseMaskAttribName

getLicenseMaskAttribName

setDefaultLicenseType

getDefaultLicenseType

setDefaultReservedLicense

getDefaultReservedLicense

setLicenseTypeAttribName

setDefaultLicenseMask

getDefaultLicenseMask

getLicenseTypeAttribName

setDefaultEmail

getDefaultEmail

setDefaultNotifyMech

getDefaultNotifyMech

setDefaultRoles

getDefaultRoles

setLicenseFTSAttribName

getLicenseFTSAttribName

setLicenseRes1AttribName

getLicenseRes1AttribName

setLicenseAppAttribName

getLicenseAppAttribName

setDefaultLicenseApp

getDefaultLicenseApp

setGroupBase

getGroupBase

setGroupFilter

getGroupFilter

setDefaultGroups

getDefaultGroups