LiveHelpConfiguration

java.lang.Object
- com.ibm.commerce.beans.InputDataBeanImpl
- - com.ibm.commerce.beans.SmartDataBeanImpl
  - - com.ibm.commerce.collaboration.livehelp.beans.LiveHelpConfiguration

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, Delegator, Protectable, java.io.Serializable
```
public class LiveHelpConfiguration
extends SmartDataBeanImpl
implements Protectable, Delegator
```
Configuration databean for Customer Care

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.ibm.commerce.beans.SmartDataBeanImpl
  commandContext, viewCommandContext
- Fields inherited from class com.ibm.commerce.beans.InputDataBeanImpl
  requestProperties
- Fields inherited from interface com.ibm.commerce.beans.DataBean
  emptyString

Constructor Summary

Constructors
Constructor and Description
`LiveHelpConfiguration()` Constructs a LiveHelpConfiguration object.
`LiveHelpConfiguration(CommandContext aCommandContext)` Constructs a LiveHelpConfiguration object.

Method Summary

Methods
Modifier and Type	Method and Description
`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 problem characters for an HTML input attribute value.
`protected static void`	`exit(java.lang.String methodName)` Simplifies tracing method exit.
`static java.lang.String`	`getAppletCodeBaseURL()` Returns the Customer Care Applet `CodeBase` URL as it is defined in the WebSphere Commerce 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.
`protected static com.ibm.commerce.server.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" >.
`Protectable`	`getDelegate()` Gets Delegate.
`boolean`	`getEnabled()` Returns true if Customer Care is enabled as it is defined in the WebSphere Commerce configuration file.
`static java.lang.String`	`getHelpSessionLimit()` Returns Customer Care `HelpSessionLimit` as it is defined in the WebSphere Commerce configuration file.
`static java.lang.String`	`getHostName()` Returns `Sametime` `HostName` as it is defined in the WebSphere Commerce configuration file.
`static java.lang.String`	`getInitiationType()` Returns Customer Care `InitiationType` as it is defined in the WebSphere Commerce configuration file.
`static java.lang.String`	`getInstanceName()` Returns Customer Care Instance name in format as `"instance_name@hostname"`.
`static java.lang.String`	`getLdapType()` Returns Customer Care LDAP configuration as it is defined in the WebSphere Commerce 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.
`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 WebSphere Commerce 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 WebSphere Commerce configuration file.
`static java.lang.String`	`getSingleSignOnToken(javax.servlet.http.HttpServletRequest req)` Returns `SingleSignOn` `LTPA` token in cookie.
`static java.lang.String`	`getSingleSignOnType(javax.servlet.http.HttpServletRequest req)` Check if CSR applet uses `LTPA` token or not.
`static java.lang.String`	`getTopicElementString(java.lang.String TopicTitle, java.lang.String TopicText)` Gets Topic element string with format
`static java.lang.String`	`getTopicGroupElementString(java.lang.String GroupName)` Gets Topic Group element string with format
`static java.lang.String`	`getURLGroupElementString(java.lang.String GroupName)` Gets URL group element string with format
`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 WebSphere Commerce 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 com.ibm.commerce.beans.SmartDataBeanImpl
fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, populate, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl
getRequestProperties, setRequestProperties

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

Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills

Methods inherited from interface com.ibm.commerce.beans.InputDataBean
getRequestProperties, setRequestProperties

- Constructor Detail
  - LiveHelpConfiguration
```
public LiveHelpConfiguration()
```
    Constructs a LiveHelpConfiguration object.
  - LiveHelpConfiguration
```
public LiveHelpConfiguration(CommandContext aCommandContext)
```
    Constructs a LiveHelpConfiguration object.
    
    Parameters:
    
    CommandContext - CommandContext object.
- Method Detail
  - doubleQuoteString
```
public static java.lang.String doubleQuoteString(java.lang.String sString)
```
    Quotes a String with double quotes.
    
    Parameters:
    
    sString - String to quote.
    
    Returns:
    
    Double quoted string.
  - entry
```
protected static void entry(java.lang.String methodName)
```
    Simplifies tracing method entry.
    
    Parameters:
    
    methodName - Method name.
  - exit
```
protected static void exit(java.lang.String methodName)
```
    Simplifies tracing method exit.
    
    Parameters:
    
    methodName - Method name.
  - getAppletCodeBaseURL
```
public static java.lang.String getAppletCodeBaseURL()
```
    Returns the Customer Care Applet CodeBase URL as it is defined in the WebSphere Commerce configuration file.
    
    Returns:
    
    The LiveHelp Applet CodeBase URL.
  - getAuthentication
```
public java.lang.String getAuthentication(java.lang.String aUserId)
```
    Returns authentication string for a given user ID.
    
    Parameters:
    
    aUserId - The user ID.
    
    Returns:
    
    Authentication string.
  - getAuthentication
