org.bouncycastle.jce

Class X509LDAPCertStoreParameters.Builder

public static class X509LDAPCertStoreParameters.Builder extends Object

Constructor Summary
Builder()
Builder(String ldapURL, String baseDN)
Method Summary
X509LDAPCertStoreParametersbuild()
X509LDAPCertStoreParameters.BuildersetAACertificateAttribute(String aACertificateAttribute)
X509LDAPCertStoreParameters.BuildersetAACertificateSubjectAttributeName(String aACertificateSubjectAttributeName)
X509LDAPCertStoreParameters.BuildersetAttributeAuthorityRevocationListAttribute(String attributeAuthorityRevocationListAttribute)
X509LDAPCertStoreParameters.BuildersetAttributeAuthorityRevocationListIssuerAttributeName(String attributeAuthorityRevocationListIssuerAttributeName)
X509LDAPCertStoreParameters.BuildersetAttributeCertificateAttributeAttribute(String attributeCertificateAttributeAttribute)
X509LDAPCertStoreParameters.BuildersetAttributeCertificateAttributeSubjectAttributeName(String attributeCertificateAttributeSubjectAttributeName)
X509LDAPCertStoreParameters.BuildersetAttributeCertificateRevocationListAttribute(String attributeCertificateRevocationListAttribute)
X509LDAPCertStoreParameters.BuildersetAttributeCertificateRevocationListIssuerAttributeName(String attributeCertificateRevocationListIssuerAttributeName)
X509LDAPCertStoreParameters.BuildersetAttributeDescriptorCertificateAttribute(String attributeDescriptorCertificateAttribute)
X509LDAPCertStoreParameters.BuildersetAttributeDescriptorCertificateSubjectAttributeName(String attributeDescriptorCertificateSubjectAttributeName)
X509LDAPCertStoreParameters.BuildersetAuthorityRevocationListAttribute(String authorityRevocationListAttribute)
X509LDAPCertStoreParameters.BuildersetAuthorityRevocationListIssuerAttributeName(String authorityRevocationListIssuerAttributeName)
X509LDAPCertStoreParameters.BuildersetCACertificateAttribute(String cACertificateAttribute)
X509LDAPCertStoreParameters.BuildersetCACertificateSubjectAttributeName(String cACertificateSubjectAttributeName)
X509LDAPCertStoreParameters.BuildersetCertificateRevocationListAttribute(String certificateRevocationListAttribute)
X509LDAPCertStoreParameters.BuildersetCertificateRevocationListIssuerAttributeName(String certificateRevocationListIssuerAttributeName)
X509LDAPCertStoreParameters.BuildersetCrossCertificateAttribute(String crossCertificateAttribute)
X509LDAPCertStoreParameters.BuildersetCrossCertificateSubjectAttributeName(String crossCertificateSubjectAttributeName)
X509LDAPCertStoreParameters.BuildersetDeltaRevocationListAttribute(String deltaRevocationListAttribute)
X509LDAPCertStoreParameters.BuildersetDeltaRevocationListIssuerAttributeName(String deltaRevocationListIssuerAttributeName)
X509LDAPCertStoreParameters.BuildersetLdapAACertificateAttributeName(String ldapAACertificateAttributeName)
X509LDAPCertStoreParameters.BuildersetLdapAttributeAuthorityRevocationListAttributeName(String ldapAttributeAuthorityRevocationListAttributeName)
X509LDAPCertStoreParameters.BuildersetLdapAttributeCertificateAttributeAttributeName(String ldapAttributeCertificateAttributeAttributeName)
X509LDAPCertStoreParameters.BuildersetLdapAttributeCertificateRevocationListAttributeName(String ldapAttributeCertificateRevocationListAttributeName)
X509LDAPCertStoreParameters.BuildersetLdapAttributeDescriptorCertificateAttributeName(String ldapAttributeDescriptorCertificateAttributeName)
X509LDAPCertStoreParameters.BuildersetLdapAuthorityRevocationListAttributeName(String ldapAuthorityRevocationListAttributeName)
X509LDAPCertStoreParameters.BuildersetLdapCACertificateAttributeName(String ldapCACertificateAttributeName)
X509LDAPCertStoreParameters.BuildersetLdapCertificateRevocationListAttributeName(String ldapCertificateRevocationListAttributeName)
X509LDAPCertStoreParameters.BuildersetLdapCrossCertificateAttributeName(String ldapCrossCertificateAttributeName)
X509LDAPCertStoreParameters.BuildersetLdapDeltaRevocationListAttributeName(String ldapDeltaRevocationListAttributeName)
X509LDAPCertStoreParameters.BuildersetLdapUserCertificateAttributeName(String ldapUserCertificateAttributeName)
X509LDAPCertStoreParameters.BuildersetSearchForSerialNumberIn(String searchForSerialNumberIn)
X509LDAPCertStoreParameters.BuildersetUserCertificateAttribute(String userCertificateAttribute)
X509LDAPCertStoreParameters.BuildersetUserCertificateSubjectAttributeName(String userCertificateSubjectAttributeName)

