Class TemplateV4

    • Method Detail

      • certificateValidity

        public final CertificateValidity certificateValidity()

        Certificate validity describes the validity and renewal periods of a certificate.

        Returns:
        Certificate validity describes the validity and renewal periods of a certificate.
      • enrollmentFlags

        public final EnrollmentFlagsV4 enrollmentFlags()

        Enrollment flags describe the enrollment settings for certificates using the existing private key and deleting expired or revoked certificates.

        Returns:
        Enrollment flags describe the enrollment settings for certificates using the existing private key and deleting expired or revoked certificates.
      • extensions

        public final ExtensionsV4 extensions()

        Extensions describe the key usage extensions and application policies for a template.

        Returns:
        Extensions describe the key usage extensions and application policies for a template.
      • generalFlags

        public final GeneralFlagsV4 generalFlags()

        General flags describe whether the template is used for computers or users and if the template can be used with autoenrollment.

        Returns:
        General flags describe whether the template is used for computers or users and if the template can be used with autoenrollment.
      • hashAlgorithm

        public final HashAlgorithm hashAlgorithm()

        Specifies the hash algorithm used to hash the private key. Hash algorithm can only be specified when using Key Storage Providers.

        If the service returns an enum value that is not available in the current SDK version, hashAlgorithm will return HashAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hashAlgorithmAsString().

        Returns:
        Specifies the hash algorithm used to hash the private key. Hash algorithm can only be specified when using Key Storage Providers.
        See Also:
        HashAlgorithm
      • hashAlgorithmAsString

        public final String hashAlgorithmAsString()

        Specifies the hash algorithm used to hash the private key. Hash algorithm can only be specified when using Key Storage Providers.

        If the service returns an enum value that is not available in the current SDK version, hashAlgorithm will return HashAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hashAlgorithmAsString().

        Returns:
        Specifies the hash algorithm used to hash the private key. Hash algorithm can only be specified when using Key Storage Providers.
        See Also:
        HashAlgorithm
      • privateKeyAttributes

        public final PrivateKeyAttributesV4 privateKeyAttributes()

        Private key attributes allow you to specify the minimal key length, key spec, key usage, and cryptographic providers for the private key of a certificate for v4 templates. V4 templates allow you to use either Key Storage Providers or Legacy Cryptographic Service Providers. You specify the cryptography provider category in private key flags.

        Returns:
        Private key attributes allow you to specify the minimal key length, key spec, key usage, and cryptographic providers for the private key of a certificate for v4 templates. V4 templates allow you to use either Key Storage Providers or Legacy Cryptographic Service Providers. You specify the cryptography provider category in private key flags.
      • privateKeyFlags

        public final PrivateKeyFlagsV4 privateKeyFlags()

        Private key flags for v4 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, if an alternate signature algorithm should be used, and if certificates are renewed using the same private key.

        Returns:
        Private key flags for v4 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, if an alternate signature algorithm should be used, and if certificates are renewed using the same private key.
      • subjectNameFlags

        public final SubjectNameFlagsV4 subjectNameFlags()

        Subject name flags describe the subject name and subject alternate name that is included in a certificate.

        Returns:
        Subject name flags describe the subject name and subject alternate name that is included in a certificate.
      • hasSupersededTemplates

        public final boolean hasSupersededTemplates()
        For responses, this returns true if the service returned a value for the SupersededTemplates property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • supersededTemplates

        public final List<String> supersededTemplates()

        List of templates in Active Directory that are superseded by this template.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupersededTemplates() method.

        Returns:
        List of templates in Active Directory that are superseded by this template.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)