RestConstants (Waarp Common 3.3.4 API Reference)

java.lang.Object
- org.waarp.openr66.protocol.http.restv2.RestConstants

```
public final class RestConstants
extends Object
```
A list of all constants of the RESTv2 API.
This includes the URI of all the entry points, the name of HTTP headers specific to the API, the name of the JSON objects' fields, and a DAOFactory to create DAOs for access to the database.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RestConstants.ExportConfigParams` The names of the query parameters of the `GET` method on the server configuration entry point.
`static class`	`RestConstants.GetHostsParams` The names of the query parameters of the `GET` method on the host collection entry point.
`static class`	`RestConstants.GetLogsParams` The names of the query parameters of the `GET` method on the transfer logs entry point.
`static class`	`RestConstants.GetRulesParams` The names of the query parameters of the `GET` method on the rule collection entry point.
`static class`	`RestConstants.GetStatusParams` The names of the query parameters of the `GET` method on the server status entry point.
`static class`	`RestConstants.GetTransfersParams` The names of the query parameters of the `GET` method on the transfer collection entry point.
`static class`	`RestConstants.HostConfigFields` The names of the fields of a HostConfig JSON object.
`static class`	`RestConstants.HostFields` The names of the fields of a Host JSON object.
`static class`	`RestConstants.ImportConfigParams` The names of the query parameters of the `PUT` method on the server configuration entry point.
`static class`	`RestConstants.LimitsFields` The names of the fields of a Limits JSON object.
`static class`	`RestConstants.RuleFields` The names of the fields of a Rule JSON object.
`static class`	`RestConstants.ServerCommandsURI` The names of all the sub-paths of the `ServerHandler` corresponding to the server commands.
`static class`	`RestConstants.TransferCommandsURI` The names of the sub-paths of the `TransferIdHandler` corresponding to the transfer commands.
`static class`	`RestConstants.TransferFields` The names of the fields of a Transfer JSON object.

Field Summary

Fields
Modifier and Type	Field and Description
`static io.netty.util.AsciiString`	`AUTH_SIGNATURE` Name of the HTTP header used to store the signature key of a request.
`static io.netty.util.AsciiString`	`AUTH_TIMESTAMP` Name of the HTTP header used to store the timestamp of the request.
`static io.netty.util.AsciiString`	`AUTH_USER` Name of the HTTP header used to store the user who made a request.
`static String`	`CONFIG_HANDLER_URI` Access point of the host configuration.
`static DAOFactory`	`DAO_FACTORY` The DAO_FACTORY to generate connections to the underlying database.
`static String`	`HOST_ID_HANDLER_URI` Access point of a single host entry.
`static String`	`HOSTS_HANDLER_URI` Access point of the hosts collection.
`static String`	`LIMITS_HANDLER_URI` Access point of the bandwidth limits.
`static String`	`RULE_ID_HANDLER_URI` Access point of a single transfer rules entry.
`static String`	`RULES_HANDLER_URI` Access point of the transfer rules collection.
`static String`	`SERVER_HANDLER_URI` Access point of the server commands.
`static String`	`TRANSFER_ID_HANDLER_URI` Access point of a single transfer entry.
`static String`	`TRANSFERS_HANDLER_URI` Access point of the transfers collection.
`static String`	`URI_ID` Name of the URI parameter containing the id of an entry in a collection.
`static Charset`	`UTF8_CHARSET` The UTF-8 `Charset` constant.
`static String`	`VERSION_PREFIX` Root directory of the API.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`serverName()` The name of this R66 server instance.
`static String`	`serverName(String requested)` The name of this R66 server instance according to SSL or not of remote one.

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

- Field Detail
  - DAO_FACTORY
```
public static final DAOFactory DAO_FACTORY
```
    The DAO_FACTORY to generate connections to the underlying database.
  - UTF8_CHARSET
```
public static final Charset UTF8_CHARSET
```
    The UTF-8 Charset constant.
  - AUTH_USER
```
public static final io.netty.util.AsciiString AUTH_USER
```
    Name of the HTTP header used to store the user who made a request.
  - AUTH_TIMESTAMP
```
public static final io.netty.util.AsciiString AUTH_TIMESTAMP
```
    Name of the HTTP header used to store the timestamp of the request.
  - AUTH_SIGNATURE
```
public static final io.netty.util.AsciiString AUTH_SIGNATURE
```
    Name of the HTTP header used to store the signature key of a request.
  - VERSION_PREFIX
```
public static final String VERSION_PREFIX
```
    Root directory of the API.
    
    See Also:
    
    Constant Field Values
  - URI_ID
```
public static final String URI_ID
```
    Name of the URI parameter containing the id of an entry in a collection.
    
    See Also:
    
    Constant Field Values
  - TRANSFERS_HANDLER_URI
```
public static final String TRANSFERS_HANDLER_URI
```
    Access point of the transfers collection.
    
    See Also:
    
    Constant Field Values
  - TRANSFER_ID_HANDLER_URI
```
public static final String TRANSFER_ID_HANDLER_URI
```
    Access point of a single transfer entry.
    
    See Also:
    
    Constant Field Values
  - SERVER_HANDLER_URI
```
public static final String SERVER_HANDLER_URI
```
    Access point of the server commands.
    
    See Also:
    
    Constant Field Values
  - RULES_HANDLER_URI
```
public static final String RULES_HANDLER_URI
```
    Access point of the transfer rules collection.
    
    See Also:
    
    Constant Field Values
  - RULE_ID_HANDLER_URI
```
public static final String RULE_ID_HANDLER_URI
```
    Access point of a single transfer rules entry.
    
    See Also:
    
    Constant Field Values
  - LIMITS_HANDLER_URI
```
public static final String LIMITS_HANDLER_URI
```
    Access point of the bandwidth limits.
    
    See Also:
    
    Constant Field Values
  - HOSTS_HANDLER_URI
```
public static final String HOSTS_HANDLER_URI
```
    Access point of the hosts collection.
    
    See Also:
    
    Constant Field Values
  - HOST_ID_HANDLER_URI
```
public static final String HOST_ID_HANDLER_URI
```
    Access point of a single host entry.
    
    See Also:
    
    Constant Field Values
  - CONFIG_HANDLER_URI
```
public static final String CONFIG_HANDLER_URI
```
    Access point of the host configuration.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - serverName
```
public static final String serverName()
```
    The name of this R66 server instance.
    
    Returns:
    
    The name of this R66 Server
  - serverName
```
public static final String serverName(String requested)
```
    The name of this R66 server instance according to SSL or not of remote one.
    
    Parameters:
    
    requested -
    
    Returns:
    
    the name of this R66 server according to SSL

Class RestConstants

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DAO_FACTORY

UTF8_CHARSET

AUTH_USER

AUTH_TIMESTAMP

AUTH_SIGNATURE

VERSION_PREFIX

URI_ID

TRANSFERS_HANDLER_URI

TRANSFER_ID_HANDLER_URI

SERVER_HANDLER_URI

RULES_HANDLER_URI

RULE_ID_HANDLER_URI

LIMITS_HANDLER_URI

HOSTS_HANDLER_URI

HOST_ID_HANDLER_URI

CONFIG_HANDLER_URI

Method Detail

serverName

serverName