```
public java.lang.String getAuthentication(CommandContext aCommandContext)
```
    Returns authentication string for a given user ID in Command Context.
    
    Parameters:
    
    aCommandContext - CommandContext of the session.
    
    Returns:
    
    Authentication string, or null if any error occurred during authentication.
  - getCloseTagString
```
public static java.lang.String getCloseTagString(java.lang.String sTag)
```
    Format a Close Tag string.
    
    Parameters:
    
    sTag - - Tag name.
    
    Returns:
    
    Close tag string in </Tag> format.
  - getConfigProperties
```
protected static com.ibm.commerce.server.ConfigProperties getConfigProperties()
```
    Returns Configuration Properties from the instance.xml file.
    
    Returns:
    
    The configuration properties.
  - getCSRElementString
```
public 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" >.
    
    Parameters:
    
    CSRId - CSR ID.
    
    CSRName - Logon name of the CSR.
    
    Returns:
    
    CSR element string.
  - getDelegate
```
public Protectable getDelegate()
                        throws java.lang.Exception
```
    Gets Delegate.
    
    Specified by:
    
    getDelegate in interface Delegator
    
    Returns:
    
    Protectable object.
    
    Throws:
    
    java.lang.Exception - System error.
  - getHelpSessionLimit
```
public static java.lang.String getHelpSessionLimit()
```
    Returns Customer Care HelpSessionLimit as it is defined in the WebSphere Commerce configuration file.
    
    Returns:
    
    Customer Care HelpSessionLimit.
  - getHostName
```
public static java.lang.String getHostName()
```
    Returns Sametime HostName as it is defined in the WebSphere Commerce configuration file.
    
    Returns:
    
    Sametime HostName.
  - getInitiationType
```
public static java.lang.String getInitiationType()
```
    Returns Customer Care InitiationType as it is defined in the WebSphere Commerce configuration file.
    
    Returns:
    
    Initiation type.
  - getInstanceName
```
public static java.lang.String getInstanceName()
```
    Returns Customer Care Instance name in format as "instance_name@hostname".
    
    Returns:
    
    Customer Care Instance name.
  - getLdapType
```
public static java.lang.String getLdapType()
```
    Returns Customer Care LDAP configuration as it is defined in the WebSphere Commerce configuration file.
    
    Returns:
    
    Customer Care LDAP configuration.
  - getSingleSignOnType
```
public static java.lang.String getSingleSignOnType(javax.servlet.http.HttpServletRequest req)
```
    Check if CSR applet uses LTPA token or not.
    
    Parameters:
    
    req - Request object
    
    Returns:
    
    "1" when Sametime server is using the same LDAP server as member subsystem. SSO is enabled in member system and has a LTPA token in cookie. "0" when not all the above conditions are satisfied.
  - getSingleSignOnToken
```
public static java.lang.String getSingleSignOnToken(javax.servlet.http.HttpServletRequest req)
```
    Returns SingleSignOn LTPA token in cookie.
    
    Parameters:
    
    req - Request object.
    
    Returns:
    
    LTPA token in cookie or null.
  - getLogonId
```
public java.lang.String getLogonId(java.lang.String aUserId)
```
    Returns user logon Id for a given user ID.
    
    Parameters:
    
    aUserId - User ID.
    
    Returns:
    
    User logon ID.
  - getLogonId
```
public java.lang.String getLogonId(CommandContext aCommandContext)
```
    Returns user logon Id for a given user Id in Command Context.
    
    Parameters:
    
    aCommandContext - CommandContext of the session.
    
    Returns:
    
    User logon ID.
  - getMonitorAttributeElementString
```
public 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'>.
    
    Parameters:
    
    AttributeId - Attribute ID.
    
    AttributeLabel - Display key for the label.
    
    Returns:
    
    Attribute element string.
  - getMonitorCounterAttributeElementString
```
public 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'>.
    
    Parameters:
    
    AttributeId - ID of the attribute.
    
    AttributeLabel - Display key for the label.
    
    AttributeUnit - Counter unit, for non-counter attribute set it to null.
    
    Returns:
    
    Attribute element string.
  - getMonitorType
```
public static java.lang.String getMonitorType()
```
    Returns Customer Care MonitorType as it is defined in the WebSphere Commerce configuration file.
    
    Returns:
    
    Customer Care MonitorType.
  - getNVPString
```
public static java.lang.String getNVPString(java.lang.String sName,
                            java.lang.String sValue)
```
    Format a Name-Value pair string.
    
    Parameters:
    
    sName - Name string.
    
    sValue - Value string.
    
    Returns:
    
    Name-Value pair string in Name=Value format.
  - getOpenTagString
```
public static java.lang.String getOpenTagString(java.lang.String sTag)
```
    Returns an Open Tag string.
    
    Parameters:
    
    sTag - Tag name.
    
    Returns:
    
    Open tag string in <Tag> format.
  - getOwner
```
public java.lang.Long getOwner()
                        throws java.lang.Exception,
                               java.rmi.RemoteException
