ac.simons.akismet

Class Akismet

java.lang.Object

ac.simons.akismet.Akismet

public class Akismet
extends Object

Loosely oriented at http://akismet.com/development/api/

Author:

Michael J. Simons

Constructor Summary

Constructors

Constructor and Description
Akismet(org.apache.http.client.HttpClient httpClient)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	commentCheck(AkismetComment comment) This is basically the core of everything.
String	getApiConsumer()
String	getApiEndpoint()
String	getApiKey()
String	getApiVersion()
org.apache.http.client.HttpClient	getHttpClient()
String	getUserAgent()
boolean	isEnabled()
void	setApiConsumer(String apiConsumer)
void	setApiEndpoint(String apiEndpoint)
void	setApiKey(String apikey)
void	setApiVersion(String apiVersion)
void	setEnabled(boolean enabled)
boolean	submitHam(AkismetComment comment) This call is intended for the marking of false positives, things that were incorrectly marked as spam.
boolean	submitSpam(AkismetComment comment) This call is for submitting comments that weren't marked as spam but should have been.
boolean	verifyKey() The key verification call should be made before beginning to use the service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Akismet

public Akismet(org.apache.http.client.HttpClient httpClient)

Method Detail

getUserAgent

public String getUserAgent()

getApiEndpoint

public String getApiEndpoint()

setApiEndpoint

public void setApiEndpoint(String apiEndpoint)

getApiVersion

public String getApiVersion()

setApiVersion

public void setApiVersion(String apiVersion)

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

getApiKey

public String getApiKey()

setApiKey

public void setApiKey(String apikey)

getApiConsumer

public String getApiConsumer()

setApiConsumer

public void setApiConsumer(String apiConsumer)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

verifyKey

public boolean verifyKey()
                  throws AkismetException

The key verification call should be made before beginning to use the service. It requires two variables, key and blog.

Returns:

True if the key is valid. This is the one call that can be made without the API key subdomain.

Throws:

AkismetException

commentCheck

public boolean commentCheck(AkismetComment comment)
                     throws AkismetException

This is basically the core of everything. This call takes a number of arguments and characteristics about the submitted content and then returns a thumbs up or thumbs down.
Almost everything is optional, but performance can drop dramatically if you exclude certain elements.
I would recommend erring on the side of too much data, as everything is used as part of the Akismet signature.

Returns:

True, if the comment is spam, false otherwise

Throws:

AkismetException

submitSpam

public boolean submitSpam(AkismetComment comment)
                   throws AkismetException

This call is for submitting comments that weren't marked as spam but should have been.

Parameters:

comment -

Returns:

True if the spam was successfully submitted.

Throws:

AkismetException

submitHam

public boolean submitHam(AkismetComment comment)
                  throws AkismetException

This call is intended for the marking of false positives, things that were incorrectly marked as spam.

Parameters:

comment -

Returns:

True if the ham was successfully submitted.

Throws:

AkismetException