com.ibm.commerce.server

Class JSPHelper

java.lang.Object

com.ibm.commerce.server.ServletHelper

com.ibm.commerce.server.JSPHelper

All Implemented Interfaces:

ECConstants

public class JSPHelper
extends ServletHelper

This is a JSP helper class to help JSP writers retrieve data from an HttpServletRequest. It will look for the parameter either from the request attribute or the request parameters. This way, the user won't need to distinguish between a JSP that is invoked through the use of a forward or a redirect.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from interface com.ibm.commerce.server.ECConstants

ACT_READ, ACT_WRITE, CFG_KEY_LOCATOR_FRAMEWORK_CONFIG_FILE, CFG_MERCHANT_KEY, CFG_MERCHANT_KEY_NAME, CFG_SESSION_KEY, CFG_SESSION_KEY_NAME, COMMERCE_PRODUCT_FILE, EC_ACC_ALL_RESOURCES, EC_ACC_CONTROLLER, EC_ACC_DEFAULT_POLICYMANAGER_CLASSNAME, EC_ACC_DEFAULT_POLICYMANAGER_CREATEINSTANCE_METHOD, EC_ACC_ERROR_VIEW, EC_ACC_VIEW, EC_ACTIVITYDATA, EC_ADDR_PERMANENT, EC_ADDR_RN, EC_ADDR_TEMPORARY, EC_ADDRESS, EC_ADDRESSBOOK, EC_ADMIN_USER_TYPE, EC_ATTACH_AURL, EC_ATTACH_CFG_CMD_FILEEXT, EC_ATTACH_CFG_CMD_MAXSIZE, EC_ATTACH_CFG_CMD_NAME, EC_ATTACH_CFG_CMD_RETURNURL, EC_ATTACH_CFG_CMD_VIRUSCHK, EC_ATTACH_CFG_COMPRESSED_FILE_MAXEXTRACTEDFILESIZE, EC_ATTACH_CFG_COMPRESSED_FILE_MAXFILENUM, EC_ATTACH_CFG_MAXSIZE, EC_ATTACH_DOT, EC_ATTACH_ErrorURL, EC_ATTACH_FILENAME, EC_ATTACH_FilePath, EC_ATTACH_ID, EC_ATTACH_MIMETYPE, EC_ATTACH_MIMETYPE_EXTENSION, EC_ATTACH_MIMETYPE_TYPE, EC_ATTACH_POUND, EC_ATTACH_QUESTION, EC_ATTACH_RefCommand, EC_ATTACH_ReName, EC_ATTACH_returnURL, EC_ATTACH_UPLOAD, EC_ATTACH_XML, EC_BAD_PARAM, EC_BASE_COMPONENT, EC_BC_ENDTIME, EC_BC_JOBNBR, EC_BC_STATE, EC_BILLTO, EC_BOOL_FALSE, EC_BOOL_TRUE, EC_BOUNDARY, EC_BUNDLE_BEAN, EC_BUSINESS_ENTITIES_NODE, EC_BYPASS_ACCESS_CHECK_FOR_OPEN_STORE, EC_CATALOG_ENTRY_ID, EC_CATALOG_ID, EC_CATALOG_IDENTIFIER, EC_CATALOG_MASSOC_TYPE_REPLACEMENT, EC_CATEGORIES, EC_CATEGORY_ID, EC_CATEGORY_IDENTIFIER, EC_CATEGORY_NAME, EC_CATEGORYDISPLAY_COMMAND, EC_CC_ACCOUNT, EC_CC_BRAND, EC_CC_NUMBER, EC_CC_TYPE, EC_CCV_CODE, EC_CCX_MONTH, EC_CCX_YEAR, EC_CD_MONTH, EC_CD_YEAR, EC_CFG_AUTHENTICATIONMODE, EC_CFG_CFG_FILE_PATH, EC_CFG_CMD_CHAIN_DEF_FILE, EC_CFG_CMD_EXEC_EVENT_FILE, EC_CFG_CMD_PASSWORD_PROT_RETRIES, EC_CFG_CMD_PASSWORD_PROTECTION, EC_CFG_COOKIE, EC_CFG_COOKIE_ACCEPTANCE, EC_CFG_COOKIE_DOMAIN, EC_CFG_COOKIE_ENCRYPT, EC_CFG_COOKIE_PATH, EC_CFG_COOKIE_PERSIST, EC_CFG_COOKIE_SSL_CHECK, EC_CFG_COOKIE_SSLAUTH, EC_CFG_COOKIE_TRACE, EC_CFG_ENABLE_HTTP_PARM_ENCRYPT, EC_CFG_ENABLE_HTTPS_PARM_ENCRYPT, EC_CFG_ENABLE_JSP_STORE_DIR_CACHE, EC_CFG_ENABLED, EC_CFG_FALSE, EC_CFG_IN_NON_SSL_PORT, EC_CFG_IN_SSL_PORT, EC_CFG_LOGIN_TIMEOUT, EC_CFG_MEMBER_DIR, EC_CFG_MEMBER_MEMBERROLES_FILE_BASE_NAME, EC_CFG_MEMBER_MEMBERROLES_FILE_EXT, EC_CFG_MEMBERROLESFILENAME, EC_CFG_MULTIPLE_STORE_WARS, EC_CFG_NAME, EC_CFG_NON_SSLPORT, EC_CFG_OUT_NON_SSL_PORT, EC_CFG_OUT_SSL_PORT, EC_CFG_PASSWORD_INVALIDATION, EC_CFG_POLICYMANAGER_CLASSNAME, EC_CFG_POLICYMANAGER_CREATEINSTANCE_METHOD, EC_CFG_REFERRER_COOKIE_AGE, EC_CFG_SECURITY_ENABLED, EC_CFG_SECURITY_REALM, EC_CFG_SECURITY_RUN_AS_PWD, EC_CFG_SECURITY_RUN_AS_UID, EC_CFG_SSL_ACCELERATOR_OPTION, EC_CFG_SSLPORT, EC_CFG_STOREWEBMODULENAME, EC_CFG_TERMINATE_ACTIVITY, EC_CFG_TRUE, EC_CFG_URLMAPPER, EC_CFG_URLREWRITE, EC_CFG_VALUE, EC_CFG_WAS_PERSIST, EC_CFG_WCS_PERSIST, EC_CFG_WEB_ATTR_CONTEXTPATH, EC_CFG_WEB_ATTR_FILESERVLETENABLED, EC_CFG_WEB_ATTR_NAME, EC_CFG_WEB_ATTR_URLMAPPINGPATH, EC_CFG_WEB_ATTR_WEBALIAS, EC_CFG_WEB_MODULE, EC_CFG_WEBMODULE, EC_CFG_WEBSERVER, EC_CFG_WEBSPHERE, EC_CFG_X_SITE_SCRIPT, EC_CFG_X509, EC_CHANNELSTOREID, EC_CHANNELSTOREORDERSTATUS, EC_CLEAR_FOR_USER, EC_CMDBEAN, EC_CMDREG_SUFFIX, EC_COLLAB_BASE_DN, EC_COLLAB_ENABLE, EC_COLLAB_LDAP_ADMIN, EC_COLLAB_LDAP_HOSTNAME, EC_COLLAB_LDAP_PASSWORD, EC_COLLAB_LDAP_PORT, EC_COLLAB_QP_COLLABADMIN_LOGON, EC_COLLAB_QP_COLLABADMIN_PASSWORD, EC_COLLAB_QP_DOMAIN, EC_COLLAB_QP_HOST, EC_COLLAB_QP_HTTP_PORT, EC_COLLAB_QP_HTTPS_PORT, EC_COLLAB_QP_LOCALE, EC_COLLAB_QP_QPADMIN_LOGON, EC_COLLAB_QP_QPADMIN_PASSWORD, EC_COLLAB_QP_SERVLET_URL_PATH, EC_COLLAB_QP_USE_SSL, EC_COLLAB_WEBSERVER_HOSTNAME, EC_COLON, EC_COMMAND_CHAIN_NAME, EC_COMMANDCONTEXT, EC_COMMENT, EC_COMPONENT, EC_COMPONENT_CLASS, EC_COMPONENT_ENABLE, EC_COMPONENT_HTTPWEBCONTROLLER, EC_COMPONENT_NAME, EC_COMPONENT_PROPERTY, EC_COMPONENTS, EC_CONF_MSLOGNAME, EC_CONF_MSLOGTYPE, EC_CONF_TRACE_MASK, EC_CONFIG, EC_CONFIG_FILE, EC_CONTENT_DISP, EC_CONTENT_TYPE, EC_CONTENTLENGTH, EC_CONTENTTYPE, EC_CONTEXT_PATH, EC_CONTRACT_CMD_GET_ELIGIBLE_TA_IDS, EC_CONTRACT_ID, EC_COOKIE_ERROR_VIEW, EC_COOKIE_ExternalReferrer, EC_CORRUPT_CONTENT_DISP, EC_CORRUPT_DATA_END, EC_CRLF, EC_CSRF_AUTH_TOKEN_NAME, EC_CSRF_ERROR_PAGE, EC_CT_XML_ATTR_ENABLE, EC_CT_XML_ATTR_EVENT_GENERATOR, EC_CT_XML_ATTR_INTERFACENAME, EC_CT_XML_ATTR_NAME, EC_CT_XML_ATTR_STOREID, EC_CT_XML_ATTR_TYPE, EC_CT_XML_ATTRVAL_ENTRY, EC_CT_XML_ATTRVAL_EXCEPTION, EC_CT_XML_ATTRVAL_EXECUTION, EC_CT_XML_ATTRVAL_EXIT, EC_CT_XML_ELE_COMMANDTRIGGERS, EC_CT_XML_ELE_TRIGGER, EC_CURRCONTRACTS_ID, EC_CURRENCY_ID, EC_CURRENCY_SYM, EC_DATABEAN, EC_DATABEAN_DEEPFETCH, EC_DATABEAN_MANAGER_MODE, EC_DATABEAN_MANAGER_MODE_DEFAULT, EC_DATABEAN_MANAGER_MODE_DO_EXCEPTION_HANDLING, EC_DATABEAN_MANAGER_MODE_SKIP_EXCEPTION_HANDLING, EC_DD_CACHE_EXC_CMDS, EC_DD_CACHE_INC_CMDS, EC_DD_CACHE_NON_IDEM_CMDS, EC_DD_COMMAND, EC_DD_EXCLUDE_COMMANDS, EC_DD_INCLUDE_COMMANDS, EC_DD_MONITORS_COMMANDS, EC_DD_NAME, EC_DD_NON_IDEM_COMMANDS, EC_DDKEY, EC_DECRYPTEDREQPROP, EC_DEFAULT_ATTRIBUTE_VAL_LANGUAGE, EC_DEFAULT_CRLF, EC_DEFAULT_INIT_TRANSACTION_TIMEOUT, EC_DEFAULT_NON_SSL_PORT, EC_DEFAULT_SSL_PORT, EC_DEFAULT_STORE_ALIAS, EC_DEFAULT_TRANSACTION_TIMEOUT, EC_DISPLAY_BEAN, EC_DOCPATHNAME, EC_DOT, EC_DUPLICATE_REQ_VIEW, EC_EAR_PROPERTIES, EC_EDP_AMOUNT_EDITABLE, EC_EDP_CURRENCYCODE, EC_EDP_FINALIZATION_AMOUNT, EC_EDP_INITIALAMOUNT, EC_EDP_ORDERID, EC_EDP_PAYMENT_DATA_EDITABLE, EC_EDP_PAYMTHDID, EC_EDP_PIAMOUNT, EC_EDP_PIID, EC_EDP_PILIST, EC_EDP_RELEASEID, EC_EDP_RESERVATION_AMOUNT, EC_EDP_TOTALAMOUNT, EC_ELGBCONTRACTS_ID, EC_EMPTY_STRING, EC_ENABLE_DOUBLE_CLICK_HANDLER, EC_ENCRYPTION_ACTIVEPROVIDER, EC_ENCRYPTION_ALTERNATEPROVIDER, EC_ENCRYPTION_DEFAULTPROVIDER, EC_ENCRYPTION_SESSIONPROVIDER, EC_END_STR, EC_ERROR_CODE, EC_ERROR_JSP_NAME, EC_ERROR_VIEWNAME, EC_ERRORCODE, EC_ERRORSTRING, EC_ESC_DOT, EC_EXC_CONTENT_TYPE_ERR, EC_EXC_MALFORM_LINE, EC_EXCEPTION, EC_EXCLUDE_STORE_DIR, EC_FEATURE_CAAS, EC_FEATURE_CMC, EC_FEATURE_CONTENTVERSION, EC_FEATURE_FOUNDATION, EC_FEATURE_LDAP, EC_FEATURE_LOCATION_SERVICES, EC_FEATURE_SOCCOM, EC_FEATURE_SOCIAL_BRIDGING, EC_FEATURE_SSO, EC_FEATURE_STERLING_INTEGRATION, EC_FEATURE_STORE_SEPARATION, EC_FEATURE_STOREENHANCEMENTS, EC_FEATURE_USER_EXITS, EC_FIELD1, EC_FIELD2, EC_FIELD3, EC_FILESIZE, EC_FOR_STORE_ID, EC_FOR_USER, EC_FOR_USER_ID, EC_FORCED_PASSWORD_CHANGE_PAGE, EC_FORM_DATA_STR, EC_FORWARD_SLASH, EC_FRAME_SUPPORTED, EC_GENERIC_APP_ERROR_VIEW, EC_GENERIC_APPLICATION_ERROR_PAGE, EC_GENERIC_CMD, EC_GENERIC_DIRECTVIEW, EC_GENERIC_ERROR_PAGE, EC_GENERIC_FORWARDVIEW, EC_GENERIC_HTTPS_REDIRECTVIEW, EC_GENERIC_LOGONFORM, EC_GENERIC_PVCTIMEOUTFORM, EC_GENERIC_REDIRECTVIEW, EC_GENERIC_SYS_ERROR_VIEW, EC_GENERIC_USER_ID, EC_GENERIC_USER_REFNUM, EC_GENERIC_USER_TIMESTAMP, EC_GENERIC_USER_TYPE, EC_HTTP_DEVFMT, EC_HTTP_DEVFMTID_BROWSER, EC_HTTP_DEVFMTNAME_BROWSER, EC_HTTP_DEVFMTNAME_PVC, EC_HTTP_DEVFMTS, EC_HTTP_DEVFMTTYPID_BROWSER, EC_HTTP_DEVFMTTYPID_PVC, EC_HTTP_DEVFMTTYPID_XML, EC_HTTP_HDR_CACHE_CONTROL, EC_HTTP_ReferrerHeader, EC_HTTP_VALUE_PRIVATE, EC_HTTPADAPTER, EC_HTTPADAPTERS, EC_HTTPWEBCONTROLLER, EC_IBM_ENETWORK_30, EC_IBM_ID_LOGOFF, EC_IILIST_ATTR_NAME, EC_IILIST_ATTR_VALUE, EC_IILIST_DISPLAYSEQ, EC_IILIST_FIELD1, EC_IILIST_FIELD2, EC_IILIST_FIELD3, EC_IILIST_ID, EC_IILIST_ID_NAME, EC_IILIST_MEMBER_ID, EC_IILIST_UOM, EC_IMERCHANT, EC_IN_IILIST_ID, EC_IN_IILIST_ID_NAME, EC_IN_IILIST_MEMBER_ID, EC_INIT_PARM_CONFIGFACTORY, EC_INIT_PARM_CONFIGFILE, EC_INIT_PARM_ENCODING, EC_INIT_PARM_INSTANCENAME, EC_INIT_PARM_ISRESTSERVLET, EC_INIT_PARM_ISSTORESERVLET, EC_INIT_PARM_SERVLETNAME, EC_INIT_TRANSACTION_TIMEOUT, EC_INPUT_PARAM, EC_INPUT_PARAMVALUES, EC_INPUT_STREAM, EC_INSTANCE_INSTALL_DIR, EC_INSTANCE_NAME, EC_INVALID_ACTIVITY_TOKEN_ERROR_VIEW, EC_INVALID_CONTENT_DISP, EC_INVALID_PARM, EC_IS_RESPONSE_NECESSARY, EC_IS_SCHEDULED_JOB, EC_ITEM_BEAN, EC_JDBC_JNDINAME, EC_JEE_ONLY_RESOURCE, EC_JSP_ADDR_ADD, EC_JSP_ADDR_UPDATE, EC_JSP_CHECK_INV_ERR, EC_JSP_COM_ERR, EC_JSP_LOGON_DSP, EC_JSP_ORD_DSP_COM, EC_JSP_ORD_DSP_PEN, EC_JSP_ORD_LST_COM, EC_JSP_ORD_LST_PEN, EC_JSP_ORD_OK, EC_JSP_PWD_ADMIN, EC_JSP_PWD_RESET, EC_JSP_PWD_UPDATE, EC_JSP_PWD_USER_AUTH, EC_JSP_REG_NEW, EC_JSP_REG_UPDATE, EC_JSP_SHIPTO_ASSOC, EC_JSP_SHIPTO_DSP, EC_JSP_SHIPTO_LST, EC_JSP_SHOPCART_DSP, EC_JSP_STORE_DIR, EC_KEEP_ALIVE_SESSION, EC_KEY_LOCATOR_FRAMEWORK_PARAMETER, EC_KLF_CONFIG_FILE_DEFAULT_LOCATION, EC_KLF_DEFAULT_CONFIG_FILE_RELATIVE_PATH, EC_KRYPTO, EC_LANGUAGE_ID, EC_LDAP_OP_ONE_WAY, EC_LDAP_OP_TWO_WAY, EC_LDAP_OP_UNAVAIL, EC_LINK_USER_TO_IBMID, EC_LOCAL_HOST, EC_LOGIN_DEFAULT_TIMEOUT_VALUE, EC_LOGIN_RETURN_URL, EC_LOGIN_TIMEOUT, EC_LOGIN_TIMEOUT_BUFFER, EC_LOGIN_TIMEOUT_ERROR_MSGCODE, EC_LOGIN_TIMEOUT_ERROR_VIEW, EC_LOGIN_TIMEOUT_VALUE, EC_LOGIN_TIMEOUT_WEB_ADMIN_VALUE, EC_LOGON_FAILED, EC_LOTUS_DOMINO_50, EC_MALLFOOT, EC_MALLHEAD, EC_MBRGRP_CUSTOMER, EC_MBRGRP_CUSTOMER_AGENT, EC_MBRGRP_SITE_ADMIN, EC_MBRGRP_STORE_ADMIN, EC_MBRGRPTYPE_ACCESS_GROUP, EC_MBRGRPTYPE_USER_GROUP, EC_MEMBER_ATTRIBUTES_NODE, EC_MEMBER_AUTHENTICATIONMODE, EC_MEMBER_ID, EC_MERCHANT_KEY, EC_MERCHANT_PRODUCT, EC_MERCHANTFOOT, EC_MERCHANTHEAD, EC_MERCHANTKEY, EC_MISS_SEP_BOUNDARY, EC_MM_CFG_CLASS, EC_MM_CFG_CONFIGURATION, EC_MM_CFG_ID, EC_MM_CFG_NAME, EC_MQWEBCONTROLLER, EC_MULTIPART_FORM, EC_NETSCAPE_DIR_40, EC_NO, EC_NO_LEAD_BOUNDARY, EC_NO_STOREID, EC_NODE_CHILDREN, EC_NODE_NAME, EC_NONENCRYPTED_PARAM_NAME, EC_NONENCRYPTED_PARAMETER, EC_NONENCRYPTED_PARAMETERS, EC_NONHTTPADAPTER, EC_NONHTTPADAPTERS, EC_NOT_ENABLED_VERSION, EC_NULLSTRING, EC_OCTET_STREAM_STR, EC_ORDBLK_X_TENSIBLE_CODE_CHECK, EC_ORDER_RN, EC_ORDER_STATE, EC_ORDERITEM_RN, EC_ORDERLISTSUMMARY, EC_ORDERSUMMARY, EC_ORDERTOTALS, EC_ORDPAYINFO_NAME_SUFFIX, EC_ORGS_ROLES_DEFAULT_ORGENTITY, EC_ORGS_ROLES_DEFAULT_REGISTRATION_TYPE, EC_ORGS_ROLES_NODE, EC_ORGS_ROLES_ORG_NODE, EC_ORGS_ROLES_PARENT_ORGENTITY, EC_ORIGINATING_COMMAND, EC_OUT_IILIST_DESC, EC_OUT_IILIST_ID, EC_OUT_IILIST_ID_NAME, EC_PACKAGE_BEAN, EC_PARENT_DIR, EC_PARORG_ID, EC_PASSWORD, EC_PASSWORD_EXPIRED_FLAG, EC_PASSWORD_PROTECTED_CMD, EC_PASSWORD_PROTECTED_CMDS, EC_PASSWORD_REREQUEST_CHECKRESULT, EC_PASSWORD_REREQUEST_ERRORVIEW, EC_PASSWORD_REREQUEST_FOR_CMD, EC_PASSWORD_REREQUEST_MSGCODE, EC_PASSWORD_REREQUEST_PASSWORD1, EC_PASSWORD_REREQUEST_PASSWORD2, EC_PASSWORD_REREQUEST_URL, EC_PASSWORD_REREQUEST_VIEW, EC_PAYINFO_ORDER_RN, EC_PAYINFO_URL, EC_PAYMTHDID, EC_PRC_CURRENCY, EC_PRC_FIELD1, EC_PRC_FIELD2, EC_PRC_MERCHANT_REF_NUM, EC_PRC_PRECEDENCE, EC_PRC_PRICE, EC_PRC_PRICE_REF_NUM, EC_PRC_PRODUCT_REF_NUM, EC_PRC_SHOPPER_GROUP_REF_NUM, EC_PRC_TIME_BEGIN, EC_PRC_TIME_END, EC_PRODUCT, EC_PRODUCT_BEAN, EC_PRODUCT_ID, EC_PRODUCT_SKU, EC_PRODUCT_XML, EC_PRODUCTID_XPATH, EC_PRODUCTS, EC_PRODUCTXML_AES_DB_XPATH, EC_PRODUCTXML_AES_FILE_XPATH, EC_PROHIB_CHAR_ENCODING_ATT, EC_PROHIB_CHAR_ENCODING_CMD, EC_PROHIB_CHARS_ENCODING, EC_PROHIB_CHARS_ENCODING_ERROR_PAGE, EC_PROHIBITED_ATTR, EC_PROHIBITED_ATTR_ERROR_PAGE, EC_PROHIBITED_ATTRIBUTES, EC_PROHIBITED_CHAR, EC_PROHIBITED_CHAR_ERROR_PAGE, EC_PROHIBITED_CHARS, EC_PROPERTIES, EC_PROPERTIES_DATABASE, EC_PROPERTIES_DB, EC_PROPERTIES_DBACTIVE, EC_PROPERTIES_DBACTIVE_VALUE, EC_PROPERTIES_DBMS_NAME, EC_PROPERTIES_INSTANCE, EC_PROTECTED_MULTIVALUED_PARAM_NAME, EC_PROTECTED_MULTIVALUED_PARAMETER, EC_PROTECTED_MULTIVALUED_PARAMETERS, EC_PROTECTED_PARAM_NAME, EC_PROTECTED_PARAM_VALUE, EC_PROTECTED_PARAMETER, EC_PROTECTED_PARAMETERS, EC_PROTECTED_VIEW, EC_PROTECTED_VIEW_NAME, EC_PROTECTED_VIEWS, EC_PVC_ADDRESS1, EC_PVC_ADDRESS2, EC_PVC_ADDRTYPE1, EC_PVC_ADDRTYPE2, EC_PVC_ALREADY_REGISTERED, EC_PVC_B_ERR, EC_PVC_B_EXEC, EC_PVC_B_NEW, EC_PVC_B_NO, EC_PVC_B_UPDATE, EC_PVC_B_URL, EC_PVC_BROWSER, EC_PVC_BUF_ACTION, EC_PVC_BUF_TIMEOUT, EC_PVC_LOGONSTATUS, EC_PVC_MULTIPLE_DEVICE, EC_PVC_REENTPW, EC_PVC_REENTPW_FORM, EC_PVC_SINGLE_DEVICE, EC_PVC_USER_ALREADY_REGISTERED, EC_PVCADAPTER, EC_PVCADAPTERS, EC_PVCMODE_ACCEPT, EC_PVCMODE_REENTER_PWD, EC_PVCMODE_REJECT, EC_QUANTITY, EC_QUERYSTRING_DELIM, EC_RAWDOCUMENT, EC_REDIRECT_LOGONVIEW, EC_REDIRECTURL, EC_REG_PARENTS_NODE, EC_REGISTRIES, EC_REGISTRY, EC_REGISTRY_CAPACITY, EC_REGISTRY_CLASS, EC_REGISTRY_DEFAULT_SIZE, EC_REGISTRY_ELEMENT_ADD, EC_REGISTRY_ELEMENT_DELETE, EC_REGISTRY_ELEMENT_UPDATE, EC_REGISTRY_LOAD_FACTOR, EC_REGISTRY_MAX_SIZE, EC_REGISTRY_NAME, EC_REQ_DEFAULT_NON_SSL_PORT, EC_REQ_DEFAULT_SSL_PORT, EC_REQ_HTTP, EC_REQ_HTTPS, EC_REQHDR_HOST, EC_REQUEST_ATTR_STATIC_ASSET_CONTEXT_ROOT, EC_REQUEST_ATTR_STATIC_CUSTOM_ASSET_CONTEXT_ROOT, EC_REQUEST_ATTR_STATIC_IBM_ASSET_ALIAS_ROOT, EC_REQUEST_ATTR_STATIC_IBM_ASSET_CONTEXT_ROOT, EC_REQUEST_URI, EC_REQUESTHANDLE, EC_REQUESTPROPERTIES, EC_RETRIABLE_CMD, EC_RF_ACTION, EC_RF_ITEM_KEY, EC_RF_KEY, EC_RF_REGISTRY_NAME, EC_SCHED_APPLICATION_TYPE, EC_SCHED_APPLICATIONNAME, EC_SCHED_APPLICATIONTYPE, EC_SCHED_APPTYPE_BROADCAST, EC_SCHED_APPTYPE_DEFAULT, EC_SCHED_ASYNC_COMMAND, EC_SCHED_ATTEMPTS, EC_SCHED_AUTOCLEAN, EC_SCHED_BROADCAST, EC_SCHED_BROADCASTEXPIRETIME, EC_SCHED_CHKCMD_ID, EC_SCHED_CLONEID, EC_SCHED_COMMAND, EC_SCHED_CYCLETIME, EC_SCHED_DEFAULT_DELAYTIME, EC_SCHED_DELAY, EC_SCHED_DESCRIPTION, EC_SCHED_END_TIME, EC_SCHED_HOST, EC_SCHED_HOSTNAME, EC_SCHED_INTERVAL, EC_SCHED_JOB_ACTIVE, EC_SCHED_JOB_DELETED, EC_SCHED_JOBINSTREFNUM, EC_SCHED_JOBREFNUM, EC_SCHED_MAXNUMOFTHREADS, EC_SCHED_NAME, EC_SCHED_ON, EC_SCHED_PARAMETERS, EC_SCHED_POLICY, EC_SCHED_POLICY_MAINTAIN_SEQUENCE, EC_SCHED_POLICY_NOT_MAINTAIN_SEQUENCE, EC_SCHED_POLICY_RUNMISSEDJOBS, EC_SCHED_POLICY_SKIPMISSEDJOBS, EC_SCHED_PRIORITY, EC_SCHED_RESULT_FAILED, EC_SCHED_RESULT_SUCCESS, EC_SCHED_START_TIME, EC_SCHED_STATE, EC_SCHED_STATE_COMPLETED, EC_SCHED_STATE_COMPLETED_FAILED, EC_SCHED_STATE_IDLE, EC_SCHED_STATE_IDLE_FAILED, EC_SCHED_STATE_RUNNING, EC_SCHED_STATE_RUNNING_FAILED, EC_SCHED_STATE_WAITING, EC_SCS_ENDTIME, EC_SCS_INSTREFNUM, EC_SCS_JOBNBR, EC_SCS_QUEUE, EC_SCS_STATE, EC_SECURITY_XML, EC_SERVER, EC_SERVER_AES_DB_XPATH, EC_SERVER_AES_FILE_XPATH, EC_SERVERPORT, EC_SERVLET_PATH, EC_SESSCONTRACTS_ID, EC_SESSION_ACCEPTVALUE, EC_SESSION_COOKIEACCEPT, EC_SESSION_ID, EC_SESSIONDATA_ID, EC_SHIPINFO_ACCOUNT_NUM, EC_SHIPINFO_CARRACCNTS, EC_SHIPINFO_INSTRUCTS, EC_SHIPMODE_RN, EC_SHOPPINGCART, EC_SITE_DEFAULT_LANGID, EC_SITE_ORGANIZATION, EC_SITE_PROFILE_STOREID, EC_SITE_STORE_GROUP, EC_SITE_SUPPORTED_LANGIDS, EC_SOLR, EC_SOLRSECURITYXML_AES_DB_XPATH, EC_SOLRSECURITYXML_AES_FILE_XPATH, EC_SPI_USER_REFNUM, EC_SQL_CURRENT_TIMESTAMP, EC_SS_STORE_CLOSE, EC_SS_STORE_LOCKED, EC_SS_STORE_OPEN, EC_SS_STORE_PENDING, EC_SSLCHECKCOOKIE_ID, EC_SSO_ACTIVITYTOKEN, EC_START_TIME, EC_START_TIME_NANOS, EC_STATUS, EC_STORE_DIR, EC_STORE_ENTITY_ID, EC_STORE_ID, EC_STOREREL_ACTIVE, EC_STOREREL_INACTIVE, EC_STR_EMPTY, EC_STRELTYP_BLOCKREASONCODE, EC_STRELTYP_BUSINESS_POLICY, EC_STRELTYP_CALCULATION, EC_STRELTYP_CALCULATION_CODE, EC_STRELTYP_CAMPAIGNS, EC_STRELTYP_CATALOG, EC_STRELTYP_CATALOG_FILTER, EC_STRELTYP_CHANNELSTORE, EC_STRELTYP_COMMAND, EC_STRELTYP_CONTENT, EC_STRELTYP_CONTRACT, EC_STRELTYP_CURRENCY_CONVERSION, EC_STRELTYP_CURRENCY_COUNTERVALUE, EC_STRELTYP_CURRENCY_FORMAT, EC_STRELTYP_CURRENCY_SUPPORTED, EC_STRELTYP_EVENT, EC_STRELTYP_HOSTED_STORE, EC_STRELTYP_INVENTORY, EC_STRELTYP_MEASUREMENT_FORMAT, EC_STRELTYP_PRICE, EC_STRELTYP_PROMOTIONS, EC_STRELTYP_REFERRAL, EC_STRELTYP_SEGMENTATION, EC_STRELTYP_SHIPPING_CALCULATION, EC_STRELTYP_SHIPPING_SHIPJURISDICTION, EC_STRELTYP_SHIPPING_SHIPMODE, EC_STRELTYP_STOREITEM, EC_STRELTYP_TAX, EC_STRELTYP_URL, EC_STRELTYP_VIEW, EC_STRING_XML, EC_TECHNOLOGY_JSP, EC_TECHNOLOGY_XML, EC_TERMINATE_REQ_VIEW, EC_TEXTDOC_ENCODING, EC_TEXTDOCUMENT, EC_TIMEDOUT_USER_ID, EC_TIMEDOUT_USER_URL, EC_TIMESTAMP_PATTERN, EC_TOOLKIT, EC_TOPCATEGORIESDISPLAY_COMMAND, EC_TRANSACTION_MODE, EC_TRANSACTION_MODE_DEFAULT, EC_TRANSACTION_MODE_IGNORE_NESTED_ROLLBACK, EC_TRANSACTION_MODE_PERFORM_NESTED_ROLLBACK, EC_TRANSACTION_TIMEOUT, EC_TWENTY_ONE, EC_UID, EC_UNITIALIZED_COMMAND, EC_UNKNOWN_STR, EC_UOM, EC_UPDATEABLE, EC_UPLOADED_FILE, EC_URL, EC_URL_PATH_SEPARATOR, EC_USE_HTTPS, EC_USE_STORE_DIR, EC_USER, EC_USER_ADMINISTRATOR, EC_USER_DIR, EC_USER_ORG_ROLE_CONTEXT_VALUE_EXPLICIT, EC_USER_ORG_ROLE_CONTEXT_VALUE_PARENT, EC_USER_ORG_ROLE_CONTEXT_VALUE_STORE, EC_USER_ORG_ROLES_DN, EC_USER_ORG_ROLES_LDAP_LOGON_QUALIFIER, EC_USER_ORG_ROLES_MEMBER_ANCESTOR, EC_USER_ORG_ROLES_QUALIFIER, EC_USER_ORG_ROLES_ROLE_CONTEXT, EC_USER_ORG_ROLES_ROLE_NAME, EC_USER_ORG_ROLES_ROLE_NODE, EC_USER_ORG_ROLES_SSO_LOGON_QUALIFIER, EC_USER_ORG_ROLES_STORE_ANCESTOR, EC_USER_REGISTERED, EC_USER_ROLES_DEFAULT_REGISTRATION_TYPE, EC_USER_ROLES_NODE, EC_USER_ROLES_USER_NODE, EC_USER_SITE_ADMINISTRATOR, EC_USERNAME, EC_VALID_VRMF_FORMAT, EC_VERSION, EC_VIEWCOMMANDCONTEXT, EC_VIEWNAME, EC_VIEWTASKNAME, EC_WASSESSION_CONTRACTIDS, EC_WASSESSION_CURRENCYID, EC_WASSESSION_EXPIRYTIME, EC_WASSESSION_LANGID, EC_WASSESSION_LOCALE, EC_WASSESSION_LOGONTIME, EC_WASSESSION_STOREID, EC_WASSESSION_USERID, EC_WC, EC_WC_HOME, EC_WCPARAM_MODE, EC_WCPARAM_MODE_DEFAULT, EC_WCPARAM_MODE_EXCLUDE_RESPONSEPROPERTIES, EC_WCPARAM_MODE_INCLUDE_RESPONSEPROPERTIES, EC_WCS_SESSION_EXPIRED, EC_WCS_SESSION_EXPIRY, EC_WCS_SESSION_INFO, EC_WCS_SESSION_LAST_USER, EC_WCS_SESSION_LOGON, EC_WCS_SESSION_RELOGON, EC_WCS_SESSION_RELOGONURL, EC_WCS_SESSION_STATUS, EC_WCSADMIN, EC_WEBAPP_ALWAYSUSESSL, EC_WEBAPP_BUSINESS_CHANNEL_ID, EC_WEBAPP_CONTEXT_SET_NAME, EC_WEBAPP_INIT_PARM_ADAPTERS, EC_WEBAPP_INIT_PARM_DEFAULT_DEVICE_TYPE, EC_WEBAPP_INIT_PARM_DEVICE_SPECIFIC_MODULE, EC_WEBAPP_INIT_PARM_DEVICE_SPECIFIC_VIEW, EC_WEBAPP_INIT_PARM_HANDLE_DOUBLE_CLICK, EC_WEBAPP_INIT_PARM_IN_NON_SSLPORT, EC_WEBAPP_INIT_PARM_IN_SSLPORT, EC_WEBAPP_INIT_PARM_NON_SSLPORT, EC_WEBAPP_INIT_PARM_OUT_NON_SSLPORT, EC_WEBAPP_INIT_PARM_OUT_SSLPORT, EC_WEBAPP_INIT_PARM_SSL_ACCELERATOR, EC_WEBAPP_INIT_PARM_SSLPORT, EC_WEBAPP_RECORDABLE, EC_WEBPATH, EC_WEBSERVER_HOSTNAME, EC_WHITELIST_PARAM, EC_WHITELIST_PROTECTION, EC_WILDCARD_CHAR, EC_WORKSPACE, EC_X_SITE_SCRIPTING, EC_X509_ERROR_VIEW, FTP_XML_FILEPATH, POST_UE, PRE_UE, REPLACE_UE, UPLOAD_NO_CMD_INDEX, WC_CONFIG_FILEPATH

