Package com.nettoolkit.gatekeeper

Class CountVisitsForPolicyRequest

java.lang.Object

com.nettoolkit.internal.request.BaseApiRequest

com.nettoolkit.internal.request.GetRequest

com.nettoolkit.gatekeeper.CountVisitsForPolicyRequest

public class CountVisitsForPolicyRequest
extends GetRequest

Request to count visits for a certain policy. Corresponds to endpoint GET /v1/gatekeeper/visits/count-for-policy. Policy ID and IP address are required.

Sample:

 int numVisits = gatekeeperClient.newCountVisitsForPolicyRequest()
     .policyId("14f4a740-e3ef-47a4-8315-aa4316c2e7b5")
     .ip("1.2.3.4")
     .send();
 

Constructor Summary

Constructors

Constructor	Description
CountVisitsForPolicyRequest(GatekeeperClient client)

Method Summary

Modifier and Type	Method	Description
protected String	getPath()
CountVisitsForPolicyRequest	ip(String strIpAddress)	Sets the visit IP address.
CountVisitsForPolicyRequest	policyId(String strPolicyId)	Sets the policy ID.
CountVisitsForPolicyRequest	policyId(UUID policyId)	Sets the policy ID.
int	send()	Sends the request.

Methods inherited from class com.nettoolkit.internal.request.GetRequest

getHttpMethod, serializeParameters

Methods inherited from class com.nettoolkit.internal.request.BaseApiRequest

getClient, getParameters, newHttpRequestBuilder, toHttpRequest, toString

Methods inherited from class java.lang.Object

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

Constructor Details

CountVisitsForPolicyRequest

public CountVisitsForPolicyRequest(GatekeeperClient client)

Method Details

getPath

protected String getPath()

Specified by:

getPath in class BaseApiRequest

policyId

public CountVisitsForPolicyRequest policyId(UUID policyId)

Sets the policy ID. The visit count as seen by this policy will be returned. required

Parameters:

policyId - the policy ID

Returns:

this

policyId

public CountVisitsForPolicyRequest policyId(String strPolicyId)

Sets the policy ID.

Parameters:

strPolicyId - the policy ID as a string

Returns:

this

Throws:

IllegalArgumentException - if the string is not a valid UUID

See Also:

• policyId(UUID)

ip

public CountVisitsForPolicyRequest ip(String strIpAddress)

Sets the visit IP address. Expects dot notation for IPv4 and hexadecimal for IPv6. required

Parameters:

strIpAddress - the IP address in dot or hexadecimal format

Returns:

this

send

public int send()
         throws NetToolKitException

Sends the request.

Returns:

the visit count for IP address as seen by policy

Throws:

NetToolKitException