ApiOptions (Rhino REST API Framework)

java.lang.Object
- com.opencloud.slee.rest.common.ApiOptions

public final class ApiOptions
extends java.lang.Object

A set of common API options.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ApiOptions.PreferredBodyType
Specify which encoding should be preferred if an operation allows both JSON and XML bodies

Field Summary

Fields
Modifier and Type	Field	Description
`static ApiOption<java.lang.String>`	`clusterCallbackUrl`	The base URL to be used for a callback, that will target the cluster (optional)
`static ApiOption<java.lang.String>`	`destinationUrl`	The destination URL to be used when sending API requests (other than callbacks)
`static ApiOption<java.lang.String>`	`localCallbackUrl`	The base URL to be used for a callback, that will target the current cluster node (optional)
`static ApiOption<java.lang.String>`	`password`	The password for HTTP Basic authentication.
`static ApiOption<ApiOptions.PreferredBodyType>`	`preferredBodyType`	If an operation allows more than one content type, send using XML or JSON as specified.
`static ApiOption<java.lang.String>`	`userName`	The username for HTTP Basic authentication

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - destinationUrl
```
public static final ApiOption<java.lang.String> destinationUrl
```
    The destination URL to be used when sending API requests (other than callbacks)
  - localCallbackUrl
```
public static final ApiOption<java.lang.String> localCallbackUrl
```
    The base URL to be used for a callback, that will target the current cluster node (optional)
  - clusterCallbackUrl
```
public static final ApiOption<java.lang.String> clusterCallbackUrl
```
    The base URL to be used for a callback, that will target the cluster (optional)
  - userName
```
public static final ApiOption<java.lang.String> userName
```
    The username for HTTP Basic authentication
  - password
```
public static final ApiOption<java.lang.String> password
```
    The password for HTTP Basic authentication. The password should be base64 encoded on value set.
  - preferredBodyType
```
public static final ApiOption<ApiOptions.PreferredBodyType> preferredBodyType
```
    If an operation allows more than one content type, send using XML or JSON as specified. If this option is NONE or not set, then JSON will be used if available.