Constants (CWS - API 1.1.0 API)

java.lang.Object
- io.javadog.cws.api.common.Constants

```
public final class Constants
extends Object
```
Common Constant values used throughout the API.

Since:

CWS 1.0

Author:

Kim Jensen

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADMIN_ACCOUNT` The System Administrator Account - this account is used as the default standard administrative Member Account, and cannot be altered.
`static String`	`CWS_VERSION` The current version of the CWS, this is used to tell Clients which version is being communicated with, and the same number is also being used to generate the SerialVersionUID for all API Classes.
`static String`	`DATA_TYPENAME`
`static String`	`FIELD_ACCOUNT_NAME`
`static String`	`FIELD_ACTION`
`static String`	`FIELD_ADDED`
`static String`	`FIELD_CHANGED`
`static String`	`FIELD_CHECKSUM`
`static String`	`FIELD_CIRCLE`
`static String`	`FIELD_CIRCLE_ID`
`static String`	`FIELD_CIRCLE_KEY`
`static String`	`FIELD_CIRCLE_NAME`
`static String`	`FIELD_CIRCLES`
`static String`	`FIELD_CREDENTIAL`
`static String`	`FIELD_CREDENTIALTYPE`
`static String`	`FIELD_DATA`
`static String`	`FIELD_DATA_ID`
`static String`	`FIELD_DATA_NAME`
`static String`	`FIELD_DATATYPE`
`static String`	`FIELD_DATATYPES`
`static String`	`FIELD_EXPIRES`
`static String`	`FIELD_FOLDER_ID`
`static String`	`FIELD_IDS`
`static String`	`FIELD_LAST_VERIFICATION`
`static String`	`FIELD_MEMBER`
`static String`	`FIELD_MEMBER_ID`
`static String`	`FIELD_MEMBER_ROLE`
`static String`	`FIELD_MEMBERS`
`static String`	`FIELD_METADATA`
`static String`	`FIELD_NEW_ACCOUNT_NAME`
`static String`	`FIELD_NEW_CREDENTIAL`
`static String`	`FIELD_PAGE_NUMBER`
`static String`	`FIELD_PAGE_SIZE`
`static String`	`FIELD_PUBLIC_KEY`
`static String`	`FIELD_RECORDS`
`static String`	`FIELD_RETURN_CODE`
`static String`	`FIELD_RETURN_MESSAGE`
`static String`	`FIELD_SANITIES`
`static String`	`FIELD_SANITY`
`static String`	`FIELD_SECRET`
`static String`	`FIELD_SETTINGS`
`static String`	`FIELD_SIGNATURE`
`static String`	`FIELD_SIGNATURES`
`static String`	`FIELD_SINCE`
`static String`	`FIELD_TARGET_CIRCLE_ID`
`static String`	`FIELD_TARGET_FOLDER_ID`
`static String`	`FIELD_TRUSTEE`
`static String`	`FIELD_TRUSTEES`
`static String`	`FIELD_TRUSTLEVEL`
`static String`	`FIELD_TYPE`
`static String`	`FIELD_TYPENAME`
`static String`	`FIELD_URL`
`static String`	`FIELD_VERIFICATIONS`
`static String`	`FIELD_VERIFIED`
`static String`	`FIELD_VERSION`
`static String`	`FOLDER_TYPENAME`
`static Pattern`	`ID_PATTERN` Pattern to test if a given value matches a UUID, which is what CWS uses for some Ids.
`static int`	`MAX_NAME_LENGTH`
`static int`	`MAX_PAGE_SIZE`
`static int`	`MAX_STRING_LENGTH`
`static String`	`REST_API`
`static String`	`REST_AUTHENTICATED`
`static String`	`REST_CIRCLES_BASE`
`static String`	`REST_CIRCLES_CREATE`
`static String`	`REST_CIRCLES_DELETE`
`static String`	`REST_CIRCLES_FETCH`
`static String`	`REST_CIRCLES_UPDATE`
`static String`	`REST_DATA_ADD`
`static String`	`REST_DATA_BASE`
`static String`	`REST_DATA_COPY`
`static String`	`REST_DATA_DELETE`
`static String`	`REST_DATA_FETCH`
`static String`	`REST_DATA_MOVE`
`static String`	`REST_DATA_UPDATE`
`static String`	`REST_DATATYPES_BASE`
`static String`	`REST_DATATYPES_DELETE`
`static String`	`REST_DATATYPES_FETCH`
`static String`	`REST_DATATYPES_PROCESS`
`static String`	`REST_MASTERKEY`
`static String`	`REST_MEMBERS_ALTER`
`static String`	`REST_MEMBERS_BASE`
`static String`	`REST_MEMBERS_CREATE`
`static String`	`REST_MEMBERS_DELETE`
`static String`	`REST_MEMBERS_FETCH`
`static String`	`REST_MEMBERS_INVALIDATE`
`static String`	`REST_MEMBERS_INVITE`
`static String`	`REST_MEMBERS_LOGIN`
`static String`	`REST_MEMBERS_LOGOUT`
`static String`	`REST_MEMBERS_UPDATE`
`static String`	`REST_SANITIZED`
`static String`	`REST_SETTINGS`
`static String`	`REST_SIGNATURES_BASE`
`static String`	`REST_SIGNATURES_FETCH`
`static String`	`REST_SIGNATURES_SIGN`
`static String`	`REST_SIGNATURES_VERIFY`
`static String`	`REST_TRUSTEES_ADD`
`static String`	`REST_TRUSTEES_ALTER`
`static String`	`REST_TRUSTEES_BASE`
`static String`	`REST_TRUSTEES_FETCH`
`static String`	`REST_TRUSTEES_REMOVE`
`static String`	`REST_VERSION`
`static long`	`SERIAL_VERSION_UID` All serialized classes should use this value.

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

- Field Detail
  - CWS_VERSION
```
public static final String CWS_VERSION
```
    The current version of the CWS, this is used to tell Clients which version is being communicated with, and the same number is also being used to generate the SerialVersionUID for all API Classes.
    
    See Also:
    
    Constant Field Values
  - SERIAL_VERSION_UID
```
public static final long SERIAL_VERSION_UID
```
    All serialized classes should use this value. The value reflects the current version of the system. If updates are made in one or more of the serialized classes, it should be updated.
    
    If not used, then all classes that are serialized will have a runtime performance overhead while calculating a UID, which matches the current class. See "Effective Java, 2nd Edition" - Item 75.
    
    As this is a useless overhead and simple to avoid, it is recommended to do so. Just add the following line in the beginning of all serialized and derived classes:
    private static final long serialVersionUID = Constants.SERIAL_VERSION_UID;
  - ID_PATTERN
```
public static final Pattern ID_PATTERN
```
    Pattern to test if a given value matches a UUID, which is what CWS uses for some Ids.
  - ADMIN_ACCOUNT
```
public static final String ADMIN_ACCOUNT
```
    The System Administrator Account - this account is used as the default standard administrative Member Account, and cannot be altered. Upon first attempt to process a Member, the System Administrator Account will be stored in the underlying database with the credentials provided. This way, the Account Name of the System Administrator will remain well-known, however - as there are not default credentials, there's also nothing to exploit.
    
    See Also:
    
    Constant Field Values
  - FOLDER_TYPENAME
```
public static final String FOLDER_TYPENAME
```
    See Also:
    
    Constant Field Values
  - DATA_TYPENAME
```
public static final String DATA_TYPENAME
```
    See Also:
    
    Constant Field Values
  - MAX_NAME_LENGTH
```
public static final int MAX_NAME_LENGTH
```
    See Also:
    
    Constant Field Values
  - MAX_STRING_LENGTH
```
public static final int MAX_STRING_LENGTH
```
    See Also:
    
    Constant Field Values
  - MAX_PAGE_SIZE
```
public static final int MAX_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - FIELD_IDS
```
public static final String FIELD_IDS
```
    See Also:
    
    Constant Field Values
  - FIELD_CIRCLE_ID