```
    Gets Owner.
    
    Specified by:
    
    getOwner in interface Protectable
    
    Returns:
    
    Owner ID.
    
    Throws:
    
    java.rmi.RemoteException - System error.
    
    java.lang.Exception - System error.
  - getQueueElementString
```
public 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" >.
    
    Parameters:
    
    QueueId - ID of the Queue.
    
    QueueName - Name of the Queue.
    
    QueueDesc - Description of the Queue.
    
    AllCSRs - Queue assignment information.
    
    Returns:
    
    Queue element string.
  - getRegistrationURL
```
public static java.lang.String getRegistrationURL()
```
    Returns Customer Care Registration URL as it is defined in the WebSphere Commerce configuration file.
    
    Returns:
    
    Customer Care Registration URL.
  - getTopicElementString
```
public static java.lang.String getTopicElementString(java.lang.String TopicTitle,
                                     java.lang.String TopicText)
```
    Gets Topic element string with format
```
 <QUESTION TITLE="xxxx" TEXT="xxxx" >.
 
```
    Parameters:
    
    TopicTitle - Title of the topic.
    
    TopicText - Text of the topic.
    
    Returns:
    
    Topic element string.
  - getTopicGroupElementString
```
public static java.lang.String getTopicGroupElementString(java.lang.String GroupName)
```
    Gets Topic Group element string with format
```
 <GROUP NAME="xxxx" >.
 
```
    Parameters:
    
    GroupName - Group name.
    
    Returns:
    
    Topic group element string.
  - getURLGroupElementString
```
public static java.lang.String getURLGroupElementString(java.lang.String GroupName)
```
    Gets URL group element string with format
```
 <GROUP NAME="xxxx" >.
 
```
    Parameters:
    
    GroupName - Group name.
    
    Returns:
    
    URL group element string.
  - getURLPageElementString
```
public 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" >.
    
    Parameters:
    
    PageName - Name of the page.
    
    PageURL - URL of the page.
    
    Returns:
    
    Page URL element string.
  - getUserRegistry
```
protected UserRegistryAccessBean getUserRegistry(java.lang.String userId)
                                          throws java.lang.Exception
```
    Gets the user registry access bean.
    
    Parameters:
    
    userId - User ID.
    
    Returns:
    
    UserRegistry AccessBean.
    
    Throws:
    
    java.lang.Exception - Thrown whenever an error occurs while looking up the user registry.
  - isEnabled
```
public static boolean isEnabled()
```
    Returns true if Customer Care is enabled as it is defined in the WebSphere Commerce configuration file.
    
    Returns:
    
    True if Customer Care is enabled.
  - getEnabled
```
public boolean getEnabled()
```
    Returns true if Customer Care is enabled as it is defined in the WebSphere Commerce configuration file.
    
    Returns:
    
    True if Customer Care is enabled.
  - trace
```
protected static void trace(java.lang.String methodName,
         java.lang.String text)
```
    Simplifies tracing text.
    
    Parameters:
    
    methodName - Method name.
    
    text - Trace text.
  - userExists
```
public boolean userExists(java.lang.String aUserId)
```
    Returns true if user is found, otherwise false.
    
    Parameters:
    
    aUserId - User ID.
    
    Returns:
    
    True if user is found.
  - escapeString
```
public static java.lang.String escapeString(java.lang.String result)
```
    Takes an input string and replaces problem characters for an HTML input attribute value.
    & replaced & " replaced &qout;
    
    Note: All HTML attribute values are assumed to be delimited by double quote.
    
    Parameters:
    
    result - The string to be converted.
    
    Returns:
    
    The converted string.

Class LiveHelpConfiguration

Field Summary

Fields inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

Fields inherited from class com.ibm.commerce.beans.InputDataBeanImpl

Fields inherited from interface com.ibm.commerce.beans.DataBean

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.security.Protectable

Methods inherited from interface com.ibm.commerce.beans.InputDataBean

Constructor Detail

LiveHelpConfiguration

LiveHelpConfiguration

Method Detail

doubleQuoteString

entry

exit

getAppletCodeBaseURL

getAuthentication

getAuthentication

getCloseTagString

getConfigProperties

getCSRElementString

getDelegate

getHelpSessionLimit

getHostName

getInitiationType

getInstanceName

getLdapType

getSingleSignOnType

getSingleSignOnToken

getLogonId

getLogonId

getMonitorAttributeElementString

getMonitorCounterAttributeElementString

getMonitorType

getNVPString

getOpenTagString

getOwner

getQueueElementString

getRegistrationURL

getTopicElementString

getTopicGroupElementString

getURLGroupElementString

getURLPageElementString

getUserRegistry

isEnabled

getEnabled

trace

userExists

escapeString