Constructor Summary

Constructors

Constructor and Description
JSPHelper(javax.servlet.http.HttpServletRequest httpReq) This is the constructor for this class.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getParameter(javax.servlet.http.HttpServletRequest req, java.lang.String paramName) This method returns a parameter from the request object as String object.
java.lang.String	getParameter(java.lang.String paramName) This method returns a parameter from the request object as String object.
static java.lang.String[]	getParameterValues(javax.servlet.http.HttpServletRequest req, java.lang.String paramName) This method returns a parameter from the request object as an array of String objects.
java.lang.String[]	getParameterValues(java.lang.String paramName) This method returns a parameter from the request object as an array of String objects.
static java.util.PropertyResourceBundle	getPropertyResourceBundle(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request) This method returns the PropertyResourceBundle object for the given JSP in the runtime default locale.
static java.util.PropertyResourceBundle	getPropertyResourceBundle(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, java.util.Locale locale) This method returns the PropertyResourceBundle object for the given JSP in the given locale.
static java.util.PropertyResourceBundle	getPropertyResourceBundle(java.lang.String sfilename) This method returns the PropertyResourceBundle object for the given JSP in the runtime default locale.
static java.util.PropertyResourceBundle	getPropertyResourceBundle(java.lang.String sfilename, javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request) This method returns the PropertyResourceBundle object for the given JSP in the runtime default locale.
static java.util.PropertyResourceBundle	getPropertyResourceBundle(java.lang.String sfilename, javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, java.util.Locale locale) This method returns the PropertyResourceBundle object for the given JSP in the given locale.
static java.util.ResourceBundle	getResourceBundle(javax.servlet.http.HttpServletRequest request) This method returns the ResourceBundle object for the given JSP in the default runtime locale.
static java.util.ResourceBundle	getResourceBundle(javax.servlet.http.HttpServletRequest request, java.util.Locale locale) This method returns the ResourceBundle object for the given JSP in the given locale.
static java.util.ResourceBundle	getResourceBundle(java.lang.String sfilename, javax.servlet.http.HttpServletRequest request) This method returns the ResourceBundle object for the given JSP in the default runtime locale.
static java.util.ResourceBundle	getResourceBundle(java.lang.String sfilename, javax.servlet.http.HttpServletRequest request, java.util.Locale locale) This method returns the ResourceBundle object for the given JSP in the given locale.
static java.lang.String	htmlTextEncoder(java.lang.String iString) This method encodes a String for HTML.
static void	markTransactionToRollback() This method marks a transaction for rollback when an exception is caught in a JSP page.
static void	rollbackTransaction() This method rolls back the current transaction.
void	rollbackTransaction(boolean flag) This method rolls back the current transaction and also marks the current page to be not cachable.
static void	rollbackTransaction(javax.servlet.http.HttpServletRequest req, boolean flag) This method rolls back the current transaction and also marks the current page to be not cachable.
void	setCachePage(boolean flag) Deprecated. This method has been replaced by setUncacheable.
void	setUncacheable(boolean flag) This method sets a flag to indicate whether the output page is uncacheable.
static void	setUncacheable(CommandContext commandContext, boolean flag) This method sets a flag to indicate whether the output page is uncacheable.
static void	setUncacheable(javax.servlet.http.HttpServletRequest req, boolean flag) This method sets a flag to indicate whether the output page is uncacheable.

