@ThingworxExtensionApiClass(since={6,6}, canInstantiate=true) public final class RESTAPIConstants extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
RESTAPIConstants.Characteristic |
static class |
RESTAPIConstants.FunctionType |
static class |
RESTAPIConstants.Method |
static class |
RESTAPIConstants.StatusCode |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACCEPT_HEADER |
static java.lang.String |
ACTION_CHANGE_PASSWORD |
static java.lang.String |
ACTION_CONFIRM |
static java.lang.String |
ACTION_LOGIN |
static java.lang.String |
ACTION_LOGOUT |
static java.lang.String |
ATTACHMENT |
static java.lang.String |
AVATAR_CHARACTERISTIC |
static java.lang.String |
CONFIRM_PATH |
static java.lang.String |
CONTENT_DISPOSITION |
static java.lang.String |
CONTENT_LENGTH |
static java.lang.String |
CONTENT_TYPE |
static char |
CR_CHARACTER |
static java.lang.String |
DEFAULT_ACCEPT_TYPE |
static java.lang.String |
DEFAULT_CONTENT_TYPE |
static int |
DEFAULT_FEED_ITEM_COUNT |
static int |
DEFAULT_ITEM_COUNT |
static int |
DEFAULT_SEARCH_ITEM_COUNT |
static int |
DEFAULT_TIMEOUT |
static java.lang.String |
DEFINITION_CHARACTERISTIC |
static java.lang.String |
DESIGNTIMEPERMISSIONCHECK_CHARACTERISTIC |
static java.lang.String |
FORM_LOGIN |
static java.lang.String |
FUNCTIONDEFINITIONS_CHARACTERISTIC |
static java.lang.String |
HEADER_AUTHENTICATE_CHALLENGE |
static java.lang.String |
HEADER_AUTHENTICATE_CHALLENGE_BASIC_REALM |
static java.lang.String |
HEADER_AUTHORIZATION |
static java.lang.String |
HEADER_AUTHORIZATION_BASIC |
static java.lang.String |
HEADER_AUTHORIZATION_MOBILE |
static java.lang.String |
HEADER_CONTENT_DISPOSITION |
static java.lang.String |
HEADER_COOKIE |
static java.lang.String |
HEADER_IF_NONE_MATCH |
static java.lang.String |
HEADER_IF_RANGE |
static java.lang.String |
HEADER_MOBILE_AUTH_REQUIRED |
static java.lang.String |
HEADER_TWX_MOBILE_TOKEN |
static java.lang.String |
HEADER_X_FORWARDED_FOR1 |
static java.lang.String |
HEADER_X_FORWARDED_FOR2 |
static char |
HTML_TAG_START_CHARACTER |
static java.lang.String |
IMPLEMENTINGTHINGS_CHARACTERISTIC |
static java.lang.String |
IMPLEMENTINGTHINGSWITHDATA_CHARACTERISTIC |
static java.lang.String |
INSTANCEEVENTDEFINITIONS_CHARACTERISTIC |
static java.lang.String |
INSTANCEMETADATA_CHARACTERISTIC |
static java.lang.String |
INSTANCEMETADATAWITHPERMISSIONS_CHARACTERISTIC |
static java.lang.String |
INSTANCEPROPERTYDEFINITIONS_CHARACTERISTIC |
static java.lang.String |
INSTANCESERVICEDEFINITIONS_CHARACTERISTIC |
static java.lang.String |
INTERNAL_ERROR_MESSAGE |
static java.lang.String |
LAST_ORGANIZATION_COOKIE_NAME |
static java.lang.String |
LOCALHOST_IPV4 |
static java.lang.String |
LOCALHOST_STRING |
static java.lang.String |
LOGIN_JSP_SUFFIX |
static java.lang.String |
MESSAGE_FIELD_NAME |
static java.lang.String |
METADATA_CHARACTERISTIC |
static java.lang.String |
METADATAWITHPERMISSIONS_CHARACTERISTIC |
static java.lang.String |
MIME_TYPE_APP_XML |
static java.lang.String |
MIME_TYPE_ATOM |
static java.lang.String |
MIME_TYPE_BINARY |
static java.lang.String |
MIME_TYPE_BMP |
static java.lang.String |
MIME_TYPE_CSV |
static java.lang.String |
MIME_TYPE_FORMDATA |
static java.lang.String |
MIME_TYPE_FORMENCODED |
static java.lang.String |
MIME_TYPE_GIF |
static java.lang.String |
MIME_TYPE_HTML |
static java.lang.String |
MIME_TYPE_JPG |
static java.lang.String |
MIME_TYPE_JSON |
static java.lang.String |
MIME_TYPE_JSONCOMPRESSED |
static java.lang.String |
MIME_TYPE_OCTETSTREAM |
static java.lang.String |
MIME_TYPE_PDF |
static java.lang.String |
MIME_TYPE_PNG |
static java.lang.String |
MIME_TYPE_RSS |
static java.lang.String |
MIME_TYPE_SVG |
static java.lang.String |
MIME_TYPE_TEXT |
static java.lang.String |
MIME_TYPE_UNKNOWNIMAGE |
static java.lang.String |
MIME_TYPE_WINDOWS_ICON |
static java.lang.String |
MIME_TYPE_XML |
static java.lang.String |
MIME_TYPE_ZIP |
static char |
NL_CHARACTER |
static java.lang.String |
ORGANIZATION_NAME |
static java.lang.String |
PARAM_APIMETHOD |
static java.lang.String |
PARAM_APPKEY |
static java.lang.String |
PARAM_AUTHTYPE |
static java.lang.String |
PARAM_CHARACTERISTIC |
static java.lang.String |
PARAM_ENTITYNAME |
static java.lang.String |
PARAM_ENTITYTYPE |
static java.lang.String |
PARAM_EXPIRES |
static java.lang.String |
PARAM_IF_MODIFIED_SINCE |
static java.lang.String |
PARAM_IF_UNMODIFIED_SINCE |
static java.lang.String |
PARAM_LAST_MODIFIED |
static java.lang.String |
PARAM_MAXITEMS |
static java.lang.String |
PARAM_METADATA |
static java.lang.String |
PARAM_METHOD |
static java.lang.String |
PARAM_NAMEMASK |
static java.lang.String |
PARAM_PASSWORD |
static java.lang.String |
PARAM_POSTPARAMETER |
static java.lang.String |
PARAM_REASON |
static java.lang.String |
PARAM_SEARCHASPECTS |
static java.lang.String |
PARAM_SEARCHTAGS |
static java.lang.String |
PARAM_TARGET |
static java.lang.String |
PARAM_THINGNAME |
static java.lang.String |
PARAM_TWSR |
static java.lang.String |
PARAM_USE_SESSION |
static java.lang.String |
PARAM_USERID |
static java.lang.String |
PARAM_USERNAME |
static java.lang.String |
PARAM_WITHPERMISSIONS |
static java.lang.String |
PARAMETER_DELIMITER |
static java.lang.String |
PARAMETER_VALUE_DELIMITER |
static java.lang.String |
PREVIEW_CHARACTERISTIC |
static java.lang.String |
PROTOCOL_FTP |
static java.lang.String |
PROTOCOL_HTTP |
static java.lang.String |
PROTOCOL_HTTPS |
static java.lang.String |
PROTOCOL_SFTP |
static java.lang.String |
PROTOCOL_SSL |
static java.lang.String |
PROTOCOL_TCP |
static java.lang.String |
PROTOCOL_WS |
static java.lang.String |
PROTOCOL_WSS |
static java.lang.String |
QUERY_DELIMITER |
static java.lang.String |
RELATIVE_PATH_STRING |
static java.lang.String |
RESET_PATH |
static int |
SESSION_DEFAULT_TIMEOUT |
static int |
SESSION_FOREVER |
static java.lang.String |
SUCCESS_MESSAGE |
static java.lang.String |
SUMMARY_CHARACTERISTIC |
static java.util.HashSet<java.lang.String> |
SUPPORTED_ACCEPT_TYPES |
static java.util.HashSet<java.lang.String> |
SUPPORTED_CONTENT_TYPES |
static java.util.HashSet<java.lang.String> |
SUPPORTED_IMAGE_TYPES |
static java.util.HashSet<java.lang.String> |
SUPPORTED_MEDIA_ENTITY_CONTENT_TYPES |
static java.lang.String |
THINGWORX_CHANGEPASSWORD_PAGE |
static java.lang.String |
THINGWORX_FORM_CURRENT_PASSWORD |
static java.lang.String |
THINGWORX_FORM_EMAIL |
static java.lang.String |
THINGWORX_FORM_FIRSTNAME |
static java.lang.String |
THINGWORX_FORM_LASTNAME |
static java.lang.String |
THINGWORX_FORM_NEW_PASSWORD |
static java.lang.String |
THINGWORX_FORM_NEW_PASSWORD_CONFIRM |
static java.lang.String |
THINGWORX_FORM_ORIGINAL_URI_FIELD |
static java.lang.String |
THINGWORX_FORM_PASSWORD |
static java.lang.String |
THINGWORX_FORM_USERNAME |
static java.lang.String |
THINGWORX_HOME_URI |
static java.lang.String |
THINGWORX_JSESSIONID |
static java.lang.String |
THINGWORX_LOGIN_ERROR_MESSAGE |
static java.lang.String |
THINGWORX_LOGIN_PAGE |
static java.lang.String |
THINGWORX_MAIN_PAGE |
static java.lang.String |
THINGWORX_PASSWORD_CHANGE_MESSAGE |
static java.lang.String |
THINGWORX_SESSIONID |
static java.lang.String |
TRACE_PARAMETER |
static java.lang.String |
UTF8_ENCODING |
static java.lang.String |
VISIBILITYPERMISSIONCHECK_CHARACTERISTIC |
static java.lang.String |
WEBAPP_NAME |
static java.lang.String |
WEBAPP_PATH_DELIMITER |
static java.lang.String |
WEBAPP_SCHEME_DELIMITER |
static java.lang.String |
WEBSOCKET_API_ENDPOINT |
static java.lang.String |
WEBSOCKET_RELATIVE_URI |
Constructor and Description |
---|
RESTAPIConstants() |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
buildBaseURL(java.lang.String servletName) |
static java.lang.String |
createURI(java.lang.String entityType,
java.lang.String entityName,
java.lang.String characteristic,
java.lang.String target) |
static RESTAPIConstants.Method |
getMethod(java.lang.String method) |
static java.lang.String |
getMethodName(byte method) |
static java.lang.String |
getSupportedAcceptType(java.lang.String type) |
static java.lang.String |
getSupportedContentType(java.lang.String type) |
static java.nio.charset.Charset |
getUTF8Charset() |
static boolean |
isError(int statusCode) |
static boolean |
isImageType(java.lang.String type) |
static boolean |
isOK(int statusCode) |
static boolean |
isRequest(byte code) |
static boolean |
isResponse(byte code) |
static java.lang.String[] |
splitURI(java.lang.String uri) |
public static final java.lang.String UTF8_ENCODING
public static final java.lang.String PROTOCOL_HTTP
public static final java.lang.String PROTOCOL_HTTPS
public static final java.lang.String PROTOCOL_TCP
public static final java.lang.String PROTOCOL_SSL
public static final java.lang.String PROTOCOL_FTP
public static final java.lang.String PROTOCOL_SFTP
public static final java.lang.String PROTOCOL_WS
public static final java.lang.String PROTOCOL_WSS
public static final java.lang.String WEBAPP_NAME
public static final java.lang.String FORM_LOGIN
public static final java.lang.String CONFIRM_PATH
public static final java.lang.String RESET_PATH
public static final java.lang.String WEBAPP_PATH_DELIMITER
public static final java.lang.String WEBAPP_SCHEME_DELIMITER
public static final java.lang.String QUERY_DELIMITER
public static final java.lang.String PARAMETER_DELIMITER
public static final java.lang.String PARAMETER_VALUE_DELIMITER
public static final java.lang.String WEBSOCKET_API_ENDPOINT
public static final java.lang.String WEBSOCKET_RELATIVE_URI
public static final java.lang.String LOGIN_JSP_SUFFIX
public static final java.lang.String PARAM_METHOD
public static final java.lang.String PARAM_MAXITEMS
public static final java.lang.String PARAM_SEARCHTAGS
public static final java.lang.String PARAM_SEARCHASPECTS
public static final java.lang.String PARAM_NAMEMASK
public static final java.lang.String PARAM_METADATA
public static final java.lang.String PARAM_ENTITYTYPE
public static final java.lang.String PARAM_ENTITYNAME
public static final java.lang.String PARAM_THINGNAME
public static final java.lang.String PARAM_CHARACTERISTIC
public static final java.lang.String PARAM_TARGET
public static final java.lang.String PARAM_APIMETHOD
public static final java.lang.String PARAM_WITHPERMISSIONS
public static final java.lang.String PARAM_POSTPARAMETER
public static final java.lang.String PARAM_TWSR
public static final java.lang.String ORGANIZATION_NAME
public static final java.lang.String LOCALHOST_STRING
public static final java.lang.String LOCALHOST_IPV4
public static final int SESSION_FOREVER
public static final int SESSION_DEFAULT_TIMEOUT
public static final java.lang.String THINGWORX_SESSIONID
public static final java.lang.String THINGWORX_JSESSIONID
public static final java.lang.String HEADER_AUTHENTICATE_CHALLENGE
public static final java.lang.String HEADER_AUTHENTICATE_CHALLENGE_BASIC_REALM
public static final java.lang.String HEADER_AUTHORIZATION
public static final java.lang.String HEADER_AUTHORIZATION_BASIC
public static final java.lang.String HEADER_AUTHORIZATION_MOBILE
public static final java.lang.String HEADER_TWX_MOBILE_TOKEN
public static final java.lang.String HEADER_MOBILE_AUTH_REQUIRED
public static final java.lang.String HEADER_X_FORWARDED_FOR1
public static final java.lang.String HEADER_X_FORWARDED_FOR2
public static final java.lang.String HEADER_COOKIE
public static final java.lang.String HEADER_IF_NONE_MATCH
public static final java.lang.String HEADER_IF_RANGE
public static final java.lang.String HEADER_CONTENT_DISPOSITION
public static final java.lang.String PARAM_AUTHTYPE
public static final java.lang.String PARAM_USERID
public static final java.lang.String PARAM_USERNAME
public static final java.lang.String PARAM_PASSWORD
public static final java.lang.String PARAM_APPKEY
public static final java.lang.String PARAM_USE_SESSION
public static final java.lang.String PARAM_IF_MODIFIED_SINCE
public static final java.lang.String PARAM_IF_UNMODIFIED_SINCE
public static final java.lang.String PARAM_LAST_MODIFIED
public static final java.lang.String PARAM_REASON
public static final java.lang.String PARAM_EXPIRES
public static final java.lang.String ACTION_LOGIN
public static final java.lang.String ACTION_CONFIRM
public static final java.lang.String ACTION_CHANGE_PASSWORD
public static final java.lang.String ACTION_LOGOUT
public static final java.lang.String THINGWORX_LOGIN_PAGE
public static final java.lang.String THINGWORX_MAIN_PAGE
public static final java.lang.String THINGWORX_CHANGEPASSWORD_PAGE
public static final java.lang.String THINGWORX_FORM_USERNAME
public static final java.lang.String THINGWORX_FORM_PASSWORD
public static final java.lang.String THINGWORX_FORM_FIRSTNAME
public static final java.lang.String THINGWORX_FORM_LASTNAME
public static final java.lang.String THINGWORX_FORM_EMAIL
public static final java.lang.String THINGWORX_FORM_CURRENT_PASSWORD
public static final java.lang.String THINGWORX_FORM_NEW_PASSWORD
public static final java.lang.String THINGWORX_FORM_NEW_PASSWORD_CONFIRM
public static final java.lang.String THINGWORX_FORM_ORIGINAL_URI_FIELD
public static final java.lang.String THINGWORX_LOGIN_ERROR_MESSAGE
public static final java.lang.String THINGWORX_PASSWORD_CHANGE_MESSAGE
public static final java.lang.String THINGWORX_HOME_URI
public static final java.lang.String LAST_ORGANIZATION_COOKIE_NAME
public static final java.lang.String INTERNAL_ERROR_MESSAGE
public static final java.lang.String MESSAGE_FIELD_NAME
public static final java.lang.String SUCCESS_MESSAGE
public static final java.lang.String MIME_TYPE_XML
public static final java.lang.String MIME_TYPE_HTML
public static final java.lang.String MIME_TYPE_ATOM
public static final java.lang.String MIME_TYPE_RSS
public static final java.lang.String MIME_TYPE_JSON
public static final java.lang.String MIME_TYPE_JSONCOMPRESSED
public static final java.lang.String MIME_TYPE_CSV
public static final java.lang.String MIME_TYPE_FORMENCODED
public static final java.lang.String MIME_TYPE_FORMDATA
public static final java.lang.String MIME_TYPE_SVG
public static final java.lang.String MIME_TYPE_PNG
public static final java.lang.String MIME_TYPE_ZIP
public static final java.lang.String MIME_TYPE_JPG
public static final java.lang.String MIME_TYPE_GIF
public static final java.lang.String MIME_TYPE_BMP
public static final java.lang.String MIME_TYPE_WINDOWS_ICON
public static final java.lang.String MIME_TYPE_PDF
public static final java.lang.String MIME_TYPE_UNKNOWNIMAGE
public static final java.lang.String MIME_TYPE_BINARY
public static final java.lang.String MIME_TYPE_OCTETSTREAM
public static final java.lang.String MIME_TYPE_TEXT
public static final java.lang.String MIME_TYPE_APP_XML
public static final java.lang.String DEFAULT_CONTENT_TYPE
public static final java.lang.String DEFAULT_ACCEPT_TYPE
public static java.util.HashSet<java.lang.String> SUPPORTED_CONTENT_TYPES
public static java.util.HashSet<java.lang.String> SUPPORTED_ACCEPT_TYPES
public static java.util.HashSet<java.lang.String> SUPPORTED_IMAGE_TYPES
public static java.util.HashSet<java.lang.String> SUPPORTED_MEDIA_ENTITY_CONTENT_TYPES
public static final java.lang.String CONTENT_TYPE
public static final java.lang.String CONTENT_LENGTH
public static final java.lang.String CONTENT_DISPOSITION
public static final java.lang.String ATTACHMENT
public static final java.lang.String ACCEPT_HEADER
public static final int DEFAULT_ITEM_COUNT
public static final int DEFAULT_SEARCH_ITEM_COUNT
public static final int DEFAULT_FEED_ITEM_COUNT
public static final int DEFAULT_TIMEOUT
public static final java.lang.String AVATAR_CHARACTERISTIC
public static final java.lang.String PREVIEW_CHARACTERISTIC
public static final java.lang.String DEFINITION_CHARACTERISTIC
public static final java.lang.String METADATA_CHARACTERISTIC
public static final java.lang.String METADATAWITHPERMISSIONS_CHARACTERISTIC
public static final java.lang.String INSTANCEMETADATA_CHARACTERISTIC
public static final java.lang.String INSTANCEMETADATAWITHPERMISSIONS_CHARACTERISTIC
public static final java.lang.String INSTANCESERVICEDEFINITIONS_CHARACTERISTIC
public static final java.lang.String INSTANCEPROPERTYDEFINITIONS_CHARACTERISTIC
public static final java.lang.String INSTANCEEVENTDEFINITIONS_CHARACTERISTIC
public static final java.lang.String FUNCTIONDEFINITIONS_CHARACTERISTIC
public static final java.lang.String IMPLEMENTINGTHINGS_CHARACTERISTIC
public static final java.lang.String IMPLEMENTINGTHINGSWITHDATA_CHARACTERISTIC
public static final java.lang.String SUMMARY_CHARACTERISTIC
public static final java.lang.String DESIGNTIMEPERMISSIONCHECK_CHARACTERISTIC
public static final java.lang.String VISIBILITYPERMISSIONCHECK_CHARACTERISTIC
public static final java.lang.String RELATIVE_PATH_STRING
public static final java.lang.String TRACE_PARAMETER
public static final char NL_CHARACTER
public static final char CR_CHARACTER
public static final char HTML_TAG_START_CHARACTER
@ThingworxExtensionApiMethod(since={6,6}) public static boolean isRequest(byte code)
@ThingworxExtensionApiMethod(since={6,6}) public static boolean isResponse(byte code)
@ThingworxExtensionApiMethod(since={6,6}) public static java.nio.charset.Charset getUTF8Charset()
@ThingworxExtensionApiMethod(since={6,6}) public static RESTAPIConstants.Method getMethod(java.lang.String method)
@ThingworxExtensionApiMethod(since={6,6}) public static java.lang.String getMethodName(byte method)
@ThingworxExtensionApiMethod(since={6,6}) public static java.lang.String getSupportedContentType(java.lang.String type)
@ThingworxExtensionApiMethod(since={6,6}) public static boolean isImageType(java.lang.String type)
@ThingworxExtensionApiMethod(since={6,6}) public static java.lang.String getSupportedAcceptType(java.lang.String type)
@ThingworxExtensionApiMethod(since={6,6}) public static java.lang.String buildBaseURL(java.lang.String servletName)
@ThingworxExtensionApiMethod(since={6,6}) public static java.lang.String[] splitURI(java.lang.String uri)
@ThingworxExtensionApiMethod(since={6,6}) public static java.lang.String createURI(java.lang.String entityType, java.lang.String entityName, java.lang.String characteristic, java.lang.String target)
@ThingworxExtensionApiMethod(since={6,6}) public static boolean isOK(int statusCode)
@ThingworxExtensionApiMethod(since={6,6}) public static boolean isError(int statusCode)