Package com.isode.dsapi.config
Class ConfigEntry
java.lang.Object
com.isode.dsapi.config.ManagedObject
com.isode.dsapi.config.ConfigEntry
ConfigEntry represents the root configuration entry (cn=config).
- Since:
- 15.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Integer
static final Integer
static final Integer
static final Integer
Fields inherited from class com.isode.dsapi.config.ManagedObject
logger
-
Constructor Summary
ConstructorsConstructorDescriptionConfigEntry
(Entry entry, IsodeDirectorySession ds) Construct from the entry object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addObjectClass
(String objClassName) Get the admin look through limit.Get the admin size limit.Get the admin time limit.Get AgentX socket.Whether the given attribute type is excluded from change audit logging.Get the value of isodeAuditAttrModsEnable.Whether the given attribute type is excluded from change audit logging.Get the value of authpEnabled.Whether the automatic group updating is enabled.Get the chaining policy.getControlDisabled
(String oid) Whether the given control is disabled.Get the list of permitted _DAP_ authentication modes (isodeDAPAuthModesIExpect).getDSADN()
Get the DSA DN.Return a list of filenames containing certificates that may be used during X.509 strong authenticationDetermine whether CRL checking is required during X.509 strong authenticationGet the name of the LDAP server used for certificate lookups during X.509 strong authentication.Get the port number of the LDAP server used for certificate lookups during X.509 strong authentication.Get the name of the DSA's p12 file that's used for X.509 strong authentication.Get the name of the file containing the passphrase for the DSA's p12 file, for X.509 strong authentication.Get the list of filenames that contain trust anchors for X.509 strong authentication.boolean
Determine whether the "isodeFailoverEnabled" attribute has a value of TRUE in the ConfigEntry.Failover master DN, if there is oneGet the value of httpEnabled.Get HTTP host.Get HTTP port(s).Get the list of enabled Web APIs.Set the list of served file system areas.Get HTTPS port(s).Get the value of isodeExtendedAudit.Gets the value for the attribute isodeRequireLDAPTLSGet the value for isodeSASLAllowAnonymousGet the value for isodeSASLAllowPlainGets the current value of isodeSASLGenericBaseGet the current value for isodeSASLGenericDomainGet the current value of isodeSASLGenericDomainMatchAttrGet the current value of isodeSASLGenericFullMatchAttrGet the current value of isodeSASLGenericNamingAttrReturns the current value for isodeSASLGenericRuleGet the current value of isodeSASLGenericUserMatchAttrGets the current value of isodeSASLGenericUsers.Gets the current value of isodeSASLGSSAPIBaseGet the current value of isodeSASLGSSAPIFullMatchAttrGet the current value of isodeSASLGSSAPINamingAttrGets the current value of isodeSASLGSSAPIRealmGet the current value of isodeSASLGSSAPIRealmMatchAttrGets the current value for isodeSASLGSSAPIRuleGet the current value of isodeSASLGSSAPIUserMatchAttrGets the current value of isodeSASLGSSAPIUsersGets the current value for isodeSASLMaxSSFGets the current value for isodeSASLMinSSFGet the list of permitted LDAP authentication modes (isodeLDAPAuthModesIExpect).boolean
Determine whether the "isodeMESHEnabled" attribute has a value of TRUE in the ConfigEntry.Get the minimum search level.Get isodeMonitorMode string value.Get MPP host.Get MPP port(s).Get MPPTLS port(s).Get the value of ocspEnabled.Get OCSP host.Get OCSP port(s).getPA()
Get the DSA presentation address.Get the paged results garbage collection interval.Get the paged results context timeout.Whether the paged results control is disabled.Get the value of password policy allowed user change attributeGet the value of password policy attribute that is currently activeGet the value of the password auto migrate attribute of the password hashing policyGet the value of the attribute that holds the minimum number of characters that must be used in a passwordGet the value of the attribute which specifies checking the quality of user passwordGet the value of the configured scheme comparators for password hashingGet the value of the configured scheme generators for password hashingGet the value of the attribute that specifies the maximum number of seconds before a password is due to expire that expiration warning messages will be returned to an authenticating userGet the value of the attribute which holds the number of seconds after which the password failures are purgedGet the value of the attribute which governs the number of times an expired password can be used to authenticateGet the value of the attribute that specifies the number of seconds the grace authentications are validGet the value of the attribute that specifies the maximum time in seconds for which the password history will be keptGet the value of attribute which specifies the maximum number of used passwords stored in historyGet the value of the attribute that specifies whether the password should be used to authenticate after a specified number of consecutive failed bind attemptsGet the value of the attribute that holds the number of seconds that the password cannot be used to authenticate due to too many failed bind attemptsGet the attribute that holds maximum age of the passwordGet the value of the attribute that specifies the maximum number of seconds to delay when responding to a failed authentication attempt.Get the value of the attribute that specifies the number of consecutive failed bind attempts after which the password may not be used to authenticateGet the value of the attribute that specifies the number of seconds an account may remain unused before it becomes lockedGet the value of the attribute that holds the maximum number of characters that must be used in a passwordGet the value of attribute that holds the number of seconds that must elapse between modifications to the passwordGet the value of the attribute that specifies the number of seconds to delay when responding to a failed authentication attempt.Get the value of the attribute that holds the minimum number of characters that must be used in a passwordGet the value for the attribute which decides whether the user must change password on first loginGet the value of password policy attribute which determines whether the existing password should be sent along with the new password during changeGet the value for saslAvailableMechanismsGet the shadow failure delay.Get the shadow on change hold open.Get the shadow prune period.Get the shadow retry delay.getSNMP()
Get SNMP enabled boolean.Whether the server side sorting control is disabled.Get the superior knowledge reference.Get the path of the TLS attribute CaCertificate file which is supposed to contain a list of PEM certificatesGet the value of the TLS attribute that determines the CRL checking for TLSGet the list of configured cipher suites which is a list of integer values but in a String array so that its easy for us to update them using dsapi APIsGet the value for the TLS attribute for DH parameters pathGet the value for TLS attribute dontTrustIdentitiesGet the Key Info path for TLS which is a directory relative to the DSA's directory where TLS related identities and other stuff is storedGet the attribute value that servers as the LDAP hostname during TLS verificationGet the value that has been configured for TLS Ldap verify portGet the list of files names that contain the trust anchors for TLS.Get the value for the TLS attribute RandomSeedpathGet the value for the attribute TLS session cache timeoutGet the support flags for TLSGet the list of certificate files(DSA expects DER format) containing TLS trust anchorsGet the value for the attribute TLS verify clientGet the value for the attribute TLS verify depthboolean
Indicates if the TLS attribute isodeRequireLDAPTLS has changedboolean
Check if this DSA is configured as a failover master.boolean
isObjectClassPresent
(String objClassName) void
Load values from an entry.void
removeObjectClass
(String objClassName) void
setAdminLookThruLimit
(Integer limit) Set admin look through limit.void
setAdminSizeLimit
(Integer limit) Set admin size limit.void
setAdminTimeLimit
(Integer limit) Set admin time limit.void
setAgentXSocket
(String value) Set the value of the configured scheme generators for password hashingvoid
setAuditAttrModsCountOnly
(List<String> types) Add the given OID to the list of attributes excluded from audit logging of changes.Set the value of isodeAuditAttrModsEnable.void
setAuditAttrModsExclude
(List<String> types) Add the given OID to the list of attributes excluded from audit logging of changes.setAuthpEnabled
(Boolean flag) Set the value of authpEnabled.Set the value of isodeAutoGroupUpdateEnabled.void
setChainPolicy
(ChainPolicy newChainPolicy) Set the chain policy.void
setControlDisabled
(String oid, boolean disabled) Add the given OID to the list of disabled controls (as values of disabledControl).void
setDAPAuthModesIExpect
(Set<Integer> modes) Set the list of permitted _DAP_ authentication modes (isodeDAPAuthModesIExpect).void
setDsaStrongAuthCertificate
(List<String> values) Update the list of filenames that contain "other" certs for X.509 strong authentication.void
Set whether or not CRL checking is performed during X.509 strong authenticationvoid
setDsaStrongAuthLDAPhost
(String value) Set the name of the LDAP host for X.509 strong authentication.void
setDsaStrongAuthLDAPport
(Integer newValue) Set the port number of the LDAP server used for certificate lookups during X.509 strong authentication.void
setDsaStrongAuthP12file
(String value) Set the name of the DSA's p12 file for X.509 strong authentication.void
setDsaStrongAuthPPHRfile
(String value) Set the name of the file with the passphrase for the DSA's p12 file used for X.509 strong authentication.void
setDsaStrongAuthTrustAnchor
(List<String> values) Update the list of filenames that contain trust anchors for X.509 strong authentication.void
setFailoverEnabled
(Boolean flag) Set failover enabled.void
setFailoverMaster
(DN dn) Set failover enabled.void
setFailoverTarget
(DN dn) Set failover target.setHTTPEnabled
(Boolean flag) Set the value of httpEnabled.void
setHTTPHost
(String value) Set the value of httpHost.void
setHTTPPort
(String value) Set the value of httpHost as a space separated list of string encoded integers.void
setHTTPServedAPIs
(List<String> values) Get the list of enabled Web APIs.void
setHTTPServedDirs
(List<String> values) Set the list of served file system areas.void
setHTTPSPort
(String value) Set the value of httpsHost as a space separated list of string encoded integers.setIsodeExtendedAudit
(Boolean flag) Set the value of isodeExtendedAudit.void
Sets the value for the TLS attribute isodeRequireLDAPTLSSet the value for isodeSASLAllowAnonymousSet the value for isodeSASLAllowPlainsetIsodeSASLGenericBase
(DN newValue) Sets of clears the value of isodeSASLGenericBasesetIsodeSASLGenericDomain
(String newValue) Sets or clears the value of isodeSASLGenericDomainSet the value for isodeSASLGenericDomainMatchAttrSet the value for isodeSASLGenericFullMatchAttrsetIsodeSASLGenericNamingAttr
(AttributeType newValue) Set the value for isodeSASLGenericNamingAttrsetIsodeSASLGenericRule
(Integer newValue) Sets or clears the current value for isodeSASLGenericRukeSet the value for isodeSASLGenericUserMatchAttrsetIsodeSASLGenericUsers
(DN newValue) Sets of clears the value of isodeSASLGenericUsers.setIsodeSASLGSSAPIBase
(DN newValue) Sets of clears the value of isodeSASLGSSAPIBasesetIsodeSASLGSSAPIFullMatchAttr
(AttributeType newValue) Set the value for isodeSASLGSSAPIFullMatchAttrsetIsodeSASLGSSAPINamingAttr
(AttributeType newValue) Set the value for isodeSASLGSSAPINamingAttrsetIsodeSASLGSSAPIRealm
(String newValue) Sets or clears the value of isodeSASLGSSAPIRealmSet the value for isodeSASLGSSAPIRealmMatchAttrsetIsodeSASLGSSAPIRule
(Integer newValue) Sets or clears the current value for isodeSASLGSSAPIRule.setIsodeSASLGSSAPIUserMatchAttr
(AttributeType newValue) Set the value for isodeSASLGSSAPIUserMatchAttrsetIsodeSASLGSSAPIUsers
(DN newValue) Sets of clears the value of isodeSASLGSSAPIUserssetIsodeSASLMaxSSF
(Integer newValue) Sets or clears the current value for isodeSASLMaxSSF.setIsodeSASLMinSSF
(Integer newValue) Sets or clears the current value for isodeSASLMinSSF.void
setLDAPAuthModesIExpect
(Set<Integer> modes) Set the list of permitted LDAP authentication modes (isodeLDAPAuthModesIExpect).void
setMESHEnabled
(Boolean flag) Set MESH enabled.void
Set the presentation address of the server that will provision data in a new and bare multimaster server.void
setMinSearchLevel
(Integer level) Set minimum search level.void
setMonitorMode
(MonitorMode value) Set the value of the configured scheme generators for password hashingvoid
setMPPHost
(String value) Set the value of mppHost.void
setMPPPort
(String value) Set the value of mppHost as a space separated list of string encoded integers.void
setMPPTLSPort
(String value) Set the value of mppTLSHost as a space separated list of string encoded integers.setOCSPEnabled
(Boolean flag) Set the value of ocspEnabled.void
setOCSPHost
(String value) Set the value of ocspHost.void
setOCSPPort
(String value) Set the value of ocspPort as a space separated list of string encoded integers.void
Set the presentation address.void
setPagedResultsGCInterval
(Integer interval) Set the paged results garbage collection interval.void
setPagedResultsTimeout
(Integer timeout) Set the paged results timeout.void
setPagingDisabled
(boolean disabled) Enable or disable the paged results control.void
setPwdAllowUserChange
(Boolean value) Set the value for the attribute which allows a user to change passwordsvoid
setPwdAttribute
(String value) Set the value of password policy attribute that is currently activevoid
setPwdAutoMigrate
(Boolean value) Set the value for password auto migrate attribute of the password hashing policyvoid
setPwdCheckEntropy
(Integer newValue) Set the value of the attribute that holds the minimum number of characters that must be used in a passwordvoid
setPwdCheckQuality
(Integer newValue) Set the value of the attribute which specifies checking the quality of user passwordvoid
setPwdConfiguredSchemeComparators
(List<String> values) Set the value of the configured scheme generators for password hashingvoid
Set the value of the configured scheme generators for password hashingvoid
setPwdExpireWarning
(Integer newValue) Set the value of the attribute that specifies the maximum number of seconds before a password is due to expire that expiration warning messages will be returned to an authenticating uservoid
setPwdFailureCountInterval
(Integer newValue) Set the value of the attribute which holds the number of seconds after which the password failures are purgedvoid
setPwdGraceAuthNLimit
(Integer newValue) Set the value for the attribute which governs the number of times an expired password can be used to authenticatevoid
setPwdGraceExpiry
(Integer newValue) Set the value of the attribute that specifies the number of seconds the grace authentications are validvoid
setPwdHistoryDuration
(Integer newValue) Set the value of the attribute that specifies the maximum time in seconds for which the password history will be keptvoid
setPwdInHistory
(Integer newValue) Set the value of the attribute which specifies the maximum number of used passwords storedvoid
setPwdLockOut
(Boolean value) Set the value of the attribute that specifies whether the password should be used to authenticate after a specified number of consecutive failed bind attemptsvoid
setPwdLockoutDuration
(Integer newValue) Set the value of attribute which holds the number of seconds that the password cannot be used to authenticate due to too many failed bind attemptsvoid
setPwdMaxAge
(Integer newValue) Set the value of the attribute that holds the maximum age of the passwordvoid
setPwdMaxDelay
(Integer newValue) Set the value of the attribute that specifies the maximum number of seconds to delay when responding to a failed authentication attempt.void
setPwdMaxFailure
(Integer newValue) Set the value of the attribute that specifies the number of consecutive failed bind attempts after which the password may not be used to authenticatevoid
setPwdMaxIdle
(Integer newValue) Set the value of the attribute that specifies the number of seconds an account may remain unused before it becomes lockedvoid
setPwdMaxLength
(Integer newValue) Set the value of the attribute that holds the maximum number of characters that must be used in a passwordvoid
setPwdMinAge
(Integer newValue) Set the value of attribute that holds the number of seconds that must elapse between modifications to the passwordvoid
setPwdMinDelay
(Integer newValue) Set the value of the attribute that specifies the number of seconds to delay when responding to a failed authentication attempt.void
setPwdMinLength
(Integer newValue) Set the value of the attribute that holds the minimum number of characters that must be used in a passwordvoid
setPwdMustChange
(Boolean value) Set the value for the attribute which decides whether the password must change after first loginvoid
setPwdSafeModify
(Boolean value) Set the value for the attribute which allows sending of existing password with new passwordsetSASLAvailableMechanisms
(String newValue) Set the value for saslAvailableMechanisms.void
setShadowFailDelay
(Integer newValue) Set shadow failure delay.void
setShadowOnChangeOpen
(Boolean flag) Set the shadow on change hold open flag.void
setShadowPrunePeriod
(Integer newValue) Set shadow prune period.void
setShadowRetryDelay
(Integer newValue) Set shadow retry delay.Set the value for snmp.void
setSortingDisabled
(boolean disabled) Enable or disable the server side sorting control.void
setSuperiorKnowledge
(AccessPoint supRefAP) Set the superior knowledge reference.void
setTlsCaCertificateFile
(String value) Set the value for the TLS attribute for CA Certificate file which is the path to the file containing list of PEM certificatesvoid
setTlsCheckCRLs
(Boolean flag) Set the value for the attribute for TLS CRL checkvoid
setTlsConfiguredCipherSuites
(List<Integer> values) Set the list of cipher suites for TLS configuration.void
setTlsDHParamsPath
(String value) Set the value for the TLS attribute DH Parameters pathvoid
Set the value for the TLS attribute dontTrustIdentitiesvoid
setTlsKeyInfoPaths
(String value) Set the value of the attribute for key info pathsvoid
setTlsLDAPhost
(String value) Set the value of hostname attribute to be used in TLS verificationvoid
setTlsLDAPport
(Integer newValue) Set the value for attribute TLS LDAP portvoid
setTlsOtherCertificates
(List<String> tlsOtherCerts) Set the TLS attribute for setting the path of other certificatesvoid
setTlsRandomSeedPath
(String value) Set the value for attribute TLS random seed pathvoid
setTlsSessionCacheTimeout
(Integer value) Set the value for the TLS attribute session cache timeoutvoid
Set the value for the attribute holding TLS support flagsvoid
setTlsTrustAnchor
(List<String> tlsTrustAnchors) Set the list of trust anchors to the ConfigEntryvoid
Set the value of attribute TLS verify Clientvoid
setTlsVerifyDepth
(Integer value) Set the value for TLS verify depth attributeMethods inherited from class com.isode.dsapi.config.ManagedObject
addAttribute, addAttribute, addAttribute, addAttributeValue, addAttributeValue, addEntry, addOC, checkMandatory, checkMandatory, checkMandatory, checkMandatory, commit, commitNoRefresh, createAP, createAttributeType, createDN, createPA, createRDN, createRDN, getAttribute, getAttributeDefaultWhenNull, getDN, getIsodeDirectorySession, getMultiValueBer, getMultiValuedInteger, getMultiValuedInteger, getMultiValuedString, getMultiValuedString, getPA, getValue, getValueAttrTypeFromOID, getValueBer, getValueBoolean, getValueDate, getValueDate, getValueDN, getValueInteger, getValueInteger, getValueString, getValueString, getValueStringFromAttribute, hasAttributeChanged, hasChanges, remove, removeAttr, removeStringValue, reset, reset, updateAttr, updateAttr, updateAttr, updateBoolean, updateDN, updateInteger, updateMultiValuedBER, updateMultiValuedInteger, updateMultiValuedString, updatePA, updatePA, updateString
-
Field Details
-
AUTH_MODE_NONE
-
AUTH_MODE_SIMPLE
-
AUTH_MODE_STRONG
-
AUTH_MODE_SASL
-
-
Constructor Details
-
ConfigEntry
Construct from the entry object.- Parameters:
entry
- Entry representing the config.ds
- Isode directory session- Throws:
ConfigOpFailedException
- if mandatory attributes are not loaded
-
-
Method Details
-
load
Description copied from class:ManagedObject
Load values from an entry. No directory operation should be done in this method.Mandatory variables are assigned only after everything is ok. This is done so during re-loading, if there are exceptions and even then the object is used, there is no crash by using mandatory variables that are assumed to have non-null values.
- Specified by:
load
in classManagedObject
- Parameters:
entry
- Entry representing the object, could be null if the existing entry has to be reloaded- Throws:
ConfigOpFailedException
- if mandatory attributes are not loaded
-
getDSADN
Get the DSA DN.- Returns:
- DSA DN
-
getPA
Get the DSA presentation address.- Returns:
- Presentation address
-
addObjectClass
-
removeObjectClass
-
isObjectClassPresent
-
setPA
Set the presentation address.- Parameters:
pa
- Presentation address, should not be null
-
setMESHInitPA
Set the presentation address of the server that will provision data in a new and bare multimaster server.- Parameters:
pa
- Presentation address, should not be null
-
getSuperiorKnowledge
Get the superior knowledge reference.- Returns:
- Superior knowledge reference, will be null if absent.
-
setSuperiorKnowledge
Set the superior knowledge reference.- Parameters:
supRefAP
- Superior knowledge reference, null to remove the attribute
-
getAdminSizeLimit
Get the admin size limit.- Returns:
- Admin size limit
-
setAdminSizeLimit
Set admin size limit. If the value set is null, the attribute is deleted.- Parameters:
limit
- Admin size limit, null to clear
-
getAdminLookThruLimit
Get the admin look through limit.- Returns:
- Admin look through limit
-
setAdminLookThruLimit
Set admin look through limit. If the value null, the attribute is deleted.- Parameters:
limit
- Admin look through limit, null to clear
-
getAdminTimeLimit
Get the admin time limit.- Returns:
- Admin time limit
-
setAdminTimeLimit
Set admin time limit.- Parameters:
limit
- Admin time limit, null to clear
-
getPagedResultsGCInterval
Get the paged results garbage collection interval.- Returns:
- Paged results garbage collection interval, null indicates no attribute value present.
- Since:
- 16.0
-
setPagedResultsGCInterval
Set the paged results garbage collection interval.- Parameters:
interval
- Paged results garbage collection interval, null to clear.- Since:
- 16.0
-
getPagedResultsTimeout
Get the paged results context timeout.- Returns:
- Paged results context timeout, null indicates no attribute value present.
- Since:
- 16.0
-
setPagedResultsTimeout
Set the paged results timeout.- Parameters:
timeout
- Paged results timeout, null to clear.- Since:
- 16.0
-
getMinSearchLevel
Get the minimum search level.- Returns:
- Minimum search level
-
setMinSearchLevel
Set minimum search level.- Parameters:
level
- Minimum search level, null to clear
-
getPagingDisabled
Whether the paged results control is disabled.- Returns:
- boolean - True if the paged results control OID is a value of disabledControls, false otherwise.
- Since:
- 15.2
-
setPagingDisabled
public void setPagingDisabled(boolean disabled) Enable or disable the paged results control.- Parameters:
disabled
- True means that the paged results control will be in the list of disabled controls; False means it will not be in the list of disabled controls.- Since:
- 15.2
-
getSortingDisabled
Whether the server side sorting control is disabled.- Returns:
- boolean - True if the server side sorting control OID is a value of disabledControls, false otherwise.
- Since:
- 15.2
-
setSortingDisabled
public void setSortingDisabled(boolean disabled) Enable or disable the server side sorting control.- Parameters:
disabled
- True means that the server side sorting control will be in the list of disabled controls; False means it will not be in the list of disabled controls.- Since:
- 15.2
-
getControlDisabled
Whether the given control is disabled.- Parameters:
oid
- OID of control. Must not be null- Returns:
- boolean - True if the control OID is a value of disabledControls, false otherwise.
- Throws:
BadValueException
- if specified oid is not recognized.- Since:
- 15.2
-
setControlDisabled
Add the given OID to the list of disabled controls (as values of disabledControl).- Parameters:
oid
- the OID of the control to be enabled/disabled. Must not be null.disabled
- True means that this control will be in the list of disabled controls; False means it will not be in the list of values of disabledControls.- Throws:
BadValueException
- if oid is not a valid representation of a control's OID.- Since:
- 15.2
-
getShadowOnChangeOpen
Get the shadow on change hold open.- Returns:
- Shadow on change hold open
-
setShadowOnChangeOpen
Set the shadow on change hold open flag.- Parameters:
flag
- Shadow on change hold open flag, null to clear
-
getShadowRetryDelay
Get the shadow retry delay.- Returns:
- Shadow retry delay
-
setShadowRetryDelay
Set shadow retry delay.- Parameters:
newValue
- Shadow retry delay, if null, the attribute will be deleted
-
getShadowFailDelay
Get the shadow failure delay.- Returns:
- Shadow failure delay
-
setShadowFailDelay
Set shadow failure delay.- Parameters:
newValue
- Shadow failure delay, if null the attribute will be deleted
-
getShadowPrunePeriod
Get the shadow prune period.- Returns:
- Shadow prune period
-
setShadowPrunePeriod
Set shadow prune period.- Parameters:
newValue
- Shadow prune period,if null the attribute will be deleted
-
getDsaStrongAuthTrustAnchor
Get the list of filenames that contain trust anchors for X.509 strong authentication.- Returns:
- a list of filenames, or an empty list if none are set. Will never be null.
-
setDsaStrongAuthTrustAnchor
Update the list of filenames that contain trust anchors for X.509 strong authentication.- Parameters:
values
- a list of filenames, or null/empty list to clear the value altogether.
-
getDsaStrongAuthP12file
Get the name of the DSA's p12 file that's used for X.509 strong authentication. The value returned is either an absolute path to the file (e.g. "/var/isode/dsa/x509/identity.p12"), or a path which is relative to the DSA's directory (e.g. "x509/identity.p12").- Returns:
- a filename, or null if none is set.
-
setDsaStrongAuthP12file
Set the name of the DSA's p12 file for X.509 strong authentication.- Parameters:
value
- the new value, or null to clear. The value should be either an absolute path (e.g. "/etc/file.dat") or a path which is relative to the DSA's directory (e.g. "x509/file.dat").
-
getDsaStrongAuthPPHRfile
Get the name of the file containing the passphrase for the DSA's p12 file, for X.509 strong authentication. The value returned is either an absolute path to the file (e.g. "/var/isode/dsa/x509/identity.p12.pphr"), or a path which is relative to the DSA's directory (e.g. "x509/identity.p12.pphr").- Returns:
- a filename, or null if none is set.
-
setDsaStrongAuthPPHRfile
Set the name of the file with the passphrase for the DSA's p12 file used for X.509 strong authentication.- Parameters:
value
- filename, or null to clear.
-
getDsaStrongAuthLDAPhost
Get the name of the LDAP server used for certificate lookups during X.509 strong authentication.- Returns:
- a hostname, or null if none is set.
-
setDsaStrongAuthLDAPhost
Set the name of the LDAP host for X.509 strong authentication.- Parameters:
value
- hostname, or null to clear.
-
getDsaStrongAuthLDAPport
Get the port number of the LDAP server used for certificate lookups during X.509 strong authentication.- Returns:
- an Integer value, or null if none is set.
-
setDsaStrongAuthLDAPport
Set the port number of the LDAP server used for certificate lookups during X.509 strong authentication.- Parameters:
newValue
- new value, null to remove the attribute
-
getDsaStrongAuthCheckCRLs
Determine whether CRL checking is required during X.509 strong authentication- Returns:
- a Boolean value, or null if no value is set.
-
setDsaStrongAuthCheckCRLs
Set whether or not CRL checking is performed during X.509 strong authentication- Parameters:
flag
- Boolean value, null to clear.
-
getDsaStrongAuthCertificate
Return a list of filenames containing certificates that may be used during X.509 strong authentication- Returns:
- a list of filenames, or empty list if none are specified. Will never be null.
-
setDsaStrongAuthCertificate
Update the list of filenames that contain "other" certs for X.509 strong authentication.- Parameters:
values
- a list of filenames, or null/empty list to clear the value altogether.
-
getTlsTrustAnchor
Get the list of certificate files(DSA expects DER format) containing TLS trust anchors- Returns:
- list of certificate files or empty list if none are specified. Will never be null.
-
setTlsTrustAnchor
Set the list of trust anchors to the ConfigEntry- Parameters:
tlsTrustAnchors
- list of files containing trust anchors, or null/empty list to clear the value altogether.
-
getTlsConfiguredCipherSuites
Get the list of configured cipher suites which is a list of integer values but in a String array so that its easy for us to update them using dsapi APIs- Returns:
- configured cipher suites list or empty list if none are specified. Will never be null.
-
setTlsConfiguredCipherSuites
Set the list of cipher suites for TLS configuration. It is assumed that user passes a list of integers to this method.- Parameters:
values
- list of TLS cipher suites , or null/empty list to clear the value altogether.
-
getTlsKeyInfoPaths
Get the Key Info path for TLS which is a directory relative to the DSA's directory where TLS related identities and other stuff is stored- Returns:
- value of the TLS Key info path variable or null if none is specified.
-
setTlsKeyInfoPaths
Set the value of the attribute for key info paths- Parameters:
value
- tls key info path value to set , or null to clear the value altogether.
-
getTlsDHParamsPath
Get the value for the TLS attribute for DH parameters path- Returns:
- attribute value for TLS DH Parameters path or null if none is specified.
-
setTlsDHParamsPath
Set the value for the TLS attribute DH Parameters path- Parameters:
value
- value to be set, or null to clear the value altogether.
-
getTlsRandomSeedPath
Get the value for the TLS attribute RandomSeedpath- Returns:
- attribute value for TLS random seed path or null if none is specified.
-
setTlsRandomSeedPath
Set the value for attribute TLS random seed path- Parameters:
value
- attribute value to be set for TLS random seed path, or null to clear the value altogether.
-
getTlsSessionCacheTimeout
Get the value for the attribute TLS session cache timeout- Returns:
- value for the TLS session cache timeout or null if none is specified.
-
setTlsSessionCacheTimeout
Set the value for the TLS attribute session cache timeout- Parameters:
value
- value to be set for the TLS attribute session cache timeout, or null to clear the value altogether.
-
getTlsSupportFlags
Get the support flags for TLS- Returns:
- value of TLS support flags or null if none are specified.
-
setTlsSupportFlags
Set the value for the attribute holding TLS support flags- Parameters:
value
- value to set for TLS support flags, or null to clear the value altogether.
-
getTlsVerifyClient
Get the value for the attribute TLS verify client- Returns:
- attribute value for TLS verify client or null if none is specified.
-
setTlsVerifyClient
Set the value of attribute TLS verify Client- Parameters:
value
- value to be set for TLS verify client, or null to clear the value altogether.
-
getTlsVerifyDepth
Get the value for the attribute TLS verify depth- Returns:
- attribute value for TLS verify depth or null if none is specified.
-
setTlsVerifyDepth
Set the value for TLS verify depth attribute- Parameters:
value
- value to be set for TLS verify depth, or null to clear the value altogether.
-
getTlsLDAPport
Get the value that has been configured for TLS Ldap verify port- Returns:
- attribute value for TLS LDAP verify port or null if none is specified.
-
setTlsLDAPport
Set the value for attribute TLS LDAP port- Parameters:
newValue
- value to be set for TLS LDAP port, or null to clear the value altogether.
-
getTlsCaCertificateFile
Get the path of the TLS attribute CaCertificate file which is supposed to contain a list of PEM certificates- Returns:
- value for attribute TLS CA Certificate file or null if none is specified.
-
setTlsCaCertificateFile
Set the value for the TLS attribute for CA Certificate file which is the path to the file containing list of PEM certificates- Parameters:
value
- value to be set for attribute TLS CA Certificate file, or null to clear the value altogether.- Throws:
ConfigOpFailedException
- if the value could not be updated.
-
getTlsOtherCertificates
Get the list of files names that contain the trust anchors for TLS. These files are supposed to be containing certificates in DER format- Returns:
- list of trust anchor files or empty list if none are specified. Will never be null.
-
setTlsOtherCertificates
Set the TLS attribute for setting the path of other certificates- Parameters:
tlsOtherCerts
- list of filenames pointing to certificate files which are supposed to be in DER format, or null/empty list to clear the value altogether.
-
getTlsLDAPhost
Get the attribute value that servers as the LDAP hostname during TLS verification- Returns:
- TLS ldap hostname value or null if none is specified.
-
setTlsLDAPhost
Set the value of hostname attribute to be used in TLS verification- Parameters:
value
- TLS LDAP hostname, or null to clear the value altogether.
-
getTlsCheckCRLs
Get the value of the TLS attribute that determines the CRL checking for TLS- Returns:
- attribute value for TLS CRL check or null if none is specified.
-
setTlsCheckCRLs
Set the value for the attribute for TLS CRL check- Parameters:
flag
- value to be set for TLS CRL check, or null to clear the value altogether.
-
getTlsDontTrustIdentities
Get the value for TLS attribute dontTrustIdentities- Returns:
- attribute value or null if none is specified.
-
setTlsDontTrustIdentities
Set the value for the TLS attribute dontTrustIdentities- Parameters:
flag
- value to be set for the attribute, or null to clear the value altogether.
-
getIsodeRequireLDAPTLS
Gets the value for the attribute isodeRequireLDAPTLS- Returns:
- attribute value or null if none is specified
-
setIsodeRequireLDAPTLS
Sets the value for the TLS attribute isodeRequireLDAPTLS- Parameters:
flag
- Value to be set for the attribute, or null to clear
-
hasIsodeRequestLDAPTLSChanged
public boolean hasIsodeRequestLDAPTLSChanged()Indicates if the TLS attribute isodeRequireLDAPTLS has changed- Returns:
true
if it has changed,false
if it has not changed (or could not be found)
-
getIsodeSASLGenericRule
Returns the current value for isodeSASLGenericRule- Returns:
- the current value, which may be null.
-
setIsodeSASLGenericRule
Sets or clears the current value for isodeSASLGenericRuke- Parameters:
newValue
- new value, which may be null to remove the value.- Returns:
- the new value
-
getIsodeSASLGSSAPIRule
Gets the current value for isodeSASLGSSAPIRule- Returns:
- the current value, which may be null.
-
setIsodeSASLGSSAPIRule
Sets or clears the current value for isodeSASLGSSAPIRule.- Parameters:
newValue
- the new value, which may be null to remove the value- Returns:
- the new value
-
getIsodeSASLGenericDomain
Get the current value for isodeSASLGenericDomain- Returns:
- the current value, which may be null.
-
setIsodeSASLGenericDomain
Sets or clears the value of isodeSASLGenericDomain- Parameters:
newValue
- the new value, which may be null to remove the value- Returns:
- the new value
-
getIsodeSASLGSSAPIRealm
Gets the current value of isodeSASLGSSAPIRealm- Returns:
- the current value, which may be null.
-
setIsodeSASLGSSAPIRealm
Sets or clears the value of isodeSASLGSSAPIRealm- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getIsodeSASLGenericBase
Gets the current value of isodeSASLGenericBase- Returns:
- the current value, which may be null.
-
setIsodeSASLGenericBase
Sets of clears the value of isodeSASLGenericBase- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getIsodeSASLGSSAPIBase
Gets the current value of isodeSASLGSSAPIBase- Returns:
- the current value, which may be null.
-
setIsodeSASLGSSAPIBase
Sets of clears the value of isodeSASLGSSAPIBase- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getIsodeSASLGenericNamingAttr
Get the current value of isodeSASLGenericNamingAttr- Returns:
- the current value, which may be null.
-
setIsodeSASLGenericNamingAttr
Set the value for isodeSASLGenericNamingAttr- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getIsodeSASLGSSAPINamingAttr
Get the current value of isodeSASLGSSAPINamingAttr- Returns:
- the current value, which may be null.
-
setIsodeSASLGSSAPINamingAttr
Set the value for isodeSASLGSSAPINamingAttr- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getIsodeSASLGenericDomainMatchAttr
Get the current value of isodeSASLGenericDomainMatchAttr- Returns:
- the current value, which may be null.
-
setIsodeSASLGenericDomainMatchAttr
Set the value for isodeSASLGenericDomainMatchAttr- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getIsodeSASLGSSAPIRealmMatchAttr
Get the current value of isodeSASLGSSAPIRealmMatchAttr- Returns:
- the current value, which may be null.
-
setIsodeSASLGSSAPIRealmMatchAttr
Set the value for isodeSASLGSSAPIRealmMatchAttr- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getPwdLockOut
Get the value of the attribute that specifies whether the password should be used to authenticate after a specified number of consecutive failed bind attempts- Returns:
- value of the attribute or null if none is present
-
setPwdLockOut
Set the value of the attribute that specifies whether the password should be used to authenticate after a specified number of consecutive failed bind attempts- Parameters:
value
- value to set or null to clear the value altogether.
-
getPwdMustChange
Get the value for the attribute which decides whether the user must change password on first login- Returns:
- value of the attribute or null if none is present
-
setPwdMustChange
Set the value for the attribute which decides whether the password must change after first login- Parameters:
value
- value to set or null to clear the value altogether.
-
getPwdAllowUserChange
Get the value of password policy allowed user change attribute- Returns:
- value of the attribute or null if none is present
-
setPwdAllowUserChange
Set the value for the attribute which allows a user to change passwords- Parameters:
value
- value to set or null to clear the value altogether.
-
getPwdSafeModify
Get the value of password policy attribute which determines whether the existing password should be sent along with the new password during change- Returns:
- value of the attribute or null if none is present
-
setPwdSafeModify
Set the value for the attribute which allows sending of existing password with new password- Parameters:
value
- value to set or null to clear the value altogether.
-
getPwdAutoMigrate
Get the value of the password auto migrate attribute of the password hashing policy- Returns:
- value of the attribute or null if none is present
-
setPwdAutoMigrate
Set the value for password auto migrate attribute of the password hashing policy- Parameters:
value
- value to set or null to clear the value altogether.
-
getPwdGraceAuthNLimit
Get the value of the attribute which governs the number of times an expired password can be used to authenticate- Returns:
- value of the attribute or null if none is present
-
setPwdGraceAuthNLimit
Set the value for the attribute which governs the number of times an expired password can be used to authenticate- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdInHistory
Get the value of attribute which specifies the maximum number of used passwords stored in history- Returns:
- value of the attribute or null if none is present
-
setPwdInHistory
Set the value of the attribute which specifies the maximum number of used passwords stored- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdLockoutDuration
Get the value of the attribute that holds the number of seconds that the password cannot be used to authenticate due to too many failed bind attempts- Returns:
- value of the attribute or null if none is present
-
setPwdLockoutDuration
Set the value of attribute which holds the number of seconds that the password cannot be used to authenticate due to too many failed bind attempts- Parameters:
newValue
- new value to or set null to remove the attribute
-
setPwdExpireWarning
Set the value of the attribute that specifies the maximum number of seconds before a password is due to expire that expiration warning messages will be returned to an authenticating user- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdExpireWarning
Get the value of the attribute that specifies the maximum number of seconds before a password is due to expire that expiration warning messages will be returned to an authenticating user- Returns:
- value of the attribute or null if none is present
-
getPwdCheckQuality
Get the value of the attribute which specifies checking the quality of user password- Returns:
- value of the attribute or null if none is present
-
setPwdCheckQuality
Set the value of the attribute which specifies checking the quality of user password- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdFailureCountInterval
Get the value of the attribute which holds the number of seconds after which the password failures are purged- Returns:
- value of the attribute or null if none is present
-
setPwdFailureCountInterval
Set the value of the attribute which holds the number of seconds after which the password failures are purged- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getIsodeSASLGenericUserMatchAttr
Get the current value of isodeSASLGenericUserMatchAttr- Returns:
- the current value, which may be null.
-
setIsodeSASLGenericUserMatchAttr
Set the value for isodeSASLGenericUserMatchAttr- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getIsodeSASLGSSAPIUserMatchAttr
Get the current value of isodeSASLGSSAPIUserMatchAttr- Returns:
- the current value, which may be null.
-
setIsodeSASLGSSAPIUserMatchAttr
Set the value for isodeSASLGSSAPIUserMatchAttr- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getIsodeSASLGenericFullMatchAttr
Get the current value of isodeSASLGenericFullMatchAttr- Returns:
- the current value, which may be null.
-
setIsodeSASLGenericFullMatchAttr
Set the value for isodeSASLGenericFullMatchAttr- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getIsodeSASLGSSAPIFullMatchAttr
Get the current value of isodeSASLGSSAPIFullMatchAttr- Returns:
- the current value, which may be null.
-
setIsodeSASLGSSAPIFullMatchAttr
Set the value for isodeSASLGSSAPIFullMatchAttr- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getIsodeSASLGenericUsers
Gets the current value of isodeSASLGenericUsers. This is a DN value, but it holds a sequence of RDNs rather than an actual absolute DN that you could find in the directory.- Returns:
- the current value, which may be null.
-
setIsodeSASLGenericUsers
Sets of clears the value of isodeSASLGenericUsers. This is a DN value, but it holds a sequence of RDNs rather than an actual absolute DN that you could find in the directory.- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getIsodeSASLGSSAPIUsers
Gets the current value of isodeSASLGSSAPIUsers- Returns:
- the current value, which may be null.
-
setIsodeSASLGSSAPIUsers
Sets of clears the value of isodeSASLGSSAPIUsers- Parameters:
newValue
- the new value, which may be null to clear the value- Returns:
- the new value
-
getIsodeSASLMinSSF
Gets the current value for isodeSASLMinSSF- Returns:
- the current value, which may be null.
-
setIsodeSASLMinSSF
Sets or clears the current value for isodeSASLMinSSF.- Parameters:
newValue
- the new value, which may be null to remove the value- Returns:
- the new value
-
getIsodeSASLMaxSSF
Gets the current value for isodeSASLMaxSSF- Returns:
- the current value, which may be null.
-
setIsodeSASLMaxSSF
Sets or clears the current value for isodeSASLMaxSSF.- Parameters:
newValue
- the new value, which may be null to remove the value- Returns:
- the new value
-
getIsodeSASLAllowPlain
Get the value for isodeSASLAllowPlain- Returns:
- attribute value or null if none is specified.
-
setIsodeSASLAllowPlain
Set the value for isodeSASLAllowPlain- Parameters:
flag
- value to be set for the attribute, or null to clear the value altogether.- Returns:
- the new value.
-
getIsodeSASLAllowAnonymous
Get the value for isodeSASLAllowAnonymous- Returns:
- attribute value or null if none is specified.
-
setIsodeSASLAllowAnonymous
Set the value for isodeSASLAllowAnonymous- Parameters:
flag
- value to be set for the attribute, or null to clear the value altogether.- Returns:
- the new value.
-
getSASLAvailableMechanisms
Get the value for saslAvailableMechanisms- Returns:
- attribute value or null if none is specified.
-
setSASLAvailableMechanisms
Set the value for saslAvailableMechanisms.- Parameters:
newValue
- value to be set for the attribute, or null to clear the value altogether. A value of "" is equivalent to null, and means "disable all mechanisms".- Returns:
- the new value.
-
getPwdMaxAge
Get the attribute that holds maximum age of the password- Returns:
- value of the attribute or null if none is present
-
setPwdMaxAge
Set the value of the attribute that holds the maximum age of the password- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdMaxFailure
Get the value of the attribute that specifies the number of consecutive failed bind attempts after which the password may not be used to authenticate- Returns:
- value of the attribute or null if none is present
-
setPwdMaxFailure
Set the value of the attribute that specifies the number of consecutive failed bind attempts after which the password may not be used to authenticate- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdMaxIdle
Get the value of the attribute that specifies the number of seconds an account may remain unused before it becomes locked- Returns:
- value of the attribute or null if none is present
-
setPwdMaxIdle
Set the value of the attribute that specifies the number of seconds an account may remain unused before it becomes locked- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdMaxDelay
Get the value of the attribute that specifies the maximum number of seconds to delay when responding to a failed authentication attempt.- Returns:
- value of the attribute or null if none is present
-
setPwdMaxDelay
Set the value of the attribute that specifies the maximum number of seconds to delay when responding to a failed authentication attempt.- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdMinDelay
Get the value of the attribute that specifies the number of seconds to delay when responding to a failed authentication attempt.- Returns:
- value of the attribute or null if none is present
-
setPwdMinDelay
Set the value of the attribute that specifies the number of seconds to delay when responding to a failed authentication attempt.- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdGraceExpiry
Get the value of the attribute that specifies the number of seconds the grace authentications are valid- Returns:
- value of the attribute or null if none is present
-
setPwdGraceExpiry
Set the value of the attribute that specifies the number of seconds the grace authentications are valid- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdMinAge
Get the value of attribute that holds the number of seconds that must elapse between modifications to the password- Returns:
- value of the attribute or null if none is present
-
setPwdMinAge
Set the value of attribute that holds the number of seconds that must elapse between modifications to the password- Parameters:
newValue
- value of the attribute
-
getPwdMinLength
Get the value of the attribute that holds the minimum number of characters that must be used in a password- Returns:
- value of the attribute or null if none is present
-
setPwdMinLength
Set the value of the attribute that holds the minimum number of characters that must be used in a password- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdMaxLength
Get the value of the attribute that holds the maximum number of characters that must be used in a password- Returns:
- value of the attribute or null if none is present
-
setPwdMaxLength
Set the value of the attribute that holds the maximum number of characters that must be used in a password- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdHistoryDuration
Get the value of the attribute that specifies the maximum time in seconds for which the password history will be kept- Returns:
- value of the attribute or null if none is present
-
setPwdHistoryDuration
Set the value of the attribute that specifies the maximum time in seconds for which the password history will be kept- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdCheckEntropy
Get the value of the attribute that holds the minimum number of characters that must be used in a password- Returns:
- value of the attribute or null if none is present
-
setPwdCheckEntropy
Set the value of the attribute that holds the minimum number of characters that must be used in a password- Parameters:
newValue
- value to set or null to clear the value altogether.
-
getPwdAttribute
Get the value of password policy attribute that is currently active- Returns:
- value of the attribute or null if none is present
-
setPwdAttribute
Set the value of password policy attribute that is currently active- Parameters:
value
- value to set or null to clear the value altogether.
-
getPwdConfiguredSchemeGenerators
Get the value of the configured scheme generators for password hashing- Returns:
- value of the attribute or null if none is present
-
setPwdConfiguredSchemeGenerators
Set the value of the configured scheme generators for password hashing- Parameters:
value
- value to set or null to clear the value altogether.
-
getPwdConfiguredSchemeComparators
Get the value of the configured scheme comparators for password hashing- Returns:
- value of the attribute or empty list if none is present. Will never be null.
-
setPwdConfiguredSchemeComparators
Set the value of the configured scheme generators for password hashing- Parameters:
values
- values to set or null/empty list if none is present
-
getFailoverEnabled
public boolean getFailoverEnabled()Determine whether the "isodeFailoverEnabled" attribute has a value of TRUE in the ConfigEntry.- Returns:
- true if the failover attribute is TRUE, or false otherwise (whether it's set to FALSE or simply not present).
-
setFailoverEnabled
Set failover enabled. -
getFailoverMaster
Failover master DN, if there is one- Returns:
- the DN of the failover master, or null if there isn't one.
-
setFailoverMaster
Set failover enabled.- Parameters:
dn
- the DN of the master DSA. If this is null, then any existing value will be cleared.
-
isFailoverMaster
public boolean isFailoverMaster()Check if this DSA is configured as a failover master.- Returns:
- true if this DSA's name is set in isodeFailoverMaster.
-
setFailoverTarget
Set failover target. This operation is meant to be invoked on a DSA that is currently master of a failover group, and requests it to hand over master-ship to the specified DSA.- Parameters:
dn
- the DN of the DSA who is to be the new master.
-
getMESHEnabled
public boolean getMESHEnabled()Determine whether the "isodeMESHEnabled" attribute has a value of TRUE in the ConfigEntry.- Returns:
- true if the attribute is TRUE, or false otherwise (whether it's set to FALSE or simply not present).
-
setMESHEnabled
Set MESH enabled. -
getChainPolicy
Get the chaining policy.- Returns:
- chain policy, will not be null
-
setChainPolicy
Set the chain policy.- Parameters:
newChainPolicy
- chain policy, must not be null
-
getSNMP
Get SNMP enabled boolean.- Returns:
- SNMP enabled.
-
setSNMP
Set the value for snmp.- Parameters:
flag
- value to be set for the attribute, or null to clear the value altogether.- Returns:
- the new value.
-
getAgentXSocket
Get AgentX socket.- Returns:
- String value of agentXSocket.
-
setAgentXSocket
Set the value of the configured scheme generators for password hashing- Parameters:
value
- value to set or null to clear the value altogether.
-
getMonitorMode
Get isodeMonitorMode string value.- Returns:
- Value of isodeMonitorMode.
-
setMonitorMode
Set the value of the configured scheme generators for password hashing- Parameters:
value
- value to set or null to clear the value altogether.
-
getOCSPEnabled
Get the value of ocspEnabled.- Returns:
- OCSP enabled.
-
setOCSPEnabled
Set the value of ocspEnabled.- Parameters:
flag
- value to be set for the attribute, or null to clear the value altogether.- Returns:
- the new value.
-
getOCSPHost
Get OCSP host.- Returns:
- String value of ocspHost.
-
setOCSPHost
Set the value of ocspHost.- Parameters:
value
- value to set or null to clear the value altogether.
-
getOCSPPort
Get OCSP port(s).- Returns:
- List of integers (as space separated numeric strings), or null if no values.
-
setOCSPPort
Set the value of ocspPort as a space separated list of string encoded integers.- Parameters:
value
- value to set or null to clear the value altogether.
-
getHTTPEnabled
Get the value of httpEnabled.- Returns:
- HTTP enabled.
-
setHTTPEnabled
Set the value of httpEnabled.- Parameters:
flag
- value to be set for the attribute, or null to clear the value altogether.- Returns:
- the new value.
-
getHTTPHost
Get HTTP host.- Returns:
- String value of httpHost.
-
setHTTPHost
Set the value of httpHost.- Parameters:
value
- value to set or null to clear the value altogether.
-
getHTTPPort
Get HTTP port(s).- Returns:
- String value of isodeHTTPPort.
-
setHTTPPort
Set the value of httpHost as a space separated list of string encoded integers.- Parameters:
value
- value to set or null to clear the value altogether.
-
getHTTPSPort
Get HTTPS port(s).- Returns:
- String value of isodeHTTPSPort.
-
setHTTPSPort
Set the value of httpsHost as a space separated list of string encoded integers.- Parameters:
value
- value to set or null to clear the value altogether.
-
getHTTPServedAPIs
Get the list of enabled Web APIs. API specification strings are of the form: api-spec := <api-name> [protocols default 3] Where 'api-name' is something like 'pwdmod' (for the password modify JSON API). The optional 'protocols' value is a bit mask specifying which Web protocols to serve the API on (HTTP=1, HTTPS=2).- Returns:
- A list of API specifications, or an empty list if none are set. Will never be null.
-
setHTTPServedAPIs
Get the list of enabled Web APIs. API specification strings are of the form: api-spec := <api-name> [protocols default 3] Where 'abs-dir-path' is a directory to be served by the internal Web server. The optional 'protocols' value is a bit mask specifying which Web protocols to serve the API on (HTTP=1, HTTPS=2). The optional 'path-prefix' value specifies a URL path prefix that must be included in the request URL to select the given directory. For the specification: pwdmod 2 http://host/api/pwdmod -> Fails as HTTP is not specified https://host/api/Pwdmod -> Fails as API selector is incorrect. https://host/api/pwdmod -> Matches.- Parameters:
values
- A list of API speification, or null/empty list to clear the value altogether.
-
getHTTPServedDirs
Set the list of served file system areas. API specification strings are of the form: api-spec := <abs-dir-path> [protocols] [path-prefix]- Returns:
- A list of API specifications, or an empty list if none are set. Will never be null.
-
setHTTPServedDirs
Set the list of served file system areas. API specification strings are of the form: api-spec := <abs-dir-path> [protocols] [path-prefix] Where 'abs-dir-path' is a directory to be served by the internal Web server. The optional 'protocols' value is a bit mask specifying which Web protocols to serve the API on (HTTP=1, HTTPS=2). The optional 'path-prefix' value specifies a URL path prefix that must be included in the request URL to select the given directory. For the specification: /var/www/secure 2 sec http://host/sec -> Fails as HTTP is not specified https://host/Sec -> Fails as path prefix of 'Sec' does not match 'sec'. https://host/sec -> OK.- Parameters:
values
- A list of served directory specifications.
-
getAuthpEnabled
Get the value of authpEnabled.- Returns:
- Authp enabled.
-
setAuthpEnabled
Set the value of authpEnabled.- Parameters:
flag
- value to be set for the attribute, or null to clear the value altogether.- Returns:
- the new value.
-
getMPPHost
Get MPP host.- Returns:
- String value of mppHost.
-
setMPPHost
Set the value of mppHost.- Parameters:
value
- value to set or null to clear the value altogether.
-
getMPPPort
Get MPP port(s).- Returns:
- String value of isodeMPPPort.
-
setMPPPort
Set the value of mppHost as a space separated list of string encoded integers.- Parameters:
value
- value to set or null to clear the value altogether.
-
getMPPTLSPort
Get MPPTLS port(s).- Returns:
- String value of isodeMPPTLSPort.
-
setMPPTLSPort
Set the value of mppTLSHost as a space separated list of string encoded integers.- Parameters:
value
- value to set or null to clear the value altogether.
-
setLDAPAuthModesIExpect
Set the list of permitted LDAP authentication modes (isodeLDAPAuthModesIExpect).- Parameters:
modes
- A set of authentication modes.
-
getLDAPAuthModesIExpect
Get the list of permitted LDAP authentication modes (isodeLDAPAuthModesIExpect).- Returns:
- A set of authentication modes.
-
setDAPAuthModesIExpect
Set the list of permitted _DAP_ authentication modes (isodeDAPAuthModesIExpect).- Parameters:
modes
- A set of authentication modes.
-
getDAPAuthModesIExpect
Get the list of permitted _DAP_ authentication modes (isodeDAPAuthModesIExpect).- Returns:
- A set of authentication modes.
-
getAutoGroupUpdateEnabled
Whether the automatic group updating is enabled.- Returns:
- boolean - True if isodeAutoGroupUpdateEnabled=TRUE, false otherwise.
-
setAutoGroupUpdateEnable
Set the value of isodeAutoGroupUpdateEnabled.- Parameters:
flag
- value to be set for the attribute, or null to clear the value altogether.- Returns:
- the new value.
-
setIsodeExtendedAudit
Set the value of isodeExtendedAudit.- Parameters:
flag
- value to be set for the attribute, or null to clear the value altogether.- Returns:
- the new value.
-
getIsodeExtendedAudit
Get the value of isodeExtendedAudit.- Returns:
- the value.
-
setAuditAttrModsEnable
Set the value of isodeAuditAttrModsEnable.- Parameters:
flag
- value to be set for the attribute, or null to clear the value altogether.- Returns:
- the new value.
-
getAuditAttrModsEnable
Get the value of isodeAuditAttrModsEnable.- Returns:
- the value.
-
getAuditAttrModsExclude
Whether the given attribute type is excluded from change audit logging.- Parameters:
oid
- OID of attribute type. Must not be null- Returns:
- boolean - True if the OID is a value of isodeAuditAttrModsExclude, false otherwise.
- Throws:
BadValueException
- if specified oid is not recognized.
-
setAuditAttrModsExclude
Add the given OID to the list of attributes excluded from audit logging of changes.- Parameters:
oid
- the OID of the attribute type to be added/removed. Must not be null.exclude
- True means that this control will be added to the set of exclusions; False means it will not be in the set of type.- Throws:
BadValueException
- if oid does not represent an attribute type.
-
getAuditAttrModsCountOnly
Whether the given attribute type is excluded from change audit logging.- Parameters:
oid
- OID of attribute type. Must not be null- Returns:
- boolean - True if the OID is a value of isodeAuditAttrModsCountOnly, false otherwise.
- Throws:
BadValueException
- if specified oid is not recognized.
-
setAuditAttrModsCountOnly
Add the given OID to the list of attributes excluded from audit logging of changes.- Parameters:
oid
- the OID of the attribute type to be added/removed. Must not be null.exclude
- True means that this control will be added to the set of exclusions; False means it will not be in the set of type.- Throws:
BadValueException
- if oid does not represent an attribute type.
-