Methods inherited from class com.ibm.commerce.server.ServletHelper

arrayCopy, buildHttpsRedirectUrl, buildHttpsRedirectUrl, buildRedirectUrl, buildRedirectUrl, buildRedirectUrl, buildRedirectUrl, buildRedirectUrl, checkRedirectAllowed, composeEncodedQueryString, composeQueryString, decodeURL, encodeURL, extractEncodedRequestParameters, extractEncodedRequestParameters, extractMultipartParameters, extractRequestParameters, extractRequestParameters, findStoreUrlRegistryEntry, getActivePointerName, getConfigFileName, getNVPHash, getNVPHashArray, getRequestName, getSessionID, getStoreIdFromQueryString, getURLParameters, getUserRefNum, isSSLRequest, mergeRedirectUrlProperties, protectQueryString, servletRequestToString, servletRequestToStringDebug, setEncoding, setEncoding, setEncoding, stringToArray, stringToIntegerArray

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

JSPHelper

public JSPHelper(javax.servlet.http.HttpServletRequest httpReq)

This is the constructor for this class.

Parameters:

httpReq - An HttpServletRequest object.

Method Detail

getParameter

public java.lang.String getParameter(java.lang.String paramName)

This method returns a parameter from the request object as String object.

Parameters:

paramName - The name of the parameter.

Returns:

The value of the parameter.

getParameter

public static java.lang.String getParameter(javax.servlet.http.HttpServletRequest req,
                                            java.lang.String paramName)

This method returns a parameter from the request object as String object.

Parameters:

req - An HttpServletRequest object.

paramName - The name of the parameter.

Returns:

This method returns a java.lang.String that represents the value of the parameter.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String paramName)

This method returns a parameter from the request object as an array of String objects.

Parameters:

paramName - The name of the parameter.

Returns:

This method returns an array of java.lang.String objects that represent the values of the parameters.

getParameterValues

public static java.lang.String[] getParameterValues(javax.servlet.http.HttpServletRequest req,
                                                    java.lang.String paramName)

This method returns a parameter from the request object as an array of String objects.

Parameters:

req - An HttpServletRequest object.

paramName - The name of the parameter.

Returns:

This method returns an array of java.lang.String objects that represent the values of the parameters.

getPropertyResourceBundle

public static java.util.PropertyResourceBundle getPropertyResourceBundle(java.lang.String sfilename)
                                                                  throws java.io.IOException

This method returns the PropertyResourceBundle object for the given JSP in the runtime default locale.

Parameters:

sfilename - The JSP file name.

Returns:

The PropertyResourceBundle for the JSP page.

Throws:

java.io.IOException

getPropertyResourceBundle

public static java.util.PropertyResourceBundle getPropertyResourceBundle(java.lang.String sfilename,
                                                                         javax.servlet.ServletContext servletContext,
                                                                         javax.servlet.http.HttpServletRequest request)
                                                                  throws java.io.IOException

This method returns the PropertyResourceBundle object for the given JSP in the runtime default locale. It will pick up property files located relative to the location of the JSP.

Usage: java.util.ResourceBundle thisResources = com.ibm.commerce.server.JSPHelper.getPropertyResourceBundle("MyProperties", getServletContext(), request);

Parameters:

sfilename - The JSP file name.

servletContext - The servlet context.

request - An HttpServletRequest object.

Returns:

The PropertyResourceBundle for the JSP page.

Throws:

java.io.IOException

getPropertyResourceBundle

public static java.util.PropertyResourceBundle getPropertyResourceBundle(java.lang.String sfilename,
                                                                         javax.servlet.ServletContext servletContext,
                                                                         javax.servlet.http.HttpServletRequest request,
                                                                         java.util.Locale locale)
                                                                  throws java.io.IOException

This method returns the PropertyResourceBundle object for the given JSP in the given locale. It will pick up property files located relative to the location of the JSP.

Usage: java.util.ResourceBundle thisResources = com.ibm.commerce.server.JSPHelper.getPropertyResourceBundle("MyProperties", getServletContext(), request, locale);

