Package com.nettoolkit.gatekeeper

Class GatekeeperClient

java.lang.Object

com.nettoolkit.internal.NetToolKitClient

com.nettoolkit.gatekeeper.GatekeeperClient

public class GatekeeperClient
extends NetToolKitClient

GatekeeperClient is the primary class for interacting with the Gatekeeper service web API. Every endpoint in the web API should have a corresponding method in this class.

Here's a typical usage of GatekeeperClient for visit authorization based on Java's HttpServlet:

 public class MyServlet extends HttpServlet {
     private GatekeeperClient gatekeeperClient;

     @Override
     public void init() throws ServletException {
         gatekeeperClient = new GatekeeperClient(NTK_API_KEY);
     }

     @Override
     protected void doGet(HttpServletRequest request, HttpServletResponse response)
             throws ServletException, IOException {
         StringBuffer url = request.getRequestURL();
         if (request.getQueryString() != null) {
             url.append("?").append(request.getQueryString());
         }
         Visit visit = gatekeeperClient.newAuthorizeVisitRequest()
             .ip(request.getRemoteAddr())
             .url(url.toString())
             .userAgent(request.getHeader("User-Agent"))
             .send();
         // Handle request based on authorization...
     }
 }
 

See Also:

• web API docs

Field Summary

Fields inherited from class com.nettoolkit.internal.NetToolKitClient

mbUseHttps, mHttpClient, miTimeout, mstrApiKey

Constructor Summary

Constructors

Constructor	Description
GatekeeperClient(String strApiKey)	Constructs a new GatekeeperClient which uses the given API key for requests.
GatekeeperClient(String strApiKey, boolean bUseHttps)

Method Summary

Modifier and Type	Method	Description
AddVisitorRequest	newAddVisitorRequest()	Creates a new request to add a visitor to a visitor group.
AuthorizeVisitRequest	newAuthorizeVisitRequest()	Creates a new request to authorize a visit.
CountVisitsForPolicyRequest	newCountVisitsForPolicyRequest()	Creates a new request to count visits for a certain policy.
CountVisitsRequest	newCountVisitsRequest()	Creates a new request to count visits.
GetPageGroupsRequest	newGetPageGroupsRequest()	Create a new request to get page groups.
GetPoliciesRequest	newGetPoliciesRequest()	Creates a new request to get policies list.
GetVisitorGroupsRequest	newGetVisitorGroupsRequest()	Creates a new request to get visitor groups.
RemoveVisitorRequest	newRemoveVisitorRequest()	Creates a new request to remove a visitor from a visitor group.
ReportCaptchaAttemptRequest	newReportCaptchaAttemptRequest()	Creates a new request to report a CAPTCHA attempt.

Methods inherited from class com.nettoolkit.internal.NetToolKitClient

buildUrl, getApiKey, getBaseUrl, getFirstResult, getHostname, getProtocol, getResults, getTimeout, getUseHttps, parseResponse, send, sendDelete, sendDelete, sendGet, sendGet, sendHttpRequest, sendPost, sendPost, sendPost, sendPut, sendPut, sendPut, setApiKey, setTimeout, setUseHttps

Methods inherited from class java.lang.Object

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

Constructor Details

GatekeeperClient

public GatekeeperClient(String strApiKey)

Constructs a new GatekeeperClient which uses the given API key for requests.

Parameters:

strApiKey - The NetToolKit API key used to authenticate requests. All requests made by GatekeeperClient will use this API key.

GatekeeperClient

public GatekeeperClient(String strApiKey,
 boolean bUseHttps)

Method Details

newAuthorizeVisitRequest

public AuthorizeVisitRequest newAuthorizeVisitRequest()

Creates a new request to authorize a visit. Call AuthorizeVisitRequest.send() to execute.

Returns:

a new visit authorization request object

newGetPoliciesRequest

public GetPoliciesRequest newGetPoliciesRequest()

Creates a new request to get policies list. Call GetPoliciesRequest.send() to execute.

Returns:

a new get policies request object

newGetVisitorGroupsRequest

public GetVisitorGroupsRequest newGetVisitorGroupsRequest()

Creates a new request to get visitor groups. Call GetVisitorGroupsRequest.send() to execute.

Returns:

a new get visitor groups request object

newAddVisitorRequest

public AddVisitorRequest newAddVisitorRequest()

Creates a new request to add a visitor to a visitor group. Call AddVisitorRequest.send() to execute.

Returns:

a new add visitor request object

newRemoveVisitorRequest

public RemoveVisitorRequest newRemoveVisitorRequest()

Creates a new request to remove a visitor from a visitor group. Call RemoveVisitorRequest.send() to execute.

Returns:

a new remove visitor request object

newGetPageGroupsRequest

public GetPageGroupsRequest newGetPageGroupsRequest()

Create a new request to get page groups. Call GetPageGroupsRequest.send() to execute.

Returns:

a new get page groups request object

newCountVisitsRequest

public CountVisitsRequest newCountVisitsRequest()

Creates a new request to count visits. Call CountVisitsRequest.send() to execute.

Returns:

a new count visits request object

newCountVisitsForPolicyRequest

public CountVisitsForPolicyRequest newCountVisitsForPolicyRequest()

Creates a new request to count visits for a certain policy. Call CountVisitsForPolicyRequest.send() to execute.

Returns:

a new count visits for policy request object

newReportCaptchaAttemptRequest

public ReportCaptchaAttemptRequest newReportCaptchaAttemptRequest()

Creates a new request to report a CAPTCHA attempt. Call ReportCaptchaAttemptRequest.send() to execute.

Returns:

a new report CAPTCHA attempt request object