|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lacinato.tools.bdkim.BdkimAnalyzer
public class BdkimAnalyzer
A Java client to the BDKIM perl server process, this class provides convenience methods for sending a message to the perl server and receiving the evaluated DomainKey and DKIM results. It does not handle signing of messages, only verification.
See determineDkimStatuses() for basic usage. For more information, see http://lacinato.com/cm/software/emailrelated/bdkim
Nested Class Summary | |
---|---|
static class |
BdkimAnalyzer.SignatureResults
A structured data object that holds the results of the DomainKey/DKIM evaluation. |
Field Summary | |
---|---|
static int |
DEFAULT_CONNECT_TRIES
Default 3 total attempts to connect to non-responsive server port |
static int |
DEFAULT_CONNECTION_TIMEOUT
Default 15 seconds |
static int |
DEFAULT_DATA_TIMEOUT
Default 300 seconds - DNS calls could take a while on the perl side |
static java.lang.String |
DEFAULT_HOST
Default "localhost" |
static int |
DEFAULT_PORT
Default 12300 |
Constructor Summary | |
---|---|
BdkimAnalyzer()
|
Method Summary | |
---|---|
BdkimAnalyzer.SignatureResults |
determineDkimStatuses(java.lang.String raw_message)
This is the main API call into BdkimAnalyzer. |
BdkimAnalyzer.SignatureResults |
determineDkimStatuses(java.lang.String raw_message,
boolean check_for_headers)
Given a raw message (headers and all), this method will return the DK/DKIM results from the perl BDKIM server. |
int |
getConnectionTimeout()
|
int |
getConnectTries()
|
int |
getDataTimeout()
|
java.lang.String |
getHost()
|
int |
getPort()
|
boolean |
hasDkOrDkimHeaders(java.lang.String message_txt)
This method is public as a possible convenience only. |
void |
setConnectionTimeout(int s)
Set the connection timeout value for connection to the BDKIM perl server, value specified in seconds; this only applies when first creating the connection, not during data transmission. |
void |
setConnectTries(int t)
Set the number of attempts to be made to connect to the server before failing a given connection attempt (for one message) |
void |
setDataTimeout(int s)
Set the connection timeout value for connection to the BDKIM perl server, value specified in seconds; this only applies when sending data to the server, not when making the original connection. |
void |
setHost(java.lang.String h)
host name, or IP address in String form, pointing to the BDKIM perl server, e.g. |
void |
setPort(int p)
Port to use when contacting the BDKIM perl serevr -- must be between 0 and 65535, inclusive |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_PORT
public static final java.lang.String DEFAULT_HOST
public static final int DEFAULT_CONNECTION_TIMEOUT
public static final int DEFAULT_DATA_TIMEOUT
public static final int DEFAULT_CONNECT_TRIES
Constructor Detail |
---|
public BdkimAnalyzer()
Method Detail |
---|
public BdkimAnalyzer.SignatureResults determineDkimStatuses(java.lang.String raw_message) throws AuthVerificationException
AuthVerificationException
public BdkimAnalyzer.SignatureResults determineDkimStatuses(java.lang.String raw_message, boolean check_for_headers) throws AuthVerificationException
AuthVerificationException
public boolean hasDkOrDkimHeaders(java.lang.String message_txt)
public void setPort(int p)
public int getPort()
public void setHost(java.lang.String h)
public java.lang.String getHost()
public void setConnectionTimeout(int s)
public int getConnectionTimeout()
public void setDataTimeout(int s)
public int getDataTimeout()
public void setConnectTries(int t)
public int getConnectTries()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |