
com.mps.deepviolet.api.IDVEng Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of DeepViolet Show documentation
Show all versions of DeepViolet Show documentation
TLS/SSL security introspection API
The newest version!
package com.mps.deepviolet.api;
/**
* Interface specification for engine features available
* from an initialized host.
* @author Milton Smith
*
*/
public interface IDVEng {
/**
* Return ciphersuites for the target host. Calls getCipherSuites(CIPHER_NAME_CONVENTION CIPHER_NAME_CONVENTION)
with
* CIPHER_NAME_CONVENTION.IANA as the default.
* @return Ciphersuites supported by target host.
* @throws DVException thrown on problems fetching ciphersuites.
*/
IDVCipherSuite[] getCipherSuites() throws DVException;
/**
* Return session instance for the target host when IDVOnEng.
* was created.
* @return Session instance for target host.
* @see DVFactory.initializeSession(URL)
*/
IDVSession getDVSession();
/**
* Write PEM encoded X.509 certificate for the target
* host when IDVOnEng was created to a fully qualified
* file name.
* @param file Fully qualified file name
* @return Returns the number of bytes written to disk
* @throws DVException Thrown on problems writing to the disk.
*/
long writeCertificate(String file) throws DVException;
/**
* Retrieve a IDVX509Certificate.
* @return Return IDVX509Certificate representing host associated
* with IDVOnEng instance.
* @throws DVException Thrown on problems reading certificate.
*/
IDVX509Certificate getCertificate() throws DVException;
/**
* Return the Major Version of DeepViolet. Incremented upon significant
* addition of new features. Existing features could also break code.
* Callers are urged to test upon implementing new major versions.
* @return Number indicating DeepVioloet Major Version.
*/
int getDeepVioletMajorVersion();
/**
* Return the Minor Version of DeepViolet. Incremented upon significant
* improvement to existing features. Callers are urged to test upon
* implementing new major versions.
* @return Number indicating DeepVioloet Minor Version.
*/
int getDeepVioletMinorVersion();
/**
* Return the Build Version of DeepViolet. Incremented on bug fixes to
* existing features. It's not anticipated this any improvements will
* break code. Callers are urged to perform basic unit tests.
* @return Number indicating DeepVioloet Build Version.
*/
int getDeepVioletBuildVersion();
/**
* Return the DeepViolet version string.
* @return Suitable for printing in log files, displaying in About boxes, etc.
*/
String getDeepVioletStringVersion();
/**
* Return Maven SNAPSHOT release status
* @return true, DeepViolet is beta status. false, DeepViolet is release status.
*/
boolean isDeepVioletSnapShot();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy