ApiKeyAuthentication Class

Definition

ApiKey authentication gives a name and a value that can be included in either the request header or query parameters.

public final class ApiKeyAuthentication extends RestRequestAuthentication
Inheritance
java.lang.Object
ApiKeyAuthentication

Inherited Members

RestRequestAuthentication.validate() java.lang.Object.clone() java.lang.Object.equals(java.lang.Object) java.lang.Object.finalize() java.lang.Object.getClass() java.lang.Object.hashCode() java.lang.Object.notify() java.lang.Object.notifyAll() java.lang.Object.toString() java.lang.Object.wait() java.lang.Object.wait(long) java.lang.Object.wait(long,int)

Constructors

ApiKeyAuthentication()

Methods

in()

Get the in property: The location of the authentication key/value pair in the request.

name()

Get the name property: The key name of the authentication key/value pair.

validate()

Validates the instance.

value()

Get the value property: The value of the authentication key/value pair.

withIn(RestAuthLocation in)

Set the in property: The location of the authentication key/value pair in the request.

withName(String name)

Set the name property: The key name of the authentication key/value pair.

withValue(String value)

Set the value property: The value of the authentication key/value pair.

Applies to