Package com.nettoolkit.gatekeeper

Class AddVisitorRequest

java.lang.Object

com.nettoolkit.internal.request.BaseApiRequest

com.nettoolkit.internal.request.PostRequest

com.nettoolkit.gatekeeper.AddVisitorRequest

public class AddVisitorRequest
extends PostRequest

Request to add a visitor to a visitor group. Corresponds to endpoint POST /v1/gatekeeper/visitor-groups/:visitor_group_id/visitors. Visitor group ID and visitor are required.

If the visitor already exists, the request succeeds without making any changes.

Sample:

 gatekeeperClient.newAddVisitorRequest()
     .visitorGroupId("b18f397b-d5f5-404a-b26c-00e295d3b3d3")
     .visitor("1.2.3.4")
     .send();
 

Constructor Summary

Constructors

Constructor	Description
AddVisitorRequest(GatekeeperClient client)

Method Summary

Modifier and Type	Method	Description
protected HttpContentType	getContentType()
protected String	getPath()
void	send()	Sends the request.
AddVisitorRequest	visitor(String strVisitor)	Sets the visitor value.
AddVisitorRequest	visitorGroupId(String strVisitorGroupId)	Sets the visitor group ID.
AddVisitorRequest	visitorGroupId(UUID visitorGroupId)	Sets the visitor group ID.

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

getHttpMethod, newHttpRequestBuilder, serializeParameters

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

getClient, getParameters, toHttpRequest, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AddVisitorRequest

public AddVisitorRequest(GatekeeperClient client)

Method Details

getContentType

protected HttpContentType getContentType()

Specified by:

getContentType in class PostRequest

getPath

protected String getPath()

Specified by:

getPath in class BaseApiRequest

visitorGroupId

public AddVisitorRequest visitorGroupId(UUID visitorGroupId)

Sets the visitor group ID. The visitor will be added to this visitor group. required

Parameters:

visitorGroupId - the visitor group ID

Returns:

this

visitorGroupId

public AddVisitorRequest visitorGroupId(String strVisitorGroupId)

Sets the visitor group ID.

Parameters:

strVisitorGroupId - the visitor group ID as a string

Returns:

this

Throws:

IllegalArgumentException - if the string is not a valid UUID

See Also:

• visitorGroupId(UUID)

visitor

public AddVisitorRequest visitor(String strVisitor)

Sets the visitor value. The visitor must be a valid member of the visitor group type.

Parameters:

strVisitor - the visitor value

Returns:

this

See Also:

• visitor type docs

send

public void send()
          throws NetToolKitException

Sends the request.

Throws:

NetToolKitException