com.ibm.commerce.collaboration.livehelp.beans
Class LiveHelpConfiguration

java.lang.Object
  |
  +--com.ibm.commerce.collaboration.livehelp.beans.LiveHelpConfiguration
All Implemented Interfaces:
Delegator, Protectable

public class LiveHelpConfiguration
extends java.lang.Object
implements Protectable, Delegator

Configuration data for LiveHelp.


Field Summary
static java.lang.String CLASSNAME
           
static java.lang.String COPYRIGHT
           
 
Constructor Summary
LiveHelpConfiguration(CommandContext aCommandContext)
          Constructs a LiveHelpConfiguration object.
 
Method Summary
protected static void entry(java.lang.String methodName)
          Simplifies tracing method entry.
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()
          Return the LiveHelp Applet CodeBase URL as it is defined in the WCS configuration file.
 java.lang.String getAuthentication(CommandContext aCommandContext)
          Return authentication string for a given user Id in Command Context
 java.lang.String getAuthentication(java.lang.String aUserId)
          Return authentication string for a given user Id
 CommandContext getCommandContext()
          Gets the CommandContext.
protected static ConfigProperties getConfigProperties()
          gets Configuration Properties from the instance.xml file
 Protectable getDelegate()
          gets Delegate
static java.lang.String getHelpSessionLimit()
          Return the LiveHelp HelpSessionLimit as it is defined in the WCS configuration file.
static java.lang.String getHostName()
          Return the LiveHelp HostName as it is defined in the WCS configuration file.
static java.lang.String getInitiationType()
          Return the LiveHelp InitiationType as it is defined in the WCS configuration file.
 java.lang.String getLogonId(CommandContext aCommandContext)
          Return user logon Id for a given user Id in Command Context
 java.lang.String getLogonId(java.lang.String aUserId)
          Return 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 getMonitorType()
          Return the LiveHelp MonitorType as it is defined in the WCS configuration file.
 java.lang.Long getOwner()
          gets Owner
static java.lang.String getRegistrationURL()
          Return the LiveHelp Registration URL as it is defined in the WCS configuration file.
protected  UserRegistryAccessBean getUserRegistry(java.lang.String userId)
           
static boolean isEnabled()
          Returns true if Collaboration LiveHelp 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)
          Reture 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

CLASSNAME

public static final java.lang.String CLASSNAME

COPYRIGHT

public static final java.lang.String COPYRIGHT
Constructor Detail

LiveHelpConfiguration

public LiveHelpConfiguration(CommandContext aCommandContext)
Constructs a LiveHelpConfiguration object.
Parameters:
CommandContext -  
Method Detail

entry

protected static void entry(java.lang.String methodName)
Simplifies tracing method entry.

exit

protected static void exit(java.lang.String methodName)
Simplifies tracing method exit.

fulfills

public boolean fulfills(java.lang.Long member,
                        java.lang.String relationship)
                 throws java.rmi.RemoteException,
                        java.lang.Exception
Determines if a given member fulfills a given relationship with the resource.
Specified by:
fulfills in interface Protectable
Parameters:
member - Member id of the member
relationship - The relationship the member has with respect to the resource
Returns:
true if the member fulfills the relationship with the resource

getAppletCodeBaseURL

public static java.lang.String getAppletCodeBaseURL()
Return the LiveHelp Applet CodeBase URL as it is defined in the WCS configuration file.
Returns:
the LiveHelp Applet CodeBase URL.

getAuthentication

public java.lang.String getAuthentication(CommandContext aCommandContext)
Return authentication string for a given user Id in Command Context
Returns:
authentication string, or null if any error occurred during authentication.

getAuthentication

public java.lang.String getAuthentication(java.lang.String aUserId)
Return authentication string for a given user Id
Parameters:
aUserId - pass the userId
Returns:
authentication string

getCommandContext

public CommandContext getCommandContext()
Gets the CommandContext.
Returns:
commandContext

getConfigProperties

protected static ConfigProperties getConfigProperties()
gets Configuration Properties from the instance.xml file
Returns:
the configuration properties

getDelegate

public Protectable getDelegate()
                        throws java.lang.Exception
gets Delegate
Specified by:
getDelegate in interface Delegator
Following copied from interface: com.ibm.commerce.security.Delegator
Returns:
The Protectable object whose access control policies will indirectly control the access control for this object

getHelpSessionLimit

public static java.lang.String getHelpSessionLimit()
Return the LiveHelp HelpSessionLimit as it is defined in the WCS configuration file.
Returns:
the LiveHelp HelpSessionLimit.

getHostName

public static java.lang.String getHostName()
Return the LiveHelp HostName as it is defined in the WCS configuration file.
Returns:
the LiveHelp HostName.

getInitiationType

public static java.lang.String getInitiationType()
Return the LiveHelp InitiationType as it is defined in the WCS configuration file.
Returns:
the LiveHelp InitiationType.

getLogonId

public java.lang.String getLogonId(CommandContext aCommandContext)
Return user logon Id for a given user Id in Command Context
Returns:
user logon Id

getLogonId

public java.lang.String getLogonId(java.lang.String aUserId)
Return user logon Id for a given user Id
Returns:
user logon Id

getMerchantKey

protected static java.lang.String getMerchantKey()
gets MerchantKey from the instance.xml file
Returns:
the merchant key string

getMonitorType

public static java.lang.String getMonitorType()
Return the LiveHelp MonitorType as it is defined in the WCS configuration file.
Returns:
the LiveHelp MonitorType.

getOwner

public java.lang.Long getOwner()
                        throws java.lang.Exception,
                               java.rmi.RemoteException
gets Owner
Specified by:
getOwner in interface Protectable
Following copied from interface: com.ibm.commerce.security.Protectable
Returns:
The member id of the owner

getRegistrationURL

public static java.lang.String getRegistrationURL()
Return the LiveHelp Registration URL as it is defined in the WCS configuration file.
Returns:
the LiveHelp Registration URL.

getUserRegistry

protected UserRegistryAccessBean getUserRegistry(java.lang.String userId)
                                          throws java.lang.Exception
Throws:
java.lang.Exception - Thrown whenever an error occurs while looking up the user registry.

isEnabled

public static boolean isEnabled()
Returns true if Collaboration LiveHelp is enabled as it is defined in the WCS configuration file.
Returns:
True is Collaboration LiveHelp is enabled.

trace

protected static void trace(java.lang.String methodName,
                            java.lang.String text)
Simplifies tracing text.

userExists

public boolean userExists(java.lang.String aUserId)
Reture true if user is found otherwise false
Parameters:
aUserId - pass the userId
Returns:
boolean