```
public static final String FIELD_CIRCLE_ID
```
    See Also:
    
    Constant Field Values
  - FIELD_TARGET_CIRCLE_ID
```
public static final String FIELD_TARGET_CIRCLE_ID
```
    See Also:
    
    Constant Field Values
  - FIELD_MEMBER_ID
```
public static final String FIELD_MEMBER_ID
```
    See Also:
    
    Constant Field Values
  - FIELD_FOLDER_ID
```
public static final String FIELD_FOLDER_ID
```
    See Also:
    
    Constant Field Values
  - FIELD_TARGET_FOLDER_ID
```
public static final String FIELD_TARGET_FOLDER_ID
```
    See Also:
    
    Constant Field Values
  - FIELD_DATA_ID
```
public static final String FIELD_DATA_ID
```
    See Also:
    
    Constant Field Values
  - FIELD_ACCOUNT_NAME
```
public static final String FIELD_ACCOUNT_NAME
```
    See Also:
    
    Constant Field Values
  - FIELD_PUBLIC_KEY
```
public static final String FIELD_PUBLIC_KEY
```
    See Also:
    
    Constant Field Values
  - FIELD_NEW_ACCOUNT_NAME
```
public static final String FIELD_NEW_ACCOUNT_NAME
```
    See Also:
    
    Constant Field Values
  - FIELD_CREDENTIAL
