Package net.webpdf.wsclient.openapi
Class ServerConfigUserLdap
- java.lang.Object
-
- net.webpdf.wsclient.openapi.ServerConfigUserLdap
-
public class ServerConfigUserLdap extends Object
Defines an LDAP dictionary or Active Directory as user source.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classServerConfigUserLdap.CertificatesTrustModeEnumSpecifies the mode of handling the certificates presented by the LDAP server during connection establishment
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_CERTIFICATES_TRUST_MODEstatic StringJSON_PROPERTY_CONNECTION_NAMEstatic StringJSON_PROPERTY_CONNECTION_PASSWORDstatic StringJSON_PROPERTY_CONNECTION_U_R_Lstatic StringJSON_PROPERTY_FOLLOW_REFERRALstatic StringJSON_PROPERTY_ROLE_BASEstatic StringJSON_PROPERTY_ROLE_FIELDstatic StringJSON_PROPERTY_ROLE_SEARCHstatic StringJSON_PROPERTY_USER_BASEstatic StringJSON_PROPERTY_USER_CERTIFICATESstatic StringJSON_PROPERTY_USER_P_K_C_S12static StringJSON_PROPERTY_USER_SEARCH
-
Constructor Summary
Constructors Constructor Description ServerConfigUserLdap()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ServerConfigUserLdapcertificatesTrustMode(ServerConfigUserLdap.CertificatesTrustModeEnum certificatesTrustMode)ServerConfigUserLdapconnectionName(String connectionName)ServerConfigUserLdapconnectionPassword(String connectionPassword)ServerConfigUserLdapconnectionURL(String connectionURL)booleanequals(Object o)ServerConfigUserLdapfollowReferral(Boolean followReferral)@Nullable ServerConfigUserLdap.CertificatesTrustModeEnumgetCertificatesTrustMode()Specifies the mode of handling the certificates presented by the LDAP server during connection establishment@Nullable StringgetConnectionName()The name of the user used to access the LDAP server.@Nullable StringgetConnectionPassword()The password used to access the LDAP server.@Nullable StringgetConnectionURL()The URL used to connect to the LDAP server.@Nullable BooleangetFollowReferral()When set to true, all LDAP requests that respond with references are followed.@Nullable StringgetRoleBase()The Base for the LDAP user's role determination.@Nullable StringgetRoleField()The field indicating, that a user is part of a group.@Nullable StringgetRoleSearch()The LDAP request used to find the user's role with.@Nullable StringgetUserBase()The Base for the LDAP user search.@Nullable ServerConfigUserCertificateLdapgetUserCertificates()Get userCertificates@Nullable ServerConfigUserPKCS12getUserPKCS12()Get userPKCS12@Nullable StringgetUserSearch()The LDAP request used to find the user's login name with.inthashCode()ServerConfigUserLdaproleBase(String roleBase)ServerConfigUserLdaproleField(String roleField)ServerConfigUserLdaproleSearch(String roleSearch)voidsetCertificatesTrustMode(ServerConfigUserLdap.CertificatesTrustModeEnum certificatesTrustMode)voidsetConnectionName(String connectionName)voidsetConnectionPassword(String connectionPassword)voidsetConnectionURL(String connectionURL)voidsetFollowReferral(Boolean followReferral)voidsetRoleBase(String roleBase)voidsetRoleField(String roleField)voidsetRoleSearch(String roleSearch)voidsetUserBase(String userBase)voidsetUserCertificates(ServerConfigUserCertificateLdap userCertificates)voidsetUserPKCS12(ServerConfigUserPKCS12 userPKCS12)voidsetUserSearch(String userSearch)StringtoString()ServerConfigUserLdapuserBase(String userBase)ServerConfigUserLdapuserCertificates(ServerConfigUserCertificateLdap userCertificates)ServerConfigUserLdapuserPKCS12(ServerConfigUserPKCS12 userPKCS12)ServerConfigUserLdapuserSearch(String userSearch)
-
-
-
Field Detail
-
JSON_PROPERTY_CERTIFICATES_TRUST_MODE
public static final String JSON_PROPERTY_CERTIFICATES_TRUST_MODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CONNECTION_NAME
public static final String JSON_PROPERTY_CONNECTION_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CONNECTION_PASSWORD
public static final String JSON_PROPERTY_CONNECTION_PASSWORD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CONNECTION_U_R_L
public static final String JSON_PROPERTY_CONNECTION_U_R_L
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FOLLOW_REFERRAL
public static final String JSON_PROPERTY_FOLLOW_REFERRAL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ROLE_BASE
public static final String JSON_PROPERTY_ROLE_BASE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ROLE_FIELD
public static final String JSON_PROPERTY_ROLE_FIELD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ROLE_SEARCH
public static final String JSON_PROPERTY_ROLE_SEARCH
- See Also:
- Constant Field Values
-
JSON_PROPERTY_USER_BASE
public static final String JSON_PROPERTY_USER_BASE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_USER_CERTIFICATES
public static final String JSON_PROPERTY_USER_CERTIFICATES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_USER_P_K_C_S12
public static final String JSON_PROPERTY_USER_P_K_C_S12
- See Also:
- Constant Field Values
-
JSON_PROPERTY_USER_SEARCH
public static final String JSON_PROPERTY_USER_SEARCH
- See Also:
- Constant Field Values
-
-
Method Detail
-
certificatesTrustMode
public ServerConfigUserLdap certificatesTrustMode(ServerConfigUserLdap.CertificatesTrustModeEnum certificatesTrustMode)
-
getCertificatesTrustMode
@Nullable public @Nullable ServerConfigUserLdap.CertificatesTrustModeEnum getCertificatesTrustMode()
Specifies the mode of handling the certificates presented by the LDAP server during connection establishment. * validate = Only certificates that can be verified as publicly valid are classified as trusted. It may be necessary to place the certificate or the issuer's certificate in the server's truststore. Self-signed certificates (e.g. from an own certificate authority) are excluded if they cannot be verified via a configured truststore. * acceptAll = All certificates are classified as trusted, including expired, unverifiable, invalid or self-signed certificates.- Returns:
- certificatesTrustMode
-
setCertificatesTrustMode
public void setCertificatesTrustMode(ServerConfigUserLdap.CertificatesTrustModeEnum certificatesTrustMode)
-
connectionName
public ServerConfigUserLdap connectionName(String connectionName)
-
getConnectionName
@Nullable public @Nullable String getConnectionName()
The name of the user used to access the LDAP server. (e.g. \"cn=ldapuser,cn=Users,dc=example,dc=local\".)- Returns:
- connectionName
-
setConnectionName
public void setConnectionName(String connectionName)
-
connectionPassword
public ServerConfigUserLdap connectionPassword(String connectionPassword)
-
getConnectionPassword
@Nullable public @Nullable String getConnectionPassword()
The password used to access the LDAP server.- Returns:
- connectionPassword
-
setConnectionPassword
public void setConnectionPassword(String connectionPassword)
-
connectionURL
public ServerConfigUserLdap connectionURL(String connectionURL)
-
getConnectionURL
@Nullable public @Nullable String getConnectionURL()
The URL used to connect to the LDAP server. (e.g. \"ldap://server.example.com:389/\".)- Returns:
- connectionURL
-
setConnectionURL
public void setConnectionURL(String connectionURL)
-
followReferral
public ServerConfigUserLdap followReferral(Boolean followReferral)
-
getFollowReferral
@Nullable public @Nullable Boolean getFollowReferral()
When set to true, all LDAP requests that respond with references are followed. The same schema and credentials are used for the referred request.- Returns:
- followReferral
-
setFollowReferral
public void setFollowReferral(Boolean followReferral)
-
roleBase
public ServerConfigUserLdap roleBase(String roleBase)
-
getRoleBase
@Nullable public @Nullable String getRoleBase()
The Base for the LDAP user's role determination. (e.g. \"CN=Users,DC=example,DC=local\".)- Returns:
- roleBase
-
setRoleBase
public void setRoleBase(String roleBase)
-
roleField
public ServerConfigUserLdap roleField(String roleField)
-
getRoleField
@Nullable public @Nullable String getRoleField()
The field indicating, that a user is part of a group. (e.g. \"cn\".)- Returns:
- roleField
-
setRoleField
public void setRoleField(String roleField)
-
roleSearch
public ServerConfigUserLdap roleSearch(String roleSearch)
-
getRoleSearch
@Nullable public @Nullable String getRoleSearch()
The LDAP request used to find the user's role with. (e.g. \"(member={0})\".)- Returns:
- roleSearch
-
setRoleSearch
public void setRoleSearch(String roleSearch)
-
userBase
public ServerConfigUserLdap userBase(String userBase)
-
getUserBase
@Nullable public @Nullable String getUserBase()
The Base for the LDAP user search. (e.g. \"CN=Users,DC=example,DC=local\".)- Returns:
- userBase
-
setUserBase
public void setUserBase(String userBase)
-
userCertificates
public ServerConfigUserLdap userCertificates(ServerConfigUserCertificateLdap userCertificates)
-
getUserCertificates
@Nullable public @Nullable ServerConfigUserCertificateLdap getUserCertificates()
Get userCertificates- Returns:
- userCertificates
-
setUserCertificates
public void setUserCertificates(ServerConfigUserCertificateLdap userCertificates)
-
userPKCS12
public ServerConfigUserLdap userPKCS12(ServerConfigUserPKCS12 userPKCS12)
-
getUserPKCS12
@Nullable public @Nullable ServerConfigUserPKCS12 getUserPKCS12()
Get userPKCS12- Returns:
- userPKCS12
-
setUserPKCS12
public void setUserPKCS12(ServerConfigUserPKCS12 userPKCS12)
-
userSearch
public ServerConfigUserLdap userSearch(String userSearch)
-
getUserSearch
@Nullable public @Nullable String getUserSearch()
The LDAP request used to find the user's login name with. (e.g. \"(sAMAccountName={0})\".)- Returns:
- userSearch
-
setUserSearch
public void setUserSearch(String userSearch)
-
-