Constructor Detail

Builder

public Builder()

Builder

public Builder(String ldapURL, String baseDN)

Method Detail

build

public X509LDAPCertStoreParameters build()

setAACertificateAttribute

public X509LDAPCertStoreParameters.Builder setAACertificateAttribute(String aACertificateAttribute)

Parameters: aACertificateAttribute Attribute name(s) in the LDAP directory where attribute certificates for attribute authorities are stored. Separated by space. Defaults to "aACertificate" if null.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setAACertificateSubjectAttributeName

public X509LDAPCertStoreParameters.Builder setAACertificateSubjectAttributeName(String aACertificateSubjectAttributeName)

Parameters: aACertificateSubjectAttributeName Attribute(s) in the subject of the attribute certificate which is used to be searched in the ldapAACertificateAttributeName. E.g. the "ou" attribute of the DN could be used.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setAttributeAuthorityRevocationListAttribute

public X509LDAPCertStoreParameters.Builder setAttributeAuthorityRevocationListAttribute(String attributeAuthorityRevocationListAttribute)

Parameters: attributeAuthorityRevocationListAttribute Attribute name(s) in the LDAP directory where RLs for attribute authority attribute certificates are stored. Separated by space. Defaults to "attributeAuthorityRevocationList" if null.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setAttributeAuthorityRevocationListIssuerAttributeName

public X509LDAPCertStoreParameters.Builder setAttributeAuthorityRevocationListIssuerAttributeName(String attributeAuthorityRevocationListIssuerAttributeName)

Parameters: attributeAuthorityRevocationListIssuerAttributeName Anttribute(s) in the issuer of the CRL which is used to be searched in the ldapAttributeAuthorityRevocationListAttributeName. E.g. the "o" or "ou" attribute may be used.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setAttributeCertificateAttributeAttribute

public X509LDAPCertStoreParameters.Builder setAttributeCertificateAttributeAttribute(String attributeCertificateAttributeAttribute)

Parameters: attributeCertificateAttributeAttribute Attribute name(s) in the LDAP directory where end attribute certificates are stored. Separated by space. Defaults to "attributeCertificateAttribute" if null.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setAttributeCertificateAttributeSubjectAttributeName

public X509LDAPCertStoreParameters.Builder setAttributeCertificateAttributeSubjectAttributeName(String attributeCertificateAttributeSubjectAttributeName)

Parameters: attributeCertificateAttributeSubjectAttributeName Attribute(s) in the subject of the attribute certificate which is used to be searched in the ldapAttributeCertificateAttributeAttributeName. E.g. the "cn" attribute of the DN could be used.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setAttributeCertificateRevocationListAttribute

public X509LDAPCertStoreParameters.Builder setAttributeCertificateRevocationListAttribute(String attributeCertificateRevocationListAttribute)

Parameters: attributeCertificateRevocationListAttribute Attribute name(s) in the LDAP directory where CRLs for attribute certificates are stored. Separated by space. Defaults to "attributeCertificateRevocationList" if null.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setAttributeCertificateRevocationListIssuerAttributeName

public X509LDAPCertStoreParameters.Builder setAttributeCertificateRevocationListIssuerAttributeName(String attributeCertificateRevocationListIssuerAttributeName)

Parameters: attributeCertificateRevocationListIssuerAttributeName Attribute(s) in the issuer of the CRL which is used to be searched in the ldapAttributeCertificateRevocationListAttributeName. E.g. the "o" or "ou" attribute may be used certificate is searched in this LDAP attribute.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setAttributeDescriptorCertificateAttribute

public X509LDAPCertStoreParameters.Builder setAttributeDescriptorCertificateAttribute(String attributeDescriptorCertificateAttribute)

Parameters: attributeDescriptorCertificateAttribute Attribute name(s) in the LDAP directory where self signed attribute certificates for attribute authorities are stored. Separated by space. Defaults to "attributeDescriptorCertificate" if null.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setAttributeDescriptorCertificateSubjectAttributeName

public X509LDAPCertStoreParameters.Builder setAttributeDescriptorCertificateSubjectAttributeName(String attributeDescriptorCertificateSubjectAttributeName)

Parameters: attributeDescriptorCertificateSubjectAttributeName Attribute(s) in the subject of the attribute certificate which is used to be searched in the ldapAttributeDescriptorCertificateAttributeName. E.g. the "o" attribute of the DN could be used.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setAuthorityRevocationListAttribute

public X509LDAPCertStoreParameters.Builder setAuthorityRevocationListAttribute(String authorityRevocationListAttribute)

