Package com.nettoolkit.gatekeeper

Class RemoveVisitorRequest

java.lang.Object

com.nettoolkit.internal.request.BaseApiRequest

com.nettoolkit.internal.request.DeleteRequest

com.nettoolkit.gatekeeper.RemoveVisitorRequest

public class RemoveVisitorRequest
extends DeleteRequest

Request to remove a visitor from a visitor group. Corresponds to endpoint DELETE /gatekeeper/visitor-groups/:visitor_group_id/visitors. Visitor group ID and visitor are required.

If the visitor does not exist, the request succeeds without making any changes.

Sample:

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

Constructor Summary

Constructors

Constructor	Description
RemoveVisitorRequest(GatekeeperClient client)

Method Summary

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

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

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

RemoveVisitorRequest

public RemoveVisitorRequest(GatekeeperClient client)

Method Details

getPath

public String getPath()

Specified by:

getPath in class BaseApiRequest

visitorGroupId

public RemoveVisitorRequest visitorGroupId(UUID visitorGroupId)

Sets the visitor group ID. The visitor will be removed from this visitor group. required

Parameters:

visitorGroupId - the visitor group ID

Returns:

this

visitorGroupId

public RemoveVisitorRequest 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 RemoveVisitorRequest visitor(String strVisitor)

Sets the visitor value.

Parameters:

strVisitor - the visitor value

Returns:

this

See Also:

• visitor type docs

send

public void send()
          throws NetToolKitException

Sends the request.

Throws:

NetToolKitException