com.adobe.cq.social.blog.antispam

Interface AkismetService

public interface AkismetService

Method Summary

Methods

Modifier and Type	Method and Description
boolean	commentCheck(String ipAddress, String userAgent, String referrer, String permalink, String commentType, String author, String authorEmail, String authorURL, String commentContent, Map other) From the API docs, This is basically the core of everything.
boolean	isVerifiedKey() Check to see if the API key has been verified.
void	setProxyAuthenticationConfiguration(String proxyUsername, String proxyPassword) Sets proxy authentication information.
void	setProxyConfiguration(String proxyHost, int proxyPort) Sets proxy configuration information.
void	submitHam(String ipAddress, String userAgent, String referrer, String permalink, String commentType, String author, String authorEmail, String authorURL, String commentContent, Map other) From the API docs, This call is intended for the marking of false positives, things that were incorrectly marked as spam.
void	submitSpam(String ipAddress, String userAgent, String referrer, String permalink, String commentType, String author, String authorEmail, String authorURL, String commentContent, Map other) From the API docs, This call is for submitting comments that weren't marked as spam but should have been.
boolean	verifyAPIKey() Verify your API key.

Method Detail

isVerifiedKey

boolean isVerifiedKey()

Check to see if the API key has been verified.

Returns:

true if the API key has been verified, false otherwise

setProxyConfiguration

void setProxyConfiguration(String proxyHost,
                         int proxyPort)

Sets proxy configuration information. This method must be called before any calls to the API if you require proxy configuration.

Parameters:

proxyHost - Proxy host

proxyPort - Proxy port

setProxyAuthenticationConfiguration

void setProxyAuthenticationConfiguration(String proxyUsername,
                                       String proxyPassword)

Sets proxy authentication information. This method must be called before any calls to the API if you require proxy authentication.

Parameters:

proxyUsername - Username to access proxy

proxyPassword - Password to access proxy

verifyAPIKey

boolean verifyAPIKey()

Verify your API key.

Returns:

true if the API key has been verified, false otherwise

commentCheck

boolean commentCheck(String ipAddress,
                   String userAgent,
                   String referrer,
                   String permalink,
                   String commentType,
                   String author,
                   String authorEmail,
                   String authorURL,
                   String commentContent,
                   Map other)

From the API docs, 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."

Parameters:

ipAddress - IP address of the comment submitter

userAgent - User agent information

referrer - The content of the HTTP_REFERER header should be sent here

permalink - The permanent location of the entry the comment was submitted to

commentType - May be blank, comment, trackback, pingback, or a made up value like "registration"

author - Submitted name with the comment

authorEmail - Submitted email address

authorURL - Commenter URL

commentContent - The content that was submitted

other - In PHP there is an array of enviroment variables called $_SERVER which contains information about the web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet as how the submited content interacts with the server can be very telling, so please include as much information as possible.

Returns:

true if the comment is identified by Akismet as spam, false otherwise

submitSpam

void submitSpam(String ipAddress,
              String userAgent,
              String referrer,
              String permalink,
              String commentType,
              String author,
              String authorEmail,
              String authorURL,
              String commentContent,
              Map other)

From the API docs, This call is for submitting comments that weren't marked as spam but should have been. It takes identical arguments as comment check."

Parameters:

ipAddress - IP address of the comment submitter

userAgent - User agent information

referrer - The content of the HTTP_REFERER header should be sent here

permalink - The permanent location of the entry the comment was submitted to

commentType - May be blank, comment, trackback, pingback, or a made up value like "registration"

author - Submitted name with the comment

authorEmail - Submitted email address

authorURL - Commenter URL

commentContent - The content that was submitted

other - In PHP there is an array of enviroment variables called $_SERVER which contains information about the web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet as how the submited content interacts with the server can be very telling, so please include as much information as possible.

submitHam

void submitHam(String ipAddress,
             String userAgent,
             String referrer,
             String permalink,
             String commentType,
             String author,
             String authorEmail,
             String authorURL,
             String commentContent,
             Map other)

From the API docs, This call is intended for the marking of false positives, things that were incorrectly marked as spam. It takes identical arguments as comment check and submit spam."

Parameters:

ipAddress - IP address of the comment submitter

userAgent - User agent information

referrer - The content of the HTTP_REFERER header should be sent here

permalink - The permanent location of the entry the comment was submitted to

commentType - May be blank, comment, trackback, pingback, or a made up value like "registration"

author - Submitted name with the comment

authorEmail - Submitted email address

authorURL - Commenter URL

commentContent - The content that was submitted

other - In PHP there is an array of enviroment variables called $_SERVER which contains information about the web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet as how the submited content interacts with the server can be very telling, so please include as much information as possible.