```
public static final String FIELD_CREDENTIAL
```
    See Also:
    
    Constant Field Values
  - FIELD_NEW_CREDENTIAL
```
public static final String FIELD_NEW_CREDENTIAL
```
    See Also:
    
    Constant Field Values
  - FIELD_MEMBER_ROLE
```
public static final String FIELD_MEMBER_ROLE
```
    See Also:
    
    Constant Field Values
  - FIELD_CREDENTIALTYPE
```
public static final String FIELD_CREDENTIALTYPE
```
    See Also:
    
    Constant Field Values
  - FIELD_CIRCLE
```
public static final String FIELD_CIRCLE
```
    See Also:
    
    Constant Field Values
  - FIELD_CIRCLES
```
public static final String FIELD_CIRCLES
```
    See Also:
    
    Constant Field Values
  - FIELD_CIRCLE_KEY
```
public static final String FIELD_CIRCLE_KEY
```
    See Also:
    
    Constant Field Values
  - FIELD_CIRCLE_NAME
```
public static final String FIELD_CIRCLE_NAME
```
    See Also:
    
    Constant Field Values
  - FIELD_TRUSTEE
```
public static final String FIELD_TRUSTEE
```
    See Also:
    
    Constant Field Values
  - FIELD_TRUSTEES
```
public static final String FIELD_TRUSTEES
```
    See Also:
    
    Constant Field Values
  - FIELD_MEMBER
```
public static final String FIELD_MEMBER
```
    See Also:
    
    Constant Field Values
  - FIELD_MEMBERS
```
public static final String FIELD_MEMBERS
```
    See Also:
    
    Constant Field Values
  - FIELD_TRUSTLEVEL
```
public static final String FIELD_TRUSTLEVEL
```
    See Also:
    
    Constant Field Values
  - FIELD_METADATA
```
public static final String FIELD_METADATA
```
    See Also:
    
    Constant Field Values
  - FIELD_DATA_NAME
```
public static final String FIELD_DATA_NAME
```
    See Also:
    
    Constant Field Values
  - FIELD_RECORDS
```
public static final String FIELD_RECORDS
```
    See Also:
    
    Constant Field Values
  - FIELD_DATA
```
public static final String FIELD_DATA
```
    See Also:
    
    Constant Field Values
  - FIELD_DATATYPE
```
public static final String FIELD_DATATYPE
```
    See Also:
    
    Constant Field Values
  - FIELD_DATATYPES
```
public static final String FIELD_DATATYPES
```
    See Also:
    
    Constant Field Values
  - FIELD_TYPENAME
```
public static final String FIELD_TYPENAME
```
    See Also:
    
    Constant Field Values
  - FIELD_TYPE
```
public static final String FIELD_TYPE
```
    See Also:
    
    Constant Field Values
  - FIELD_CHECKSUM
```
public static final String FIELD_CHECKSUM
```
    See Also:
    
    Constant Field Values
  - FIELD_SIGNATURE
```
public static final String FIELD_SIGNATURE
```
    See Also:
    
    Constant Field Values
  - FIELD_SIGNATURES
```
public static final String FIELD_SIGNATURES
```
    See Also:
    
    Constant Field Values
  - FIELD_SANITY
```
public static final String FIELD_SANITY
```
    See Also:
    
    Constant Field Values
  - FIELD_SANITIES
```
public static final String FIELD_SANITIES
```
    See Also:
    
    Constant Field Values
  - FIELD_SETTINGS
```
public static final String FIELD_SETTINGS
```
    See Also:
    
    Constant Field Values
  - FIELD_SECRET
```
public static final String FIELD_SECRET
```
    See Also:
    
    Constant Field Values
  - FIELD_EXPIRES
```
public static final String FIELD_EXPIRES
```
    See Also:
    
    Constant Field Values
  - FIELD_VERIFICATIONS
```
public static final String FIELD_VERIFICATIONS
```
    See Also:
    
    Constant Field Values
  - FIELD_LAST_VERIFICATION
```
public static final String FIELD_LAST_VERIFICATION
```
    See Also:
    
    Constant Field Values
  - FIELD_ADDED
```
public static final String FIELD_ADDED
```
    See Also:
    
    Constant Field Values
  - FIELD_CHANGED
```
public static final String FIELD_CHANGED
```
    See Also:
    
    Constant Field Values
  - FIELD_SINCE
