java.lang.Object | +--com.ibm.commerce.collaboration.livehelp.beans.LiveHelpConfiguration
Configuration databean for Customer Care
Field Summary | |
---|---|
static java.lang.String |
CLASSNAME Class name |
static java.lang.String |
COPYRIGHT IBM copyright info |
Constructor Summary | |
---|---|
LiveHelpConfiguration(
CommandContext aCommandContext) Constructs a LiveHelpConfiguration object. |
Method Summary | |
---|---|
static java.lang.String |
doubleQuoteString(java.lang.String sString) Quotes a String with double quotes |
protected
static void |
entry(java.lang.String methodName) Simplifies tracing method entry. |
static java.lang.String |
escapeString(java.lang.String result) Takes an input string and replaces the problem characters for an html input attribute value. |
protected
static void |
exit(java.lang.String methodName) Simplifies tracing method exit. |
boolean |
fulfills(java.lang.Long member,
java.lang.String relationship) Determines if a given member fulfills a given relationship with the resource. |
static java.lang.String |
getAppletCodeBaseURL() Returns the Customer Care Applet CodeBase URL as it is defined in the WCS configuration file. |
java.lang.String |
getAuthentication(
CommandContext aCommandContext) Returns authentication string for a given user Id in Command Context |
java.lang.String |
getAuthentication(java.lang.String aUserId) Returns authentication string for a given user Id |
static java.lang.String |
getCloseTagString(java.lang.String sTag) Format a Close Tag string |
CommandContext |
getCommandContext() Gets the CommandContext. |
protected
static
ConfigProperties |
getConfigProperties() Returns Configuration Properties from the instance.xml file |
static java.lang.String |
getCSRElementString(java.lang.String CSRId,
java.lang.String CSRName) Returns a CSR element string with format <CSR ID="xxxx" NAME="xxxx" > |
com.ibm.commerce.security.Protectable |
getDelegate() Gets Delegate |
static java.lang.String |
getHelpSessionLimit() Returns Customer Care HelpSessionLimit as it is defined in the WCS configuration file. |
static java.lang.String |
getHostName() Returns Sametime HostName as it is defined in the WCS configuration file. |
static java.lang.String |
getInitiationType() Returns Customer Care InitiationType as it is defined in the WCS configuration file. |
static java.lang.String |
getInstanceName() Returns Customer Care Instance name in format as "wcs_instance_name@hostname" |
static java.lang.String |
getLdapType() Returns Customer Care LDAP configuration as it is defined in the WCS configuration file. |
java.lang.String |
getLogonId(
CommandContext aCommandContext) Returns user logon Id for a given user Id in Command Context |
java.lang.String |
getLogonId(java.lang.String aUserId) Returns user logon Id for a given user Id |
protected
static java.lang.String |
getMerchantKey() Gets MerchantKey from the instance.xml file |
static java.lang.String |
getMonitorAttributeElementString(java.lang.String AttributeId,
java.lang.String AttributeLabel) Returns an Attribute element string with format <ATTR ID="xxxx" LABEL='xxxx'> |
static java.lang.String |
getMonitorCounterAttributeElementString(java.lang.String AttributeId,
java.lang.String AttributeLabel, java.lang.String AttributeUnit) Returns an Attribute element string with format <ATTR ID='xxxx' LABEL='xxxx' UNIT='xxxx'> |
static java.lang.String |
getMonitorType() Returns Customer Care MonitorType as it is defined in the WCS configuration file. |
static java.lang.String |
getNVPString(java.lang.String sName,
java.lang.String sValue) Format a Name-Value Pair String |
static java.lang.String |
getOpenTagString(java.lang.String sTag) Returns an Open Tag string |
java.lang.Long |
getOwner() Gets Owner |
static java.lang.String |
getQueueElementString(java.lang.String QueueId,
java.lang.String QueueName, java.lang.String QueueDesc,
java.lang.String AllCSRs) Gets a Queue element string with format <QUEUE ID="xxxx" NAME="xxxx" DESC="xxxx" ALLCSR="xxxx" > |
static java.lang.String |
getRegistrationURL() Returns Customer Care Registration URL as it is defined in the WCS configuration file. |
static java.lang.String |
getSingleSignOnToken(HttpServletRequest req) Returns SingleSignOn LTPA token in cookie. |
static java.lang.String |
getSingleSignOnType(HttpServletRequest req) Check if CSR applet should use LTPA token or not. |
static java.lang.String |
getTopicElementString(java.lang.String TopicTitle,
java.lang.String TopicText) Gets Topic element string with format <QUESTION TITLE="xxxx" TEXT="xxxx" > |
static java.lang.String |
getTopicGroupElementString(java.lang.String GroupName) Gets Topic Group element string with format <GROUP NAME="xxxx" > |
static java.lang.String |
getURLGroupElementString(java.lang.String GroupName) Gets URL group element string with format <GROUP NAME="xxxx" > |
static java.lang.String |
getURLPageElementString(java.lang.String PageName,
java.lang.String PageURL) Gets a Page URL element string with format <PAGE NAME="xxxx" URL="xxxx" > |
protected
UserRegistryAccessBean |
getUserRegistry(java.lang.String userId) Gets the user registry access bean |
static boolean |
isEnabled() Returns true if Customer Care is enabled as it is defined in the WCS configuration file. |
protected
static void |
trace(java.lang.String methodName, java.lang.String text) Simplifies tracing text. |
boolean |
userExists(java.lang.String aUserId) Returns true if user is found otherwise false |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
Constructor Detail |
---|
public LiveHelpConfiguration(CommandContext aCommandContext)
Method Detail |
---|
public static java.lang.String doubleQuoteString(java.lang.String sString)
sString
- String to quoteprotected static void entry(java.lang.String methodName)
methodName
- method Nameprotected static void exit(java.lang.String methodName)
methodName
- method Namepublic boolean fulfills(java.lang.Long member, java.lang.String relationship) throws java.rmi.RemoteException, java.lang.Exception
member
- Member id of the memberrelationship
- The relationship the member has with respect to
the resourcejava.lang.Exception
- System error.java.rmi.RemoteException
- System error.public static java.lang.String getAppletCodeBaseURL()
public java.lang.String getAuthentication(java.lang.String aUserId)
aUserId
- pass the userIdpublic java.lang.String getAuthentication(CommandContext aCommandContext)
aCommandContext
- CommandContext of the sessionnull
if any error occurred during
authentication.public static java.lang.String getCloseTagString(java.lang.String sTag)
sTag
- - Tag namepublic CommandContext getCommandContext()
protected static ConfigProperties getConfigProperties()
public static java.lang.String getCSRElementString(java.lang.String CSRId, java.lang.String CSRName)
CSRId
- CSR IdCSRName
- Logon name of the CSRpublic com.ibm.commerce.security.Protectable getDelegate() throws java.lang.Exception
java.lang.Exception
- System error.public static java.lang.String getHelpSessionLimit()
public static java.lang.String getHostName()
public static java.lang.String getInitiationType()
public static java.lang.String getInstanceName()
public static java.lang.String getLdapType()
public static java.lang.String getSingleSignOnType(HttpServletRequest req)
req
- Http request objectpublic static java.lang.String getSingleSignOnToken(HttpServletRequest req)
req
- HTTP requestpublic java.lang.String getLogonId(java.lang.String aUserId)
aUserId
- User Idpublic java.lang.String getLogonId(CommandContext aCommandContext)
aCommandContext
- CommandContext of the sessionprotected static java.lang.String getMerchantKey()
public static java.lang.String getMonitorAttributeElementString(java.lang.String AttributeId, java.lang.String AttributeLabel)
AttributeId
- Attribute IdAttributeLabel
- display key for the labelpublic static java.lang.String getMonitorCounterAttributeElementString(java.lang.String AttributeId, java.lang.String AttributeLabel, java.lang.String AttributeUnit)
AttributeId
- Id of the attributeAttributeLabel
- display key for the labelAttributeUnit
- counter unit, for non-counter attribute set it
to nullpublic static java.lang.String getMonitorType()
public static java.lang.String getNVPString(java.lang.String sName, java.lang.String sValue)
sName
- Name stringsValue
- Value stringpublic static java.lang.String getOpenTagString(java.lang.String sTag)
sTag
- Tag namepublic java.lang.Long getOwner() throws java.lang.Exception, java.rmi.RemoteException
java.rmi.RemoteException
- System error.java.lang.Exception
- System error.public static java.lang.String getQueueElementString(java.lang.String QueueId, java.lang.String QueueName, java.lang.String QueueDesc, java.lang.String AllCSRs)
QueueId
- Id of the QueueQueueName
- Name of the QueueQueueDesc
- Description of the QueueAllCSRs
- Queue assignment infopublic static java.lang.String getRegistrationURL()
public static java.lang.String getTopicElementString(java.lang.String TopicTitle, java.lang.String TopicText)
TopicTitle
- Title of the topicTopicText
- Text of the topicpublic static java.lang.String getTopicGroupElementString(java.lang.String GroupName)
GroupName
- Group namepublic static java.lang.String getURLGroupElementString(java.lang.String GroupName)
GroupName
- Group namepublic static java.lang.String getURLPageElementString(java.lang.String PageName, java.lang.String PageURL)
PageName
- Name of the pagePageURL
- URL of the pageprotected UserRegistryAccessBean getUserRegistry(java.lang.String userId) throws java.lang.Exception
userId
- user Idjava.lang.Exception
- Thrown whenever an error occurs while
looking up the user registry.public static boolean isEnabled()
protected static void trace(java.lang.String methodName, java.lang.String text)
methodName
- method Nametext
- trace textpublic boolean userExists(java.lang.String aUserId)
aUserId
- pass the userIdpublic static java.lang.String escapeString(java.lang.String result)
& replaced &
" replaced
&qout;
Note: All html attribute values are assumed to be delimited by double quote.
result
- the string to be converted.