Parameters:

sfilename - The JSP file name.

servletContext - The servlet context.

request - An HttpServletRequest object.

locale - The locale used for the resource bundle.

Returns:

The PropertyResourceBundle for the JSP page.

Throws:

java.io.IOException

getPropertyResourceBundle

public static java.util.PropertyResourceBundle getPropertyResourceBundle(javax.servlet.ServletContext servletContext,
                                                                         javax.servlet.http.HttpServletRequest request)
                                                                  throws java.io.IOException

This method returns the PropertyResourceBundle object for the given JSP in the runtime default locale. It will pick up property files located relative to the location of the JSP.

Usage: java.util.ResourceBundle thisResources = com.ibm.commerce.server.JSPHelper.getPropertyResourceBundle(getServletContext(), request);

Parameters:

servletContext - The servlet context.

request - An HttpServletRequest object.

Returns:

The PropertyResourceBundle for the JSP page.

Throws:

java.io.IOException

getPropertyResourceBundle

public static java.util.PropertyResourceBundle getPropertyResourceBundle(javax.servlet.ServletContext servletContext,
                                                                         javax.servlet.http.HttpServletRequest request,
                                                                         java.util.Locale locale)
                                                                  throws java.io.IOException

This method returns the PropertyResourceBundle object for the given JSP in the given locale. It will pick up property files located relative to the location of the JSP.

