com.ibm.commerce.foundation.rest.providers

Class RestProviderConstants

  • java.lang.Object
    • com.ibm.commerce.foundation.rest.providers.RestProviderConstants

  • public class RestProviderConstants
extends java.lang.Object
    This class contains constants used by REST entity providers

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String ACTION_BLANK_RESPONSE
      The struts action of a blank JSP which is used when a struts action is unresolved.
      static java.lang.String ACTION_FORMAT_ATOM
      The struts action format of the formatting JSP for formatting ATOM Feed.
      static java.lang.String ACTION_PREFIX_ERROR
      The struts action prefix for error handling JSP.
      static java.lang.String DATA_LIST
      The key for a list of maps containing DataObject and other data.
      static java.lang.String DATA_OBJECT
      The key for a DataObject.
      static java.lang.String DEFAULT_RESULT_LIST_NAME
      Default result list name.
      static java.lang.String ERROR_CODE
      The Constant ERROR_CODE.
      static java.lang.String ERROR_HREF
      The Constant ERROR_HREF.
      static java.lang.String ERROR_KEY
      The Constant ERROR_KEY.
      static java.lang.String ERROR_LEVEL
      The Constant ERROR_LEVEL.
      static java.lang.String ERROR_MESSAGE
      The Constant ERROR_MESSAGE.
      static java.lang.String ERROR_PARAMETERS
      The Constant ERROR_PARAMETERS.
      static java.lang.String ERRORS
      The key for the list of errors/exceptions present in the data map passed to the JAX-RS entity provider.
      static java.lang.String FLATTEN_NOUN
      The key for flatten noun BOD_TO_MAP_CONFIG map.
      static java.lang.String FORMAT_GROUP_NAME
      The key for format group name, which will be used to resolve the main JSP.
      static java.lang.String IN_LOCAL_BINDING
      Constant for in Local Binding string used for the request attributes
      static java.lang.String LOCAL_BINDING_FLAG_FOR_TRANSACTION_CACHE_NAME
      Constant string for local binding flag for transaction cache name
      static java.lang.String LOCAL_BINDING_FLAG_FOR_TRANSACTION_CACHE_NAME_SPACE
      Constant string for local binding flag for transaction cache name space
      static java.lang.String LOCAL_BINDING_REQUEST_BODY
      Constant string for the request body used in Local Binding
      static java.lang.String LOCAL_BINDING_REQUEST_HEADERS
      Constant string for the request headers used in Local Binding
      static java.lang.String LOCAL_BINDING_RESPONSE
      Constant string for the qualified name of the response map used in Local Binding
      static java.lang.String LOCAL_BINDING_RESPONSE_HEADERS
      Constant string for the response headers used in Local Binding
      static java.lang.String LOCALBINDING_PATH_PREFIX_PROPERTY_NAME
      Constant string for the context path to be used in Local Binding
      static java.lang.String LOCALBINDING_REQUEST_METHOD_TYPE
      Constant string for the request method type in Local Binding
      static java.lang.String LOCALBINDING_RESPONSE_STATUS_CODE
      Constant string for status code of the response to be used in Local Binding
      static java.lang.String REQUEST_HEADER_EXCEPTION
      Constant string for the exception added to request header
      static java.lang.String REQUEST_URI
      The key for request URI in the request properties in the request to the formatting JSP.
      static java.lang.String RESOURCE_HANDLER
      The key for resource handler, which will be used to invoke postProcess.
      static java.lang.String RESOURCE_ID
      The key for RESOURCE_ID in BOD_TO_MAP_CONFIG map.
      static java.lang.String RESOURCE_NAME
      The key for resource name in BOD_TO_MAP_CONFIG map.
      static java.lang.String RESULT_DATA
      The key for a map containing result data when DataObject is not returned in resource handler.
      static java.lang.String RESULT_LIST_NAME
      Key for the result list name in the BOD_TO_MAP_CONFIG map.
      static java.lang.String SHOW
      Constant for ShowType
      static java.lang.String STRUTS_MODULE_ATTRIBUTE
      The struts module name used to fetch the struts action for resolving the struts action of the formatting JSP.
      static java.lang.String URL_FORMAT
      The URL format for the struts action of the formatting JSP.
      static java.lang.String URL_GROUP_NAME
      The key for URLParameterGroup name in BOD_TO_MAP_CONFIG map.
      static java.lang.String UTF8_ENCODING
      The UTF8 URL encoding constant.

    • Method Summary

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • FORMAT_GROUP_NAME

        public static final java.lang.String FORMAT_GROUP_NAME
        The key for format group name, which will be used to resolve the main JSP.
        See Also:
        Constant Field Values

      • RESOURCE_HANDLER

        public static final java.lang.String RESOURCE_HANDLER
        The key for resource handler, which will be used to invoke postProcess.
        See Also:
        Constant Field Values

      • DATA_LIST

        public static final java.lang.String DATA_LIST
        The key for a list of maps containing DataObject and other data.
        See Also:
        Constant Field Values

      • DATA_OBJECT

        public static final java.lang.String DATA_OBJECT
        The key for a DataObject.
        See Also:
        Constant Field Values

      • RESULT_DATA

        public static final java.lang.String RESULT_DATA
        The key for a map containing result data when DataObject is not returned in resource handler.
        See Also:
        Constant Field Values

      • RESOURCE_NAME

        public static final java.lang.String RESOURCE_NAME
        The key for resource name in BOD_TO_MAP_CONFIG map.
        See Also:
        Constant Field Values

      • URL_GROUP_NAME

        public static final java.lang.String URL_GROUP_NAME
        The key for URLParameterGroup name in BOD_TO_MAP_CONFIG map.
        See Also:
        Constant Field Values

      • RESOURCE_ID

        public static final java.lang.String RESOURCE_ID
        The key for RESOURCE_ID in BOD_TO_MAP_CONFIG map.
        See Also:
        Constant Field Values

      • FLATTEN_NOUN

        public static final java.lang.String FLATTEN_NOUN
        The key for flatten noun BOD_TO_MAP_CONFIG map.
        See Also:
        Constant Field Values

      • RESULT_LIST_NAME

        public static final java.lang.String RESULT_LIST_NAME
        Key for the result list name in the BOD_TO_MAP_CONFIG map.
        See Also:
        Constant Field Values

      • DEFAULT_RESULT_LIST_NAME

        public static final java.lang.String DEFAULT_RESULT_LIST_NAME
        Default result list name.
        See Also:
        Constant Field Values

      • ERRORS

        public static final java.lang.String ERRORS
        The key for the list of errors/exceptions present in the data map passed to the JAX-RS entity provider.
        See Also:
        Constant Field Values

      • ERROR_CODE

        public static final java.lang.String ERROR_CODE
        The Constant ERROR_CODE.
        See Also:
        Constant Field Values

      • ERROR_KEY

        public static final java.lang.String ERROR_KEY
        The Constant ERROR_KEY.
        See Also:
        Constant Field Values

      • ERROR_MESSAGE

        public static final java.lang.String ERROR_MESSAGE
        The Constant ERROR_MESSAGE.
        See Also:
        Constant Field Values

      • ERROR_PARAMETERS

        public static final java.lang.String ERROR_PARAMETERS
        The Constant ERROR_PARAMETERS.
        See Also:
        Constant Field Values

      • ERROR_HREF

        public static final java.lang.String ERROR_HREF
        The Constant ERROR_HREF.
        See Also:
        Constant Field Values

      • ERROR_LEVEL

        public static final java.lang.String ERROR_LEVEL
        The Constant ERROR_LEVEL.
        See Also:
        Constant Field Values

      • REQUEST_URI

        public static final java.lang.String REQUEST_URI
        The key for request URI in the request properties in the request to the formatting JSP.
        See Also:
        Constant Field Values

      • URL_FORMAT

        public static final java.lang.String URL_FORMAT
        The URL format for the struts action of the formatting JSP.
        See Also:
        Constant Field Values

      • STRUTS_MODULE_ATTRIBUTE

        public static final java.lang.String STRUTS_MODULE_ATTRIBUTE
        The struts module name used to fetch the struts action for resolving the struts action of the formatting JSP.
        See Also:
        Constant Field Values

      • UTF8_ENCODING

        public static final java.lang.String UTF8_ENCODING
        The UTF8 URL encoding constant.
        See Also:
        Constant Field Values

      • ACTION_FORMAT_ATOM

        public static final java.lang.String ACTION_FORMAT_ATOM
        The struts action format of the formatting JSP for formatting ATOM Feed.
        See Also:
        Constant Field Values

      • ACTION_BLANK_RESPONSE

        public static final java.lang.String ACTION_BLANK_RESPONSE
        The struts action of a blank JSP which is used when a struts action is unresolved.
        See Also:
        Constant Field Values

      • ACTION_PREFIX_ERROR

        public static final java.lang.String ACTION_PREFIX_ERROR
        The struts action prefix for error handling JSP.
        See Also:
        Constant Field Values

      • IN_LOCAL_BINDING

        public static final java.lang.String IN_LOCAL_BINDING
        Constant for in Local Binding string used for the request attributes
        See Also:
        Constant Field Values

      • LOCAL_BINDING_RESPONSE

        public static final java.lang.String LOCAL_BINDING_RESPONSE
        Constant string for the qualified name of the response map used in Local Binding
        See Also:
        Constant Field Values

      • LOCALBINDING_RESPONSE_STATUS_CODE

        public static final java.lang.String LOCALBINDING_RESPONSE_STATUS_CODE
        Constant string for status code of the response to be used in Local Binding
        See Also:
        Constant Field Values

      • LOCAL_BINDING_RESPONSE_HEADERS

        public static final java.lang.String LOCAL_BINDING_RESPONSE_HEADERS
        Constant string for the response headers used in Local Binding
        See Also:
        Constant Field Values

      • LOCALBINDING_REQUEST_METHOD_TYPE

        public static final java.lang.String LOCALBINDING_REQUEST_METHOD_TYPE
        Constant string for the request method type in Local Binding
        See Also:
        Constant Field Values

      • LOCALBINDING_PATH_PREFIX_PROPERTY_NAME

        public static final java.lang.String LOCALBINDING_PATH_PREFIX_PROPERTY_NAME
        Constant string for the context path to be used in Local Binding
        See Also:
        Constant Field Values

      • LOCAL_BINDING_REQUEST_HEADERS

        public static final java.lang.String LOCAL_BINDING_REQUEST_HEADERS
        Constant string for the request headers used in Local Binding
        See Also:
        Constant Field Values

      • LOCAL_BINDING_REQUEST_BODY

        public static final java.lang.String LOCAL_BINDING_REQUEST_BODY
        Constant string for the request body used in Local Binding
        See Also:
        Constant Field Values

      • REQUEST_HEADER_EXCEPTION

        public static final java.lang.String REQUEST_HEADER_EXCEPTION
        Constant string for the exception added to request header
        See Also:
        Constant Field Values

      • LOCAL_BINDING_FLAG_FOR_TRANSACTION_CACHE_NAME_SPACE

        public static final java.lang.String LOCAL_BINDING_FLAG_FOR_TRANSACTION_CACHE_NAME_SPACE
        Constant string for local binding flag for transaction cache name space
        See Also:
        Constant Field Values

      • LOCAL_BINDING_FLAG_FOR_TRANSACTION_CACHE_NAME

        public static final java.lang.String LOCAL_BINDING_FLAG_FOR_TRANSACTION_CACHE_NAME
        Constant string for local binding flag for transaction cache name
        See Also:
        Constant Field Values

    • Constructor Detail

      • RestProviderConstants

        public RestProviderConstants()
Skip navigation links