Parameters: authorityRevocationListAttribute Attribute name(s) in the LDAP directory where CRLs for authorities are stored. Separated by space. Defaults to "authorityRevocationList" if null.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setAuthorityRevocationListIssuerAttributeName

public X509LDAPCertStoreParameters.Builder setAuthorityRevocationListIssuerAttributeName(String authorityRevocationListIssuerAttributeName)

Parameters: authorityRevocationListIssuerAttributeName Attribute(s) in the issuer of the CRL which is used to be searched in the ldapAuthorityRevocationListAttributeName. E.g. the "o" or "ou" attribute may be used.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setCACertificateAttribute

public X509LDAPCertStoreParameters.Builder setCACertificateAttribute(String cACertificateAttribute)

Parameters: cACertificateAttribute Attribute name(s) in the LDAP directory where CA certificates are stored. Separated by space. Defaults to "cACertificate" if null.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setCACertificateSubjectAttributeName

public X509LDAPCertStoreParameters.Builder setCACertificateSubjectAttributeName(String cACertificateSubjectAttributeName)

Parameters: cACertificateSubjectAttributeName Attribute(s) in the subject of the certificate which is used to be searched in the ldapCACertificateAttributeName. E.g. the "ou" attribute of the DN could be used.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setCertificateRevocationListAttribute

public X509LDAPCertStoreParameters.Builder setCertificateRevocationListAttribute(String certificateRevocationListAttribute)

Parameters: certificateRevocationListAttribute Attribute name(s) in the LDAP directory where CRLs are stored. Separated by space. Defaults to "certificateRevocationList" if null.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setCertificateRevocationListIssuerAttributeName

public X509LDAPCertStoreParameters.Builder setCertificateRevocationListIssuerAttributeName(String certificateRevocationListIssuerAttributeName)

Parameters: certificateRevocationListIssuerAttributeName Attribute(s) in the issuer of the CRL which is used to be searched in the ldapCertificateRevocationListAttributeName. E.g. the "o" or "ou" attribute may be used.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setCrossCertificateAttribute

public X509LDAPCertStoreParameters.Builder setCrossCertificateAttribute(String crossCertificateAttribute)

Parameters: crossCertificateAttribute Attribute name(s), where the cross certificates are stored. Separated by space. Defaults to "crossCertificatePair" if null

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setCrossCertificateSubjectAttributeName

public X509LDAPCertStoreParameters.Builder setCrossCertificateSubjectAttributeName(String crossCertificateSubjectAttributeName)

Parameters: crossCertificateSubjectAttributeName Attribute(s) in the subject of the cross certificate which is used to be searched in the ldapCrossCertificateAttributeName. E.g. the "o" attribute of the DN may be appropriate.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setDeltaRevocationListAttribute

public X509LDAPCertStoreParameters.Builder setDeltaRevocationListAttribute(String deltaRevocationListAttribute)

Parameters: deltaRevocationListAttribute Attribute name(s) in the LDAP directory where delta RLs are stored. Separated by space. Defaults to "deltaRevocationList" if null.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setDeltaRevocationListIssuerAttributeName

public X509LDAPCertStoreParameters.Builder setDeltaRevocationListIssuerAttributeName(String deltaRevocationListIssuerAttributeName)

Parameters: deltaRevocationListIssuerAttributeName Attribute(s) in the issuer of the CRL which is used to be searched in the ldapDeltaRevocationListAttributeName. E.g. the "o" or "ou" attribute may be used.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setLdapAACertificateAttributeName

public X509LDAPCertStoreParameters.Builder setLdapAACertificateAttributeName(String ldapAACertificateAttributeName)

Parameters: ldapAACertificateAttributeName The attribute name(s) in the LDAP directory where to search for the attribute value of the specified aACertificateSubjectAttributeName. E.g. if "ou" is used to put information about the subject of attribute authority attribute certificates, specify "ou".

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setLdapAttributeAuthorityRevocationListAttributeName

public X509LDAPCertStoreParameters.Builder setLdapAttributeAuthorityRevocationListAttributeName(String ldapAttributeAuthorityRevocationListAttributeName)

Parameters: ldapAttributeAuthorityRevocationListAttributeName The attribute name(s) in the LDAP directory where to search for the attribute value of the specified attributeAuthorityRevocationListIssuerAttributeName. E.g. if "ou" is used to put information about the issuer of CRLs, specify "ou".

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setLdapAttributeCertificateAttributeAttributeName

public X509LDAPCertStoreParameters.Builder setLdapAttributeCertificateAttributeAttributeName(String ldapAttributeCertificateAttributeAttributeName)