Usage: java.util.ResourceBundle thisResources = com.ibm.commerce.server.JSPHelper.getPropertyResourceBundle(getServletContext(), request, locale);

Parameters:

servletContext - The servlet context.

request - An HttpServletRequest object.

locale - The locale used for the resource bundle.

Returns:

The PropertyResourceBundle for the JSP page.

Throws:

java.io.IOException

getResourceBundle

public static java.util.ResourceBundle getResourceBundle(java.lang.String sfilename,
                                                         javax.servlet.http.HttpServletRequest request)

This method returns the ResourceBundle object for the given JSP in the default runtime locale. It will pick up property files located relative to the location of the JSP.

Parameters:

sfilename - The JSP file name.

request - An HttpServletRequest object.

Returns:

The ResourceBundle for the JSP page.

getResourceBundle

public static java.util.ResourceBundle getResourceBundle(java.lang.String sfilename,
                                                         javax.servlet.http.HttpServletRequest request,
                                                         java.util.Locale locale)

This method returns the ResourceBundle object for the given JSP in the given locale. It will pick up property files located relative to the location of the JSP.

Parameters:

sfilename - The JSP file name.

request - An HttpServletRequest object.

locale - The locale used for the resource bundle.

Returns:

The ResourceBundle for the JSP page.

getResourceBundle