```
public static final String FIELD_SINCE
```
    See Also:
    
    Constant Field Values
  - FIELD_VERSION
```
public static final String FIELD_VERSION
```
    See Also:
    
    Constant Field Values
  - FIELD_VERIFIED
```
public static final String FIELD_VERIFIED
```
    See Also:
    
    Constant Field Values
  - FIELD_ACTION
```
public static final String FIELD_ACTION
```
    See Also:
    
    Constant Field Values
  - FIELD_RETURN_CODE
```
public static final String FIELD_RETURN_CODE
```
    See Also:
    
    Constant Field Values
  - FIELD_RETURN_MESSAGE
```
public static final String FIELD_RETURN_MESSAGE
```
    See Also:
    
    Constant Field Values
  - FIELD_URL
```
public static final String FIELD_URL
```
    See Also:
    
    Constant Field Values
  - FIELD_PAGE_NUMBER
```
public static final String FIELD_PAGE_NUMBER
```
    See Also:
    
    Constant Field Values
  - FIELD_PAGE_SIZE
```
public static final String FIELD_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - REST_API
```
public static final String REST_API
```
    See Also:
    
    Constant Field Values
  - REST_VERSION
```
public static final String REST_VERSION
```
    See Also:
    
    Constant Field Values
  - REST_SETTINGS
```
public static final String REST_SETTINGS
```
    See Also:
    
    Constant Field Values
  - REST_MASTERKEY
```
public static final String REST_MASTERKEY
```
    See Also:
    
    Constant Field Values
  - REST_SANITIZED
```
public static final String REST_SANITIZED
```
    See Also:
    
    Constant Field Values
  - REST_AUTHENTICATED
```
public static final String REST_AUTHENTICATED
```
    See Also:
    
    Constant Field Values
  - REST_MEMBERS_BASE
```
public static final String REST_MEMBERS_BASE
```
    See Also:
    
    Constant Field Values
  - REST_MEMBERS_CREATE
```
public static final String REST_MEMBERS_CREATE
```
    See Also:
    
    Constant Field Values
  - REST_MEMBERS_INVITE
```
public static final String REST_MEMBERS_INVITE
```
    See Also:
    
    Constant Field Values
  - REST_MEMBERS_LOGIN
```
public static final String REST_MEMBERS_LOGIN
```
    See Also:
    
    Constant Field Values
  - REST_MEMBERS_LOGOUT
```
public static final String REST_MEMBERS_LOGOUT
```
    See Also:
    
    Constant Field Values
  - REST_MEMBERS_ALTER
```
public static final String REST_MEMBERS_ALTER
```
    See Also:
    
    Constant Field Values
  - REST_MEMBERS_UPDATE
```
public static final String REST_MEMBERS_UPDATE
```
    See Also:
    
    Constant Field Values
  - REST_MEMBERS_INVALIDATE
```
public static final String REST_MEMBERS_INVALIDATE
```
    See Also:
    
    Constant Field Values
  - REST_MEMBERS_DELETE
```
public static final String REST_MEMBERS_DELETE
```
    See Also:
    
    Constant Field Values
  - REST_MEMBERS_FETCH
```
public static final String REST_MEMBERS_FETCH
```
    See Also:
    
    Constant Field Values
  - REST_CIRCLES_BASE
```
public static final String REST_CIRCLES_BASE
```
    See Also:
    
    Constant Field Values
  - REST_CIRCLES_CREATE
```
public static final String REST_CIRCLES_CREATE
```
    See Also:
    
    Constant Field Values
  - REST_CIRCLES_UPDATE
```
public static final String REST_CIRCLES_UPDATE
```
    See Also:
    
    Constant Field Values
  - REST_CIRCLES_DELETE
```
public static final String REST_CIRCLES_DELETE
```
    See Also:
    
    Constant Field Values
  - REST_CIRCLES_FETCH
```
public static final String REST_CIRCLES_FETCH
```
    See Also:
    
    Constant Field Values
  - REST_TRUSTEES_BASE
```
public static final String REST_TRUSTEES_BASE
```
    See Also:
    
    Constant Field Values
  - REST_TRUSTEES_ADD
```
public static final String REST_TRUSTEES_ADD
```
    See Also:
    
    Constant Field Values
  - REST_TRUSTEES_ALTER
```
public static final String REST_TRUSTEES_ALTER
```
    See Also:
    
    Constant Field Values
  - REST_TRUSTEES_REMOVE
```
public static final String REST_TRUSTEES_REMOVE
```
    See Also:
    
    Constant Field Values
  - REST_TRUSTEES_FETCH
```
public static final String REST_TRUSTEES_FETCH
```
    See Also:
    
    Constant Field Values
  - REST_DATATYPES_BASE
```
public static final String REST_DATATYPES_BASE
```
    See Also:
    
    Constant Field Values
  - REST_DATATYPES_PROCESS
```
public static final String REST_DATATYPES_PROCESS
```
    See Also:
    
    Constant Field Values
  - REST_DATATYPES_DELETE
```
public static final String REST_DATATYPES_DELETE
```
    See Also:
    
    Constant Field Values
  - REST_DATATYPES_FETCH
```
public static final String REST_DATATYPES_FETCH
```
    See Also:
    
    Constant Field Values
  - REST_DATA_BASE
```
public static final String REST_DATA_BASE
```
    See Also:
    
    Constant Field Values
  - REST_DATA_ADD
```
public static final String REST_DATA_ADD
```
    See Also:
    
    Constant Field Values
  - REST_DATA_COPY
```
public static final String REST_DATA_COPY
```
    See Also:
    
    Constant Field Values
  - REST_DATA_MOVE
```
public static final String REST_DATA_MOVE
```
    See Also:
    
    Constant Field Values
  - REST_DATA_UPDATE
```
public static final String REST_DATA_UPDATE
```
    See Also:
    
    Constant Field Values
  - REST_DATA_DELETE
```
public static final String REST_DATA_DELETE
```
    See Also:
    
    Constant Field Values
  - REST_DATA_FETCH
```
public static final String REST_DATA_FETCH
```
    See Also:
    
    Constant Field Values
  - REST_SIGNATURES_BASE
```
public static final String REST_SIGNATURES_BASE
```
    See Also:
    
    Constant Field Values
  - REST_SIGNATURES_SIGN
```
public static final String REST_SIGNATURES_SIGN
```
    See Also:
    
    Constant Field Values
  - REST_SIGNATURES_VERIFY
```
public static final String REST_SIGNATURES_VERIFY
```
    See Also:
    
    Constant Field Values
  - REST_SIGNATURES_FETCH
```
public static final String REST_SIGNATURES_FETCH
```
    See Also:
    
    Constant Field Values

Class Constants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CWS_VERSION

SERIAL_VERSION_UID

ID_PATTERN

ADMIN_ACCOUNT

FOLDER_TYPENAME

DATA_TYPENAME

MAX_NAME_LENGTH

MAX_STRING_LENGTH

MAX_PAGE_SIZE

FIELD_IDS

FIELD_CIRCLE_ID

FIELD_TARGET_CIRCLE_ID

FIELD_MEMBER_ID

FIELD_FOLDER_ID

FIELD_TARGET_FOLDER_ID

FIELD_DATA_ID

FIELD_ACCOUNT_NAME

FIELD_PUBLIC_KEY

FIELD_NEW_ACCOUNT_NAME

FIELD_CREDENTIAL

FIELD_NEW_CREDENTIAL

FIELD_MEMBER_ROLE

FIELD_CREDENTIALTYPE

FIELD_CIRCLE

FIELD_CIRCLES

FIELD_CIRCLE_KEY

FIELD_CIRCLE_NAME

FIELD_TRUSTEE

FIELD_TRUSTEES

FIELD_MEMBER

FIELD_MEMBERS

FIELD_TRUSTLEVEL

FIELD_METADATA

FIELD_DATA_NAME

FIELD_RECORDS

FIELD_DATA

FIELD_DATATYPE

FIELD_DATATYPES

FIELD_TYPENAME

FIELD_TYPE

FIELD_CHECKSUM

FIELD_SIGNATURE

FIELD_SIGNATURES

FIELD_SANITY

FIELD_SANITIES

FIELD_SETTINGS

FIELD_SECRET

FIELD_EXPIRES

FIELD_VERIFICATIONS

FIELD_LAST_VERIFICATION

FIELD_ADDED

FIELD_CHANGED

FIELD_SINCE

FIELD_VERSION

FIELD_VERIFIED

FIELD_ACTION

FIELD_RETURN_CODE

FIELD_RETURN_MESSAGE

FIELD_URL

FIELD_PAGE_NUMBER

FIELD_PAGE_SIZE

REST_API

REST_VERSION

REST_SETTINGS

REST_MASTERKEY

REST_SANITIZED

REST_AUTHENTICATED

REST_MEMBERS_BASE

REST_MEMBERS_CREATE

REST_MEMBERS_INVITE

REST_MEMBERS_LOGIN

REST_MEMBERS_LOGOUT

REST_MEMBERS_ALTER

REST_MEMBERS_UPDATE

REST_MEMBERS_INVALIDATE