Parameters: ldapAttributeCertificateAttributeAttributeName The attribute name(s) in the LDAP directory where to search for the attribute value of the specified attributeCertificateAttributeSubjectAttributeName. E.g. if "cn" is used to put information about the subject of end attribute certificates, specify "cn".

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setLdapAttributeCertificateRevocationListAttributeName

public X509LDAPCertStoreParameters.Builder setLdapAttributeCertificateRevocationListAttributeName(String ldapAttributeCertificateRevocationListAttributeName)

Parameters: ldapAttributeCertificateRevocationListAttributeName The attribute name(s) in the LDAP directory where to search for the attribute value of the specified attributeCertificateRevocationListIssuerAttributeName. E.g. if "ou" is used to put information about the issuer of CRLs, specify "ou".

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setLdapAttributeDescriptorCertificateAttributeName

public X509LDAPCertStoreParameters.Builder setLdapAttributeDescriptorCertificateAttributeName(String ldapAttributeDescriptorCertificateAttributeName)

Parameters: ldapAttributeDescriptorCertificateAttributeName The attribute name(s) in the LDAP directory where to search for the attribute value of the specified attributeDescriptorCertificateSubjectAttributeName. E.g. if "o" is used to put information about the subject of self signed attribute authority attribute certificates, specify "o".

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setLdapAuthorityRevocationListAttributeName

public X509LDAPCertStoreParameters.Builder setLdapAuthorityRevocationListAttributeName(String ldapAuthorityRevocationListAttributeName)

Parameters: ldapAuthorityRevocationListAttributeName The attribute name(s) in the LDAP directory where to search for the attribute value of the specified authorityRevocationListIssuerAttributeName. E.g. if "ou" is used to put information about the issuer of CRLs, specify "ou".

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setLdapCACertificateAttributeName

public X509LDAPCertStoreParameters.Builder setLdapCACertificateAttributeName(String ldapCACertificateAttributeName)

Parameters: ldapCACertificateAttributeName The attribute name(s) in the LDAP directory where to search for the attribute value of the specified cACertificateSubjectAttributeName. E.g. if "ou" is used to put information about the subject for CA certificates, then specify "ou".

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setLdapCertificateRevocationListAttributeName

public X509LDAPCertStoreParameters.Builder setLdapCertificateRevocationListAttributeName(String ldapCertificateRevocationListAttributeName)

Parameters: ldapCertificateRevocationListAttributeName The attribute name(s) in the LDAP directory where to search for the attribute value of the specified certificateRevocationListIssuerAttributeName. E.g. if "ou" is used to put information about the issuer of CRLs, specify "ou".

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setLdapCrossCertificateAttributeName

public X509LDAPCertStoreParameters.Builder setLdapCrossCertificateAttributeName(String ldapCrossCertificateAttributeName)

Parameters: ldapCrossCertificateAttributeName The attribute name(s) in the LDAP directory where to search for the attribute value of the specified crossCertificateSubjectAttributeName. E.g. if "o" is used to put information about the subject for cross certificates, then specify "o".

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setLdapDeltaRevocationListAttributeName

public X509LDAPCertStoreParameters.Builder setLdapDeltaRevocationListAttributeName(String ldapDeltaRevocationListAttributeName)

Parameters: ldapDeltaRevocationListAttributeName The attribute name(s) in the LDAP directory where to search for the attribute value of the specified deltaRevocationListIssuerAttributeName. E.g. if "ou" is used to put information about the issuer of CRLs, specify "ou".

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setLdapUserCertificateAttributeName

public X509LDAPCertStoreParameters.Builder setLdapUserCertificateAttributeName(String ldapUserCertificateAttributeName)

Parameters: ldapUserCertificateAttributeName The attribute name(s) in the LDAP directory where to search for the attribute value of the specified userCertificateSubjectAttributeName. E.g. if "cn" is used to put information about the subject for end certificates, then specify "cn".

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setSearchForSerialNumberIn

public X509LDAPCertStoreParameters.Builder setSearchForSerialNumberIn(String searchForSerialNumberIn)

Parameters: searchForSerialNumberIn If not null the serial number of the certificate is searched in this LDAP attribute.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setUserCertificateAttribute

public X509LDAPCertStoreParameters.Builder setUserCertificateAttribute(String userCertificateAttribute)

Parameters: userCertificateAttribute Attribute name(s) in the LDAP directory where end certificates are stored. Separated by space. Defaults to "userCertificate" if null.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.

setUserCertificateSubjectAttributeName

public X509LDAPCertStoreParameters.Builder setUserCertificateSubjectAttributeName(String userCertificateSubjectAttributeName)

Parameters: userCertificateSubjectAttributeName Attribute(s) in the subject of the certificate which is used to be searched in the ldapUserCertificateAttributeName. E.g. the "cn" attribute of the DN could be used.

Returns: the builder

Throws: IllegalArgumentException if a necessary parameter is null.