public static java.util.ResourceBundle getResourceBundle(javax.servlet.http.HttpServletRequest request)

This method returns the ResourceBundle object for the given JSP in the default runtime locale.

Parameters:

request - An HttpServletRequest object.

Returns:

The ResourceBundle for the JSP page.

getResourceBundle

public static java.util.ResourceBundle getResourceBundle(javax.servlet.http.HttpServletRequest request,
                                                         java.util.Locale locale)

This method returns the ResourceBundle object for the given JSP in the given locale.

Parameters:

request - An HttpServletRequest object.

locale - The locale used for the resource bundle.

Returns:

The ResourceBundle for the JSP page.

htmlTextEncoder

public static java.lang.String htmlTextEncoder(java.lang.String iString)

This method encodes a String for HTML.

Parameters:

iString - the string to encode.

Returns:

The encoded string. An empty string is returned if the input is null.

markTransactionToRollback

public static void markTransactionToRollback()

This method marks a transaction for rollback when an exception is caught in a JSP page.

rollbackTransaction

public static void rollbackTransaction()

This method rolls back the current transaction. This method is to be called when an error is detected in a JSP and the command associated with this JSP has to rollback.

rollbackTransaction

public void rollbackTransaction(boolean flag)

This method rolls back the current transaction and also marks the current page to be not cachable. This method is to be called when an error is detected in a JSP and the command associated with this JSP has to rollback.

Parameters:

flag - A boolean value; true if the page is to be cached and false otherwise.

rollbackTransaction

public static void rollbackTransaction(javax.servlet.http.HttpServletRequest req,
                                       boolean flag)

This method rolls back the current transaction and also marks the current page to be not cachable. This method is to be called when an error is detected in a JSP and the command associated with this JSP has to rollback.

Parameters:

req - An HttpServletRequest object.

flag - A boolean value; true if the page is to be cached and false otherwise.

setCachePage

public void setCachePage(boolean flag)

Deprecated. This method has been replaced by setUncacheable.

This method sets cachePage flag.

Parameters:

flag - A boolean value; true if the page is to be cached and false otherwise.

setUncacheable

public static void setUncacheable(javax.servlet.http.HttpServletRequest req,
                                  boolean flag)

This method sets a flag to indicate whether the output page is uncacheable.

Parameters:

req - An HttpServletRequest object.

flag - A boolean value; true to disable caching the page and false otherwise.

setUncacheable

public static void setUncacheable(CommandContext commandContext,
                                  boolean flag)

This method sets a flag to indicate whether the output page is uncacheable.

Parameters:

commandContext - The command context.

flag - A boolean value; true to disable caching the page and false otherwise.

setUncacheable

public void setUncacheable(boolean flag)

This method sets a flag to indicate whether the output page is uncacheable.

Parameters:

flag - A boolean value; true to disable caching the page and false otherwise.